Class: Google::Apis::PeopleV1::BatchUpdateContactsRequest

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 request to update a batch of contacts.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BatchUpdateContactsRequest

Returns a new instance of BatchUpdateContactsRequest.



281
282
283
 
# File 'lib/google/apis/people_v1/classes.rb', line 281

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

Instance Attribute Details

#contacts ⇒ Hash<String,Google::Apis::PeopleV1::Person>

Required. A map of resource names to the person data to be updated. Allows up to 200 contacts in a single request. Corresponds to the JSON property contacts

Returns:



248
249
250
 
# File 'lib/google/apis/people_v1/classes.rb', line 248

def contacts
  @contacts
end

#read_mask ⇒ String

Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined Corresponds to the JSON property readMask

Returns:

  • (String) 


261
262
263
 
# File 'lib/google/apis/people_v1/classes.rb', line 261

def read_mask
  @read_mask
end

#sources ⇒ Array<String>

Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. Corresponds to the JSON property sources

Returns:

  • (Array<String>) 


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

def sources
  @sources
end

#update_mask ⇒ String

Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All specified fields will be replaced, or cleared if left empty for each person. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined Corresponds to the JSON property updateMask

Returns:

  • (String) 


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

def update_mask
  @update_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



286
287
288
289
290
291
 
# File 'lib/google/apis/people_v1/classes.rb', line 286

def update!(**args)
  @contacts = args[:contacts] if args.key?(:contacts)
  @read_mask = args[:read_mask] if args.key?(:read_mask)
  @sources = args[:sources] if args.key?(:sources)
  @update_mask = args[:update_mask] if args.key?(:update_mask)
end