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.



314
315
316
# File 'generated/google/apis/people_v1/classes.rb', line 314

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

Instance Attribute Details

#etagString

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

Returns:

  • (String)


267
268
269
# File 'generated/google/apis/people_v1/classes.rb', line 267

def etag
  @etag
end

#formatted_nameString

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)


274
275
276
# File 'generated/google/apis/people_v1/classes.rb', line 274

def formatted_name
  @formatted_name
end

#group_typeString

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

Returns:

  • (String)


279
280
281
# File 'generated/google/apis/people_v1/classes.rb', line 279

def group_type
  @group_type
end

#member_countFixnum

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)


286
287
288
# File 'generated/google/apis/people_v1/classes.rb', line 286

def member_count
  @member_count
end

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


295
296
297
# File 'generated/google/apis/people_v1/classes.rb', line 295

def member_resource_names
  @member_resource_names
end

#metadataGoogle::Apis::PeopleV1::ContactGroupMetadata

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



300
301
302
# File 'generated/google/apis/people_v1/classes.rb', line 300

def 
  @metadata
end

#nameString

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)


306
307
308
# File 'generated/google/apis/people_v1/classes.rb', line 306

def name
  @name
end

#resource_nameString

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)


312
313
314
# File 'generated/google/apis/people_v1/classes.rb', line 312

def resource_name
  @resource_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



319
320
321
322
323
324
325
326
327
328
# File 'generated/google/apis/people_v1/classes.rb', line 319

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