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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ContactGroup

Returns a new instance of ContactGroup



491
492
493
 
# File 'generated/google/apis/people_v1/classes.rb', line 491

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) 


452
453
454
 
# File 'generated/google/apis/people_v1/classes.rb', line 452

def etag
  @etag
end

#formatted_name ⇒ String

The read-only 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) 


464
465
466
 
# File 'generated/google/apis/people_v1/classes.rb', line 464

def formatted_name
  @formatted_name
end

#group_type ⇒ String

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

Returns:

  • (String) 


457
458
459
 
# File 'generated/google/apis/people_v1/classes.rb', line 457

def group_type
  @group_type
end

#member_count ⇒ Fixnum

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) 


489
490
491
 
# File 'generated/google/apis/people_v1/classes.rb', line 489

def member_count
  @member_count
end

#member_resource_names ⇒ Array<String>

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>) 


472
473
474
 
# File 'generated/google/apis/people_v1/classes.rb', line 472

def member_resource_names
  @member_resource_names
end

#metadata ⇒ Google::Apis::PeopleV1::ContactGroupMetadata

The read-only metadata about a contact group. Corresponds to the JSON property metadata

Returns:



483
484
485
 
# File 'generated/google/apis/people_v1/classes.rb', line 483

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) 


478
479
480
 
# File 'generated/google/apis/people_v1/classes.rb', line 478

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

Returns:

  • (String) 


446
447
448
 
# File 'generated/google/apis/people_v1/classes.rb', line 446

def resource_name
  @resource_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



496
497
498
499
500
501
502
503
504
505
 
# File 'generated/google/apis/people_v1/classes.rb', line 496

def update!(**args)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @etag = args[:etag] if args.key?(:etag)
  @group_type = args[:group_type] if args.key?(:group_type)
  @formatted_name = args[:formatted_name] if args.key?(:formatted_name)
  @member_resource_names = args[:member_resource_names] if args.key?(:member_resource_names)
  @name = args[:name] if args.key?(:name)
  @metadata = args[:metadata] if args.key?(:metadata)
  @member_count = args[:member_count] if args.key?(:member_count)
end