Class: Google::Apis::PeopleV1::ContactGroup

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/people_v1/classes.rb,
generated/google/apis/people_v1/representations.rb,
generated/google/apis/people_v1/representations.rb

Overview

A contact group.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ContactGroup

Returns a new instance of ContactGroup.



379
380
381
 
# File 'generated/google/apis/people_v1/classes.rb', line 379

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#etag ⇒ String

The HTTP entity tag of the resource. Used for web cache validation. Corresponds to the JSON property etag

Returns:

  • (String) 


334
335
336
 
# File 'generated/google/apis/people_v1/classes.rb', line 334

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

Returns:

  • (String) 


341
342
343
 
# File 'generated/google/apis/people_v1/classes.rb', line 341

def formatted_name
  @formatted_name
end

#group_type ⇒ String

Output only. The contact group type. Corresponds to the JSON property groupType

Returns:

  • (String) 


346
347
348
 
# File 'generated/google/apis/people_v1/classes.rb', line 346

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

Returns:

  • (Fixnum) 


352
353
354
 
# File 'generated/google/apis/people_v1/classes.rb', line 352

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 not populated for LIST requests and can only be updated through the ModifyContactGroupMembers. Corresponds to the JSON property memberResourceNames

Returns:

  • (Array<String>) 


360
361
362
 
# File 'generated/google/apis/people_v1/classes.rb', line 360

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

Returns:



365
366
367
 
# File 'generated/google/apis/people_v1/classes.rb', line 365

def metadata
  @metadata
end

#name ⇒ String

The contact group name set by the group owner or a system provided name for system groups. Corresponds to the JSON property name

Returns:

  • (String) 


371
372
373
 
# File 'generated/google/apis/people_v1/classes.rb', line 371

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 propertyresourceName`

Returns:

  • (String) 


377
378
379
 
# File 'generated/google/apis/people_v1/classes.rb', line 377

def resource_name
  @resource_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



384
385
386
387
388
389
390
391
392
393
 
# File 'generated/google/apis/people_v1/classes.rb', line 384

def update!(**args)
  @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