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

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

Overview

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 client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the EssentialContactsService client.

Yield Parameters:



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/client.rb', line 144

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/essentialcontacts/v1/service_services_pb"

  # 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.nil? ||
                           (@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 = ::Gapic::ServiceStub.new(
    ::Google::Cloud::EssentialContacts::V1::EssentialContactsService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @essential_contacts_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
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::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
94
95
96
97
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/client.rb', line 62

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::PagedEnumerable<::Google::Cloud::EssentialContacts::V1::Contact> #compute_contacts(parent: nil, notification_categories: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



732
733
734
735
736
737
738
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
773
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/client.rb', line 732

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
  metadata = @config.rpcs.compute_contacts.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.compute_contacts.timeout,
                         metadata:     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.call_rpc :compute_contacts, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @essential_contacts_service_stub, :compute_contacts, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => 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:



114
115
116
117
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/client.rb', line 114

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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/client.rb', line 255

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
  metadata = @config.rpcs.create_contact.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_contact.timeout,
                         metadata:     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.call_rpc :create_contact, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/client.rb', line 625

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
  metadata = @config.rpcs.delete_contact.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_contact.timeout,
                         metadata:     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.call_rpc :delete_contact, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



537
538
539
540
541
542
543
544
545
546
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
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/client.rb', line 537

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
  metadata = @config.rpcs.get_contact.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_contact.timeout,
                         metadata:     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.call_rpc :get_contact, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_contacts(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::EssentialContacts::V1::Contact> #list_contacts(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/client.rb', line 447

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
  metadata = @config.rpcs.list_contacts.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_contacts.timeout,
                         metadata:     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.call_rpc :list_contacts, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @essential_contacts_service_stub, :list_contacts, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


200
201
202
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/client.rb', line 200

def logger
  @essential_contacts_service_stub.logger
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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/client.rb', line 832

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
  metadata = @config.rpcs.send_test_message.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.resource
    header_params["resource"] = request.resource
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.send_test_message.timeout,
                         metadata:     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.call_rpc :send_test_message, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


124
125
126
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/client.rb', line 124

def universe_domain
  @essential_contacts_service_stub.universe_domain
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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/google/cloud/essential_contacts/v1/essential_contacts_service/client.rb', line 346

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
  metadata = @config.rpcs.update_contact.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.contact&.name
    header_params["contact.name"] = request.contact.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_contact.timeout,
                         metadata:     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.call_rpc :update_contact, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end