Class: Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/essential_contacts/v1/essential_contacts_service/rest/client.rb

Overview

REST client for the EssentialContactsService service.

Manages contacts for important Google Cloud notifications.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#contact_path, #folder_path, #organization_path, #project_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new EssentialContactsService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the EssentialContactsService client.

Yield Parameters:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/rest/client.rb', line 131

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @essential_contacts_service_stub = ::Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the EssentialContactsService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all EssentialContactsService clients
::Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/rest/client.rb', line 58

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "EssentialContacts", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.create_contact.timeout = 60.0

    default_config.rpcs.update_contact.timeout = 60.0

    default_config.rpcs.list_contacts.timeout = 60.0
    default_config.rpcs.list_contacts.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_contact.timeout = 60.0
    default_config.rpcs.get_contact.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_contact.timeout = 60.0

    default_config.rpcs.compute_contacts.timeout = 60.0

    default_config.rpcs.send_test_message.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#compute_contacts(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EssentialContacts::V1::Contact> #compute_contacts(parent: nil, notification_categories: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EssentialContacts::V1::Contact>

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

Examples:

Basic example

require "google/cloud/essential_contacts/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::EssentialContacts::V1::ComputeContactsRequest.new

# Call the compute_contacts method.
result = client.compute_contacts request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::EssentialContacts::V1::Contact.
  p item
end

Overloads:

  • #compute_contacts(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EssentialContacts::V1::Contact>

    Pass arguments to compute_contacts via a request object, either of type ComputeContactsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::EssentialContacts::V1::ComputeContactsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #compute_contacts(parent: nil, notification_categories: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EssentialContacts::V1::Contact>

    Pass arguments to compute_contacts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

    • notification_categories (::Array<::Google::Cloud::EssentialContacts::V1::NotificationCategory>) (defaults to: nil) —

      The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available. If not specified, the default page_size is 100.

    • page_token (::String) (defaults to: nil) —

      Optional. If present, retrieves the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/rest/client.rb', line 647

def compute_contacts request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EssentialContacts::V1::ComputeContactsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.compute_contacts.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::EssentialContacts::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.compute_contacts.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.compute_contacts.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @essential_contacts_service_stub.compute_contacts request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @essential_contacts_service_stub, :compute_contacts, "contacts", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the EssentialContactsService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



110
111
112
113
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/rest/client.rb', line 110

def configure
  yield @config if block_given?
  @config
end

#create_contact(request, options = nil) ⇒ ::Google::Cloud::EssentialContacts::V1::Contact #create_contact(parent: nil, contact: nil) ⇒ ::Google::Cloud::EssentialContacts::V1::Contact

Adds a new contact for a resource.

Examples:

Basic example

require "google/cloud/essential_contacts/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::EssentialContacts::V1::CreateContactRequest.new

# Call the create_contact method.
result = client.create_contact request

# The returned object is of type Google::Cloud::EssentialContacts::V1::Contact.
p result

Overloads:

  • #create_contact(request, options = nil) ⇒ ::Google::Cloud::EssentialContacts::V1::Contact

    Pass arguments to create_contact via a request object, either of type CreateContactRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::EssentialContacts::V1::CreateContactRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_contact(parent: nil, contact: nil) ⇒ ::Google::Cloud::EssentialContacts::V1::Contact

    Pass arguments to create_contact via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

    • contact (::Google::Cloud::EssentialContacts::V1::Contact, ::Hash) (defaults to: nil) —

      Required. The contact to create. Must specify an email address and language tag.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/rest/client.rb', line 206

def create_contact request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EssentialContacts::V1::CreateContactRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_contact.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::EssentialContacts::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_contact.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_contact.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @essential_contacts_service_stub.create_contact request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_contact(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_contact(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a contact.

Examples:

Basic example

require "google/cloud/essential_contacts/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::EssentialContacts::V1::DeleteContactRequest.new

# Call the delete_contact method.
result = client.delete_contact request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_contact(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_contact via a request object, either of type DeleteContactRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::EssentialContacts::V1::DeleteContactRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_contact(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_contact via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/rest/client.rb', line 547

def delete_contact request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EssentialContacts::V1::DeleteContactRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_contact.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::EssentialContacts::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_contact.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_contact.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @essential_contacts_service_stub.delete_contact request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_contact(request, options = nil) ⇒ ::Google::Cloud::EssentialContacts::V1::Contact #get_contact(name: nil) ⇒ ::Google::Cloud::EssentialContacts::V1::Contact

Gets a single contact.

Examples:

Basic example

require "google/cloud/essential_contacts/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::EssentialContacts::V1::GetContactRequest.new

# Call the get_contact method.
result = client.get_contact request

# The returned object is of type Google::Cloud::EssentialContacts::V1::Contact.
p result

Overloads:

  • #get_contact(request, options = nil) ⇒ ::Google::Cloud::EssentialContacts::V1::Contact

    Pass arguments to get_contact via a request object, either of type GetContactRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::EssentialContacts::V1::GetContactRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_contact(name: nil) ⇒ ::Google::Cloud::EssentialContacts::V1::Contact

    Pass arguments to get_contact via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/rest/client.rb', line 466

def get_contact request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EssentialContacts::V1::GetContactRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_contact.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::EssentialContacts::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_contact.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_contact.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @essential_contacts_service_stub.get_contact request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_contacts(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EssentialContacts::V1::Contact> #list_contacts(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EssentialContacts::V1::Contact>

Lists the contacts that have been set on a resource.

Examples:

Basic example

require "google/cloud/essential_contacts/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::EssentialContacts::V1::ListContactsRequest.new

# Call the list_contacts method.
result = client.list_contacts request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::EssentialContacts::V1::Contact.
  p item
end

Overloads:

  • #list_contacts(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EssentialContacts::V1::Contact>

    Pass arguments to list_contacts via a request object, either of type ListContactsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::EssentialContacts::V1::ListContactsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_contacts(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EssentialContacts::V1::Contact>

    Pass arguments to list_contacts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available. If not specified, the default page_size is 100.

    • page_token (::String) (defaults to: nil) —

      Optional. If present, retrieves the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/rest/client.rb', line 384

def list_contacts request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EssentialContacts::V1::ListContactsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_contacts.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::EssentialContacts::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_contacts.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_contacts.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @essential_contacts_service_stub.list_contacts request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @essential_contacts_service_stub, :list_contacts, "contacts", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#send_test_message(request, options = nil) ⇒ ::Google::Protobuf::Empty #send_test_message(contacts: nil, resource: nil, notification_category: nil) ⇒ ::Google::Protobuf::Empty

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

Examples:

Basic example

require "google/cloud/essential_contacts/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::EssentialContacts::V1::SendTestMessageRequest.new

# Call the send_test_message method.
result = client.send_test_message request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #send_test_message(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to send_test_message via a request object, either of type SendTestMessageRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::EssentialContacts::V1::SendTestMessageRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #send_test_message(contacts: nil, resource: nil, notification_category: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to send_test_message via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • contacts (::Array<::String>) (defaults to: nil) —

      Required. The list of names of the contacts to send a test message to. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}

    • resource (::String) (defaults to: nil) —

      Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

    • notification_category (::Google::Cloud::EssentialContacts::V1::NotificationCategory) (defaults to: nil) —

      Required. The notification category to send the test message for. All contacts must be subscribed to this category.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/rest/client.rb', line 739

def send_test_message request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EssentialContacts::V1::SendTestMessageRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.send_test_message.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::EssentialContacts::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.send_test_message.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.send_test_message.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @essential_contacts_service_stub.send_test_message request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_contact(request, options = nil) ⇒ ::Google::Cloud::EssentialContacts::V1::Contact #update_contact(contact: nil, update_mask: nil) ⇒ ::Google::Cloud::EssentialContacts::V1::Contact

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

Examples:

Basic example

require "google/cloud/essential_contacts/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::EssentialContacts::V1::UpdateContactRequest.new

# Call the update_contact method.
result = client.update_contact request

# The returned object is of type Google::Cloud::EssentialContacts::V1::Contact.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/rest/client.rb', line 290

def update_contact request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EssentialContacts::V1::UpdateContactRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_contact.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::EssentialContacts::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_contact.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_contact.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @essential_contacts_service_stub.update_contact request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end