Class: Google::Apis::EssentialcontactsV1::EssentialcontactsService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/essentialcontacts_v1/service.rb

Overview

Essential Contacts API

Examples:

require 'google/apis/essentialcontacts_v1'

Essentialcontacts = Google::Apis::EssentialcontactsV1 # Alias the module
service = Essentialcontacts::EssentialcontactsService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://essentialcontacts.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ EssentialcontactsService 



47
48
49
50
51
52
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-essentialcontacts_v1',
        client_version: Google::Apis::EssentialcontactsV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String 



40
41
42
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String 



45
46
47
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#compute_folder_contact(parent, notification_categories: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ComputeContactsResponse

Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 90

def compute_folder_contact(parent, notification_categories: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/contacts:compute', options)
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ComputeContactsResponse::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ComputeContactsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['notificationCategories'] = notification_categories unless notification_categories.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#compute_organization_contact(parent, notification_categories: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ComputeContactsResponse

Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 356

def compute_organization_contact(parent, notification_categories: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/contacts:compute', options)
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ComputeContactsResponse::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ComputeContactsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['notificationCategories'] = notification_categories unless notification_categories.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#compute_project_contact(parent, notification_categories: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ComputeContactsResponse

Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 622

def compute_project_contact(parent, notification_categories: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/contacts:compute', options)
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ComputeContactsResponse::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ComputeContactsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['notificationCategories'] = notification_categories unless notification_categories.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_folder_contact(parent, google_cloud_essentialcontacts_v1_contact_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact

Adds a new contact for a resource.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 125

def create_folder_contact(parent, google_cloud_essentialcontacts_v1_contact_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/contacts', options)
  command.request_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.request_object = google_cloud_essentialcontacts_v1_contact_object
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_contact(parent, google_cloud_essentialcontacts_v1_contact_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact

Adds a new contact for a resource.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 391

def create_organization_contact(parent, google_cloud_essentialcontacts_v1_contact_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/contacts', options)
  command.request_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.request_object = google_cloud_essentialcontacts_v1_contact_object
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_contact(parent, google_cloud_essentialcontacts_v1_contact_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact

Adds a new contact for a resource.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 657

def create_project_contact(parent, google_cloud_essentialcontacts_v1_contact_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/contacts', options)
  command.request_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.request_object = google_cloud_essentialcontacts_v1_contact_object
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_folder_contact(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty

Deletes a contact.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



159
160
161
162
163
164
165
166
167
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 159

def delete_folder_contact(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_contact(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty

Deletes a contact.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



425
426
427
428
429
430
431
432
433
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 425

def delete_organization_contact(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_contact(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty

Deletes a contact.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



691
692
693
694
695
696
697
698
699
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 691

def delete_project_contact(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_folder_contact(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact

Gets a single contact.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



191
192
193
194
195
196
197
198
199
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 191

def get_folder_contact(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_contact(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact

Gets a single contact.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



457
458
459
460
461
462
463
464
465
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 457

def get_organization_contact(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_contact(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact

Gets a single contact.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



723
724
725
726
727
728
729
730
731
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 723

def get_project_contact(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_folder_contacts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ListContactsResponse

Lists the contacts that have been set on a resource.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 232

def list_folder_contacts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/contacts', options)
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ListContactsResponse::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ListContactsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_contacts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ListContactsResponse

Lists the contacts that have been set on a resource.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 498

def list_organization_contacts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/contacts', options)
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ListContactsResponse::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ListContactsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_contacts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ListContactsResponse

Lists the contacts that have been set on a resource.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 764

def list_project_contacts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/contacts', options)
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ListContactsResponse::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1ListContactsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_folder_contact(name, google_cloud_essentialcontacts_v1_contact_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact

Updates a contact. Note: A contact's email address cannot be changed.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 270

def patch_folder_contact(name, google_cloud_essentialcontacts_v1_contact_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.request_object = google_cloud_essentialcontacts_v1_contact_object
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_organization_contact(name, google_cloud_essentialcontacts_v1_contact_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact

Updates a contact. Note: A contact's email address cannot be changed.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 536

def patch_organization_contact(name, google_cloud_essentialcontacts_v1_contact_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.request_object = google_cloud_essentialcontacts_v1_contact_object
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_contact(name, google_cloud_essentialcontacts_v1_contact_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact

Updates a contact. Note: A contact's email address cannot be changed.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



802
803
804
805
806
807
808
809
810
811
812
813
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 802

def patch_project_contact(name, google_cloud_essentialcontacts_v1_contact_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.request_object = google_cloud_essentialcontacts_v1_contact_object
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1Contact
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#send_folder_contact_test_message(resource, google_cloud_essentialcontacts_v1_send_test_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty

Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 308

def send_folder_contact_test_message(resource, google_cloud_essentialcontacts_v1_send_test_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}/contacts:sendTestMessage', options)
  command.request_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1SendTestMessageRequest::Representation
  command.request_object = google_cloud_essentialcontacts_v1_send_test_message_request_object
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#send_organization_contact_test_message(resource, google_cloud_essentialcontacts_v1_send_test_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty

Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 574

def send_organization_contact_test_message(resource, google_cloud_essentialcontacts_v1_send_test_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}/contacts:sendTestMessage', options)
  command.request_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1SendTestMessageRequest::Representation
  command.request_object = google_cloud_essentialcontacts_v1_send_test_message_request_object
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#send_project_contact_test_message(resource, google_cloud_essentialcontacts_v1_send_test_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty

Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/google/apis/essentialcontacts_v1/service.rb', line 840

def send_project_contact_test_message(resource, google_cloud_essentialcontacts_v1_send_test_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}/contacts:sendTestMessage', options)
  command.request_representation = Google::Apis::EssentialcontactsV1::GoogleCloudEssentialcontactsV1SendTestMessageRequest::Representation
  command.request_object = google_cloud_essentialcontacts_v1_send_test_message_request_object
  command.response_representation = Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::EssentialcontactsV1::GoogleProtobufEmpty
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end