Class: Google::Apis::PeopleV1::BatchCreateContactsRequest
- Inherits:
-
Object
- Object
- Google::Apis::PeopleV1::BatchCreateContactsRequest
- 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 create a batch of contacts.
Instance Attribute Summary collapse
-
#contacts ⇒ Array<Google::Apis::PeopleV1::ContactToCreate>
Required.
-
#read_mask ⇒ String
Required.
-
#sources ⇒ Array<String>
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ BatchCreateContactsRequest
constructor
A new instance of BatchCreateContactsRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ BatchCreateContactsRequest
Returns a new instance of BatchCreateContactsRequest.
168 169 170 |
# File 'lib/google/apis/people_v1/classes.rb', line 168 def initialize(**args) update!(**args) end |
Instance Attribute Details
#contacts ⇒ Array<Google::Apis::PeopleV1::ContactToCreate>
Required. The contact to create. Allows up to 200 contacts in a single request.
Corresponds to the JSON property contacts
147 148 149 |
# File 'lib/google/apis/people_v1/classes.rb', line 147 def contacts @contacts end |
#read_mask ⇒ String
Required. A field mask to restrict which fields on each person are returned in
the response. 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
160 161 162 |
# File 'lib/google/apis/people_v1/classes.rb', line 160 def read_mask @read_mask end |
#sources ⇒ Array<String>
Optional. A mask of what source types to return in the post mutate read.
Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
Corresponds to the JSON property sources
166 167 168 |
# File 'lib/google/apis/people_v1/classes.rb', line 166 def sources @sources end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
173 174 175 176 177 |
# File 'lib/google/apis/people_v1/classes.rb', line 173 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) end |