Class: Google::Cloud::Monitoring::V3::NotificationChannelService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Monitoring::V3::NotificationChannelService::Client
- 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
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the NotificationChannelService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the NotificationChannelService Client instance.
-
#create_notification_channel(request, options = nil) {|response, operation| ... } ⇒ ::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.
-
#delete_notification_channel(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a notification channel.
-
#get_notification_channel(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel
Gets a single notification channel.
-
#get_notification_channel_descriptor(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannelDescriptor
Gets a single channel descriptor.
-
#get_notification_channel_verification_code(request, options = nil) {|response, operation| ... } ⇒ ::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.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new NotificationChannelService client object.
-
#list_notification_channel_descriptors(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::NotificationChannelDescriptor>
Lists the descriptors for supported channel types.
-
#list_notification_channels(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::NotificationChannel>
Lists the notification channels that have been created for the project.
-
#send_notification_channel_verification_code(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Causes a verification code to be delivered to the channel.
-
#update_notification_channel(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel
Updates a notification channel.
-
#verify_notification_channel(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel
Verifies a
NotificationChannel
by proving receipt of the code delivered to the channel as a result of callingSendNotificationChannelVerificationCode
.
Methods included from Paths
#folder_path, #notification_channel_descriptor_path, #notification_channel_path, #organization_path, #workspace_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new NotificationChannelService client object.
Examples
To create a new NotificationChannelService client with the default configuration:
client = ::Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new
To create a new NotificationChannelService client with a custom configuration:
client = ::Google::Cloud::Monitoring::V3::NotificationChannelService::Client.new do |config|
config.timeout = 10.0
end
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 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 177 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 scope and endpoint are unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.scope == Client.configure.scope && @config.endpoint == Client.configure.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, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the NotificationChannelService Client class.
See Configuration for a description of the configuration fields.
Example
To modify the configuration for all NotificationChannelService clients:
::Google::Cloud::Monitoring::V3::NotificationChannelService::Client.configure do |config|
config.timeout = 10.0
end
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 58 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: [4, 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: [4, 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: [4, 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: [4, 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: [4, 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: [4, 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: [4, 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.
152 153 154 155 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 152 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.
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 577 def create_notification_channel request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_notification_channel..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_notification_channel.timeout, metadata: , retry_policy: @config.rpcs.create_notification_channel.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @notification_channel_service_stub.call_rpc :create_notification_channel, request, options: do |response, operation| yield response, operation if block_given? return response 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.
722 723 724 725 726 727 728 729 730 731 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 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 722 def delete_notification_channel request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_notification_channel..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_notification_channel.timeout, metadata: , retry_policy: @config.rpcs.delete_notification_channel.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @notification_channel_service_stub.call_rpc :delete_notification_channel, request, options: do |response, operation| yield response, operation if block_given? return response 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.
501 502 503 504 505 506 507 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 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 501 def get_notification_channel request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_notification_channel..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_notification_channel.timeout, metadata: , retry_policy: @config.rpcs.get_notification_channel.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @notification_channel_service_stub.call_rpc :get_notification_channel, request, options: do |response, operation| yield response, operation if block_given? return response 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.
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 332 def get_notification_channel_descriptor request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_notification_channel_descriptor..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_notification_channel_descriptor.timeout, metadata: , retry_policy: @config.rpcs.get_notification_channel_descriptor.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @notification_channel_service_stub.call_rpc :get_notification_channel_descriptor, request, options: do |response, operation| yield response, operation if block_given? return response 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.
887 888 889 890 891 892 893 894 895 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 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 887 def get_notification_channel_verification_code request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_notification_channel_verification_code..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_notification_channel_verification_code.timeout, metadata: , retry_policy: @config.rpcs.get_notification_channel_verification_code.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @notification_channel_service_stub.call_rpc :get_notification_channel_verification_code, request, options: do |response, operation| yield response, operation if block_given? return response 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.
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 295 296 297 298 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 262 def list_notification_channel_descriptors request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_notification_channel_descriptors..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_notification_channel_descriptors.timeout, metadata: , retry_policy: @config.rpcs.list_notification_channel_descriptors.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @notification_channel_service_stub.call_rpc :list_notification_channel_descriptors, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @notification_channel_service_stub, :list_notification_channel_descriptors, request, response, operation, yield response, operation if block_given? return 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.
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 428 def list_notification_channels request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_notification_channels..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_notification_channels.timeout, metadata: , retry_policy: @config.rpcs.list_notification_channels.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @notification_channel_service_stub.call_rpc :list_notification_channels, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @notification_channel_service_stub, :list_notification_channels, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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.
789 790 791 792 793 794 795 796 797 798 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 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 789 def send_notification_channel_verification_code request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.send_notification_channel_verification_code..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.send_notification_channel_verification_code.timeout, metadata: , retry_policy: @config.rpcs.send_notification_channel_verification_code.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @notification_channel_service_stub.call_rpc :send_notification_channel_verification_code, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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.
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 649 def update_notification_channel request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_notification_channel..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "notification_channel.name" => request.notification_channel.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_notification_channel.timeout, metadata: , retry_policy: @config.rpcs.update_notification_channel.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @notification_channel_service_stub.call_rpc :update_notification_channel, request, options: do |response, operation| yield response, operation if block_given? return response 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
.
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 963 def verify_notification_channel request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.verify_notification_channel..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.verify_notification_channel.timeout, metadata: , retry_policy: @config.rpcs.verify_notification_channel.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @notification_channel_service_stub.call_rpc :verify_notification_channel, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |