Class: Google::Cloud::Monitoring::V3::SnoozeService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Monitoring::V3::SnoozeService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/monitoring/v3/snooze_service/client.rb
Overview
Client for the SnoozeService service.
The SnoozeService API is used to temporarily prevent an alert policy from generating alerts. A Snooze is a description of the criteria under which one or more alert policies should not fire alerts for the specified duration.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the SnoozeService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the SnoozeService Client instance.
-
#create_snooze(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::Snooze
Creates a
Snooze
that will prevent alerts, which match the provided criteria, from being opened. -
#get_snooze(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::Snooze
Retrieves a
Snooze
byname
. -
#initialize {|config| ... } ⇒ Client
constructor
Create a new SnoozeService client object.
-
#list_snoozes(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::Snooze>
Lists the
Snooze
s associated with a project. -
#universe_domain ⇒ String
The effective universe domain.
-
#update_snooze(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::Snooze
Updates a
Snooze
, identified by itsname
, with the parameters in the givenSnooze
object.
Methods included from Paths
#alert_policy_path, #project_path, #snooze_path, #workspace_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new SnoozeService client object.
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/google/cloud/monitoring/v3/snooze_service/client.rb', line 137 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/snooze_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 @snooze_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Monitoring::V3::SnoozeService::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 SnoozeService Client class.
See Configuration for a description of the configuration fields.
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 |
# File 'lib/google/cloud/monitoring/v3/snooze_service/client.rb', line 61 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.create_snooze.timeout = 30.0 default_config.rpcs.list_snoozes.timeout = 30.0 default_config.rpcs.list_snoozes.retry_policy = { initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.get_snooze.timeout = 30.0 default_config.rpcs.get_snooze.retry_policy = { initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.update_snooze.timeout = 30.0 default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the SnoozeService 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.
107 108 109 110 |
# File 'lib/google/cloud/monitoring/v3/snooze_service/client.rb', line 107 def configure yield @config if block_given? @config end |
#create_snooze(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::Snooze #create_snooze(parent: nil, snooze: nil) ⇒ ::Google::Cloud::Monitoring::V3::Snooze
Creates a Snooze
that will prevent alerts, which match the provided
criteria, from being opened. The Snooze
applies for a specific time
interval.
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/google/cloud/monitoring/v3/snooze_service/client.rb', line 232 def create_snooze request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::CreateSnoozeRequest # 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_snooze..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.parent header_params["parent"] = request.parent 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_snooze.timeout, metadata: , retry_policy: @config.rpcs.create_snooze.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @snooze_service_stub.call_rpc :create_snooze, 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_snooze(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::Snooze #get_snooze(name: nil) ⇒ ::Google::Cloud::Monitoring::V3::Snooze
Retrieves a Snooze
by name
.
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 465 466 467 468 469 470 471 472 473 474 475 |
# File 'lib/google/cloud/monitoring/v3/snooze_service/client.rb', line 436 def get_snooze request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::GetSnoozeRequest # 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_snooze..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_snooze.timeout, metadata: , retry_policy: @config.rpcs.get_snooze.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @snooze_service_stub.call_rpc :get_snooze, 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_snoozes(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::Snooze> #list_snoozes(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::Snooze>
Lists the Snooze
s associated with a project. Can optionally pass in
filter
, which specifies predicates to match Snooze
s.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
# File 'lib/google/cloud/monitoring/v3/snooze_service/client.rb', line 348 def list_snoozes request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::ListSnoozesRequest # 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_snoozes..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.parent header_params["parent"] = request.parent 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_snoozes.timeout, metadata: , retry_policy: @config.rpcs.list_snoozes.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @snooze_service_stub.call_rpc :list_snoozes, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @snooze_service_stub, :list_snoozes, request, 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
117 118 119 |
# File 'lib/google/cloud/monitoring/v3/snooze_service/client.rb', line 117 def universe_domain @snooze_service_stub.universe_domain end |
#update_snooze(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::Snooze #update_snooze(snooze: nil, update_mask: nil) ⇒ ::Google::Cloud::Monitoring::V3::Snooze
Updates a Snooze
, identified by its name
, with the parameters in the
given Snooze
object.
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 |
# File 'lib/google/cloud/monitoring/v3/snooze_service/client.rb', line 545 def update_snooze request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::UpdateSnoozeRequest # 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_snooze..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.snooze&.name header_params["snooze.name"] = request.snooze.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_snooze.timeout, metadata: , retry_policy: @config.rpcs.update_snooze.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @snooze_service_stub.call_rpc :update_snooze, 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 |