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

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ContactGroup

Returns a new instance of ContactGroup.



543
544
545
 
# File 'lib/google/apis/people_v1/classes.rb', line 543

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

Returns:



490
491
492
 
# File 'lib/google/apis/people_v1/classes.rb', line 490

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

Returns:

  • (String) 


496
497
498
 
# File 'lib/google/apis/people_v1/classes.rb', line 496

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) 


503
504
505
 
# File 'lib/google/apis/people_v1/classes.rb', line 503

def formatted_name
  @formatted_name
end

#group_type ⇒ String

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

Returns:

  • (String) 


508
509
510
 
# File 'lib/google/apis/people_v1/classes.rb', line 508

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) 


514
515
516
 
# File 'lib/google/apis/people_v1/classes.rb', line 514

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

Returns:

  • (Array<String>) 


521
522
523
 
# File 'lib/google/apis/people_v1/classes.rb', line 521

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:



526
527
528
 
# File 'lib/google/apis/people_v1/classes.rb', line 526

def metadata
  @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

Returns:

  • (String) 


535
536
537
 
# File 'lib/google/apis/people_v1/classes.rb', line 535

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) 


541
542
543
 
# File 'lib/google/apis/people_v1/classes.rb', line 541

def resource_name
  @resource_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/google/apis/people_v1/classes.rb', line 548

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