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.
-
#universe_domain ⇒ String
The effective universe domain.
-
#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, #project_path, #workspace_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new NotificationChannelService client object.
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 194 195 196 197 198 199 200 201 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 163 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 ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the NotificationChannelService Client class.
See Configuration for a description of the configuration fields.
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 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 60 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.
133 134 135 136 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 133 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.
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 678 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 = {} 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 .apply_defaults timeout: @config.rpcs.create_notification_channel.timeout, metadata: , retry_policy: @config.rpcs.create_notification_channel.retry_policy .apply_defaults timeout: @config.timeout, 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.
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.
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 871 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 = {} 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 .apply_defaults timeout: @config.rpcs.delete_notification_channel.timeout, metadata: , retry_policy: @config.rpcs.delete_notification_channel.retry_policy .apply_defaults timeout: @config.timeout, 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.
576 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 613 614 615 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 576 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 = {} 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 .apply_defaults timeout: @config.rpcs.get_notification_channel.timeout, metadata: , retry_policy: @config.rpcs.get_notification_channel.retry_policy .apply_defaults timeout: @config.timeout, 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.
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 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 361 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 = {} 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 .apply_defaults timeout: @config.rpcs.get_notification_channel_descriptor.timeout, metadata: , retry_policy: @config.rpcs.get_notification_channel_descriptor.retry_policy .apply_defaults timeout: @config.timeout, 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.
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 1074 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 = {} 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 .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 timeout: @config.timeout, 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.
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 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 272 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 = {} 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 .apply_defaults timeout: @config.rpcs.list_notification_channel_descriptors.timeout, metadata: , retry_policy: @config.rpcs.list_notification_channel_descriptors.retry_policy .apply_defaults timeout: @config.timeout, 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.
To list the types of notification channels that are supported, use
the ListNotificationChannelDescriptors
method.
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 484 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 = {} 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 .apply_defaults timeout: @config.rpcs.list_notification_channels.timeout, metadata: , retry_policy: @config.rpcs.list_notification_channels.retry_policy .apply_defaults timeout: @config.timeout, 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.
957 958 959 960 961 962 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 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 957 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 = {} 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 .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 timeout: @config.timeout, 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 |
#universe_domain ⇒ String
The effective universe domain
143 144 145 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 143 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.
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 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 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 774 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 = {} 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 .apply_defaults timeout: @config.rpcs.update_notification_channel.timeout, metadata: , retry_policy: @config.rpcs.update_notification_channel.retry_policy .apply_defaults timeout: @config.timeout, 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
.
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 |
# File 'lib/google/cloud/monitoring/v3/notification_channel_service/client.rb', line 1169 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 = {} 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 .apply_defaults timeout: @config.rpcs.verify_notification_channel.timeout, metadata: , retry_policy: @config.rpcs.verify_notification_channel.retry_policy .apply_defaults timeout: @config.timeout, 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 |