Class: Google::Apis::PeopleV1::ContactGroup
- Inherits:
-
Object
- Object
- Google::Apis::PeopleV1::ContactGroup
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/people_v1/classes.rb,
lib/google/apis/people_v1/representations.rb,
lib/google/apis/people_v1/representations.rb
Overview
A contact group.
Instance Attribute Summary collapse
-
#client_data ⇒ Array<Google::Apis::PeopleV1::GroupClientData>
The group's client data.
-
#etag ⇒ String
The HTTP entity tag of the resource.
-
#formatted_name ⇒ String
Output only.
-
#group_type ⇒ String
Output only.
-
#member_count ⇒ Fixnum
Output only.
-
#member_resource_names ⇒ Array<String>
Output only.
-
#metadata ⇒ Google::Apis::PeopleV1::ContactGroupMetadata
The metadata about a contact group.
-
#name ⇒ String
The contact group name set by the group owner or a system provided name for system groups.
-
#resource_name ⇒ String
The resource name for the contact group, assigned by the server.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ContactGroup
constructor
A new instance of ContactGroup.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ ContactGroup
Returns a new instance of ContactGroup.
545 546 547 |
# File 'lib/google/apis/people_v1/classes.rb', line 545 def initialize(**args) update!(**args) end |
Instance Attribute Details
#client_data ⇒ Array<Google::Apis::PeopleV1::GroupClientData>
The group's client data.
Corresponds to the JSON property clientData
492 493 494 |
# File 'lib/google/apis/people_v1/classes.rb', line 492 def client_data @client_data end |
#etag ⇒ String
The HTTP entity tag of the resource.
Used for web cache validation.
Corresponds to the JSON property etag
498 499 500 |
# File 'lib/google/apis/people_v1/classes.rb', line 498 def etag @etag end |
#formatted_name ⇒ String
Output only. The name translated and formatted in the viewer's account locale
or the Accept-Language
HTTP header locale for system groups names. Group
names set by the owner are the same as name.
Corresponds to the JSON property formattedName
505 506 507 |
# File 'lib/google/apis/people_v1/classes.rb', line 505 def formatted_name @formatted_name end |
#group_type ⇒ String
Output only. The contact group type.
Corresponds to the JSON property groupType
510 511 512 |
# File 'lib/google/apis/people_v1/classes.rb', line 510 def group_type @group_type end |
#member_count ⇒ Fixnum
Output only. The total number of contacts in the group irrespective of max
members in specified in the request.
Corresponds to the JSON property memberCount
516 517 518 |
# File 'lib/google/apis/people_v1/classes.rb', line 516 def member_count @member_count end |
#member_resource_names ⇒ Array<String>
Output only. The list of contact person resource names that are members of the
contact group. The field is only populated for GET requests and will only
return as many members as maxMembers
in the get request.
Corresponds to the JSON property memberResourceNames
523 524 525 |
# File 'lib/google/apis/people_v1/classes.rb', line 523 def member_resource_names @member_resource_names end |
#metadata ⇒ Google::Apis::PeopleV1::ContactGroupMetadata
The metadata about a contact group.
Corresponds to the JSON property metadata
528 529 530 |
# File 'lib/google/apis/people_v1/classes.rb', line 528 def @metadata end |
#name ⇒ String
The contact group name set by the group owner or a system provided name for
system groups. For contactGroups.create
or contactGroups.update
the name must be unique to the users contact groups. Attempting to create a
group with a duplicate name will return a HTTP 409 error.
Corresponds to the JSON property name
537 538 539 |
# File 'lib/google/apis/people_v1/classes.rb', line 537 def name @name end |
#resource_name ⇒ String
The resource name for the contact group, assigned by the server. An ASCII
string, in the form of contactGroups/
contact_group_id`.
Corresponds to the JSON property
resourceName`
543 544 545 |
# File 'lib/google/apis/people_v1/classes.rb', line 543 def resource_name @resource_name end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
550 551 552 553 554 555 556 557 558 559 560 |
# File 'lib/google/apis/people_v1/classes.rb', line 550 def update!(**args) @client_data = args[:client_data] if args.key?(:client_data) @etag = args[:etag] if args.key?(:etag) @formatted_name = args[:formatted_name] if args.key?(:formatted_name) @group_type = args[:group_type] if args.key?(:group_type) @member_count = args[:member_count] if args.key?(:member_count) @member_resource_names = args[:member_resource_names] if args.key?(:member_resource_names) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) @resource_name = args[:resource_name] if args.key?(:resource_name) end |