Class: Google::Cloud::Monitoring::V3::AlertPolicyService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Monitoring::V3::AlertPolicyService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/monitoring/v3/alert_policy_service/client.rb
Overview
Client for the AlertPolicyService service.
The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Stackdriver Monitoring. An alerting policy is a description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. In addition to using this API, alert policies can also be managed through Stackdriver Monitoring, which can be reached by clicking the "Monitoring" tab in Cloud Console.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the AlertPolicyService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the AlertPolicyService Client instance.
-
#create_alert_policy(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy
Creates a new alerting policy.
-
#delete_alert_policy(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an alerting policy.
-
#get_alert_policy(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy
Gets a single alerting policy.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new AlertPolicyService client object.
-
#list_alert_policies(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::AlertPolicy>
Lists the existing alerting policies for the workspace.
-
#update_alert_policy(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy
Updates an alerting policy.
Methods included from Paths
#alert_policy_condition_path, #alert_policy_path, #folder_path, #organization_path, #workspace_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new AlertPolicyService client object.
Examples
To create a new AlertPolicyService client with the default configuration:
client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new
To create a new AlertPolicyService client with a custom configuration:
client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new do |config|
config.timeout = 10.0
end
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/google/cloud/monitoring/v3/alert_policy_service/client.rb', line 150 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/alert_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 @alert_policy_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Monitoring::V3::AlertPolicyService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the AlertPolicyService Client class.
See Configuration for a description of the configuration fields.
Example
To modify the configuration for all AlertPolicyService clients:
::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.configure do |config|
config.timeout = 10.0
end
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 |
# File 'lib/google/cloud/monitoring/v3/alert_policy_service/client.rb', line 65 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_alert_policies.timeout = 30.0 default_config.rpcs.list_alert_policies.retry_policy = { initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.get_alert_policy.timeout = 30.0 default_config.rpcs.get_alert_policy.retry_policy = { initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.create_alert_policy.timeout = 30.0 default_config.rpcs.delete_alert_policy.timeout = 30.0 default_config.rpcs.delete_alert_policy.retry_policy = { initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.update_alert_policy.timeout = 30.0 default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the AlertPolicyService 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.
125 126 127 128 |
# File 'lib/google/cloud/monitoring/v3/alert_policy_service/client.rb', line 125 def configure yield @config if block_given? @config end |
#create_alert_policy(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy #create_alert_policy(name: nil, alert_policy: nil) ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy
Creates a new alerting policy.
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 425 426 427 428 429 |
# File 'lib/google/cloud/monitoring/v3/alert_policy_service/client.rb', line 394 def create_alert_policy request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::CreateAlertPolicyRequest # 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_alert_policy..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_alert_policy.timeout, metadata: , retry_policy: @config.rpcs.create_alert_policy.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @alert_policy_service_stub.call_rpc :create_alert_policy, 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_alert_policy(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_alert_policy(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes an alerting policy.
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 |
# File 'lib/google/cloud/monitoring/v3/alert_policy_service/client.rb', line 464 def delete_alert_policy request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::DeleteAlertPolicyRequest # 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_alert_policy..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_alert_policy.timeout, metadata: , retry_policy: @config.rpcs.delete_alert_policy.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @alert_policy_service_stub.call_rpc :delete_alert_policy, 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_alert_policy(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy #get_alert_policy(name: nil) ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy
Gets a single alerting policy.
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 |
# File 'lib/google/cloud/monitoring/v3/alert_policy_service/client.rb', line 314 def get_alert_policy request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::GetAlertPolicyRequest # 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_alert_policy..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_alert_policy.timeout, metadata: , retry_policy: @config.rpcs.get_alert_policy.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @alert_policy_service_stub.call_rpc :get_alert_policy, 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_alert_policies(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::AlertPolicy> #list_alert_policies(name: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::AlertPolicy>
Lists the existing alerting policies for the workspace.
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 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/google/cloud/monitoring/v3/alert_policy_service/client.rb', line 245 def list_alert_policies request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::ListAlertPoliciesRequest # 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_alert_policies..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_alert_policies.timeout, metadata: , retry_policy: @config.rpcs.list_alert_policies.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @alert_policy_service_stub.call_rpc :list_alert_policies, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @alert_policy_service_stub, :list_alert_policies, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#update_alert_policy(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy #update_alert_policy(update_mask: nil, alert_policy: nil) ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy
Updates an alerting policy. You can either replace the entire policy with
a new one or replace only certain fields in the current alerting policy by
specifying the fields to be updated via updateMask
. Returns the
updated alerting policy.
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 585 586 587 588 589 590 591 592 593 |
# File 'lib/google/cloud/monitoring/v3/alert_policy_service/client.rb', line 558 def update_alert_policy request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::UpdateAlertPolicyRequest # 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_alert_policy..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 = { "alert_policy.name" => request.alert_policy.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_alert_policy.timeout, metadata: , retry_policy: @config.rpcs.update_alert_policy.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @alert_policy_service_stub.call_rpc :update_alert_policy, 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 |