Class: Google::Cloud::Monitoring::V3::NotificationChannelService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/monitoring/v3/notification_channel_service/client.rb

Overview

Client for the NotificationChannelService service.

The Notification Channel API provides access to configuration that controls how messages related to incidents are sent.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#folder_path, #notification_channel_descriptor_path, #notification_channel_path, #organization_path, #project_path, #workspace_path

Constructor Details

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

Create a new NotificationChannelService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the NotificationChannelService client.

Yield Parameters:



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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 166

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/monitoring/v3/notification_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

  @notification_channel_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Monitoring::V3::NotificationChannelService::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
  )

  @notification_channel_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 NotificationChannelService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all NotificationChannelService clients
::Google::Cloud::Monitoring::V3::NotificationChannelService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Monitoring", "V3"]
    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.list_notification_channel_descriptors.timeout = 30.0
    default_config.rpcs.list_notification_channel_descriptors.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_notification_channel_descriptor.timeout = 30.0
    default_config.rpcs.get_notification_channel_descriptor.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_notification_channels.timeout = 30.0
    default_config.rpcs.list_notification_channels.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_notification_channel.timeout = 30.0
    default_config.rpcs.get_notification_channel.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_notification_channel.timeout = 30.0

    default_config.rpcs.update_notification_channel.timeout = 30.0

    default_config.rpcs.delete_notification_channel.timeout = 30.0
    default_config.rpcs.delete_notification_channel.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.send_notification_channel_verification_code.timeout = 30.0

    default_config.rpcs.get_notification_channel_verification_code.timeout = 30.0
    default_config.rpcs.get_notification_channel_verification_code.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.verify_notification_channel.timeout = 30.0
    default_config.rpcs.verify_notification_channel.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the NotificationChannelService 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:



136
137
138
139
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 136

def configure
  yield @config if block_given?
  @config
end

#create_notification_channel(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel #create_notification_channel(name: nil, notification_channel: nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.

Examples:

Basic example

require "google/cloud/monitoring/v3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Monitoring::V3::CreateNotificationChannelRequest.new

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

# The returned object is of type Google::Cloud::Monitoring::V3::NotificationChannel.
p result

Overloads:

  • #create_notification_channel(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::CreateNotificationChannelRequest, ::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_notification_channel(name: nil, notification_channel: nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel

    Pass arguments to create_notification_channel 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 project on which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]
      

      This names the container into which the channel will be written, this does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel.

    • notification_channel (::Google::Cloud::Monitoring::V3::NotificationChannel, ::Hash) (defaults to: nil)

      Required. The definition of the NotificationChannel to create.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 703

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::CreateNotificationChannelRequest

  # 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
   = @config.rpcs.create_notification_channel..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @notification_channel_service_stub.call_rpc :create_notification_channel, 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_notification_channel(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_notification_channel(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty

Deletes a notification channel.

Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.

Examples:

Basic example

require "google/cloud/monitoring/v3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Monitoring::V3::DeleteNotificationChannelRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::DeleteNotificationChannelRequest, ::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_notification_channel(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_notification_channel 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 channel for which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
      
    • force (::Boolean) (defaults to: nil)

      If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, this operation will fail if the notification channel is referenced by existing alerting policies.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 896

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::DeleteNotificationChannelRequest

  # 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
   = @config.rpcs.delete_notification_channel..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @notification_channel_service_stub.call_rpc :delete_notification_channel, 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_notification_channel(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel #get_notification_channel(name: nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel

Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method.

Examples:

Basic example

require "google/cloud/monitoring/v3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Monitoring::V3::GetNotificationChannelRequest.new

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

# The returned object is of type Google::Cloud::Monitoring::V3::NotificationChannel.
p result

Overloads:

  • #get_notification_channel(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::GetNotificationChannelRequest, ::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_notification_channel(name: nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel

    Pass arguments to get_notification_channel 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 channel for which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
      

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 601

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::GetNotificationChannelRequest

  # 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
   = @config.rpcs.get_notification_channel..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @notification_channel_service_stub.call_rpc :get_notification_channel, 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_notification_channel_descriptor(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannelDescriptor #get_notification_channel_descriptor(name: nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannelDescriptor

Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.

Examples:

Basic example

require "google/cloud/monitoring/v3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Monitoring::V3::GetNotificationChannelDescriptorRequest.new

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

# The returned object is of type Google::Cloud::Monitoring::V3::NotificationChannelDescriptor.
p result

Overloads:

  • #get_notification_channel_descriptor(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannelDescriptor

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::GetNotificationChannelDescriptorRequest, ::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_notification_channel_descriptor(name: nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannelDescriptor

    Pass arguments to get_notification_channel_descriptor 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 channel type for which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE]
      

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
419
420
421
422
423
424
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 385

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::GetNotificationChannelDescriptorRequest

  # 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
   = @config.rpcs.get_notification_channel_descriptor..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @notification_channel_service_stub.call_rpc :get_notification_channel_descriptor, 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_notification_channel_verification_code(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::GetNotificationChannelVerificationCodeResponse #get_notification_channel_verification_code(name: nil, expire_time: nil) ⇒ ::Google::Cloud::Monitoring::V3::GetNotificationChannelVerificationCodeResponse

Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been used to put the given channel into the verified state).

There is no guarantee that the verification codes returned by this method will be of a similar structure or form as the ones that are delivered to the channel via SendNotificationChannelVerificationCode; while VerifyNotificationChannel() will recognize both the codes delivered via SendNotificationChannelVerificationCode() and returned from GetNotificationChannelVerificationCode(), it is typically the case that the verification codes delivered via SendNotificationChannelVerificationCode() will be shorter and also have a shorter expiration (e.g. codes such as "G-123456") whereas GetVerificationCode() will typically return a much longer, websafe base 64 encoded string that has a longer expiration time.

Examples:

Basic example

require "google/cloud/monitoring/v3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Monitoring::V3::GetNotificationChannelVerificationCodeRequest.new

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

# The returned object is of type Google::Cloud::Monitoring::V3::GetNotificationChannelVerificationCodeResponse.
p result

Overloads:

  • #get_notification_channel_verification_code(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::GetNotificationChannelVerificationCodeResponse

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::GetNotificationChannelVerificationCodeRequest, ::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_notification_channel_verification_code(name: nil, expire_time: nil) ⇒ ::Google::Cloud::Monitoring::V3::GetNotificationChannelVerificationCodeResponse

    Pass arguments to get_notification_channel_verification_code 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 notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail.

    • expire_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil)

      The desired expiration time. If specified, the API will guarantee that the returned code will not be valid after the specified timestamp; however, the API cannot guarantee that the returned code will be valid for at least as long as the requested time (the API puts an upper bound on the amount of time for which a code may be valid). If omitted, a default expiration will be used, which may be less than the max permissible expiration (so specifying an expiration may extend the code's lifetime over omitting an expiration, even though the API does impose an upper limit on the maximum expiration that is permitted).

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 1099

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::GetNotificationChannelVerificationCodeRequest

  # 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
   = @config.rpcs.get_notification_channel_verification_code..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @notification_channel_service_stub.call_rpc :get_notification_channel_verification_code, 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_notification_channel_descriptors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::NotificationChannelDescriptor> #list_notification_channel_descriptors(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::NotificationChannelDescriptor>

Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

Examples:

Basic example

require "google/cloud/monitoring/v3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Monitoring::V3::ListNotificationChannelDescriptorsRequest.new

# Call the list_notification_channel_descriptors method.
result = client.list_notification_channel_descriptors 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::Monitoring::V3::NotificationChannelDescriptor.
  p item
end

Overloads:

  • #list_notification_channel_descriptors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::NotificationChannelDescriptor>

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::ListNotificationChannelDescriptorsRequest, ::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_notification_channel_descriptors(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::NotificationChannelDescriptor>

    Pass arguments to list_notification_channel_descriptors 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 REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is:

      projects/[PROJECT_ID_OR_NUMBER]
      

      Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead.

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

      The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.

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

      If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 295

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::ListNotificationChannelDescriptorsRequest

  # 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
   = @config.rpcs.list_notification_channel_descriptors..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @notification_channel_service_stub.call_rpc :list_notification_channel_descriptors, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @notification_channel_service_stub, :list_notification_channel_descriptors, 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

#list_notification_channels(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::NotificationChannel> #list_notification_channels(name: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::NotificationChannel>

Lists the notification channels that have been created for the project. To list the types of notification channels that are supported, use the ListNotificationChannelDescriptors method.

Examples:

Basic example

require "google/cloud/monitoring/v3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Monitoring::V3::ListNotificationChannelsRequest.new

# Call the list_notification_channels method.
result = client.list_notification_channels 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::Monitoring::V3::NotificationChannel.
  p item
end

Overloads:

  • #list_notification_channels(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::NotificationChannel>

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::ListNotificationChannelsRequest, ::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_notification_channels(name: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::NotificationChannel>

    Pass arguments to list_notification_channels 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 project on which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]
      

      This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation.

    • filter (::String) (defaults to: nil)

      Optional. If provided, this field specifies the criteria that must be met by notification channels to be included in the response.

      For more details, see sorting and filtering.

    • order_by (::String) (defaults to: nil)

      Optional. A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.

      For more details, see sorting and filtering.

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

      Optional. The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.

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

      Optional. If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 508

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::ListNotificationChannelsRequest

  # 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
   = @config.rpcs.list_notification_channels..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @notification_channel_service_stub.call_rpc :list_notification_channels, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @notification_channel_service_stub, :list_notification_channels, 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

#loggerLogger

The logger used for request/response debug logging.

Returns:

  • (Logger)


222
223
224
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 222

def logger
  @notification_channel_service_stub.logger
end

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

Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel.

Examples:

Basic example

require "google/cloud/monitoring/v3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Monitoring::V3::SendNotificationChannelVerificationCodeRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::SendNotificationChannelVerificationCodeRequest, ::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_notification_channel_verification_code(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to send_notification_channel_verification_code 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 notification channel to which to send a verification code.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 982

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::SendNotificationChannelVerificationCodeRequest

  # 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
   = @config.rpcs.send_notification_channel_verification_code..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @notification_channel_service_stub.call_rpc :send_notification_channel_verification_code, 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_domainString

The effective universe domain

Returns:

  • (String)


146
147
148
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 146

def universe_domain
  @notification_channel_service_stub.universe_domain
end

#update_notification_channel(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel #update_notification_channel(update_mask: nil, notification_channel: nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel

Updates a notification channel. Fields not specified in the field mask remain unchanged.

Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.

Examples:

Basic example

require "google/cloud/monitoring/v3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Monitoring::V3::UpdateNotificationChannelRequest.new

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

# The returned object is of type Google::Cloud::Monitoring::V3::NotificationChannel.
p result

Overloads:

  • #update_notification_channel(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::UpdateNotificationChannelRequest, ::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.

  • #update_notification_channel(update_mask: nil, notification_channel: nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel

    Pass arguments to update_notification_channel 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:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil)

      Optional. The fields to update.

    • notification_channel (::Google::Cloud::Monitoring::V3::NotificationChannel, ::Hash) (defaults to: nil)

      Required. A description of the changes to be applied to the specified notification channel. The description must provide a definition for fields to be updated; the names of these fields should also be included in the update_mask.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 799

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::UpdateNotificationChannelRequest

  # 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
   = @config.rpcs.update_notification_channel..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

  @notification_channel_service_stub.call_rpc :update_notification_channel, 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

#verify_notification_channel(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel #verify_notification_channel(name: nil, code: nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel

Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode.

Examples:

Basic example

require "google/cloud/monitoring/v3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Monitoring::V3::VerifyNotificationChannelRequest.new

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

# The returned object is of type Google::Cloud::Monitoring::V3::NotificationChannel.
p result

Overloads:

  • #verify_notification_channel(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::VerifyNotificationChannelRequest, ::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.

  • #verify_notification_channel(name: nil, code: nil) ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel

    Pass arguments to verify_notification_channel 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 notification channel to verify.

    • code (::String) (defaults to: nil)

      Required. The verification code that was delivered to the channel as a result of invoking the SendNotificationChannelVerificationCode API method or that was retrieved from a verified channel via GetNotificationChannelVerificationCode. For example, one might have "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code).

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 1194

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::VerifyNotificationChannelRequest

  # 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
   = @config.rpcs.verify_notification_channel..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @notification_channel_service_stub.call_rpc :verify_notification_channel, 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