class Google::Cloud::Monitoring::V3::AlertPolicyService::Client
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](cloud.google.com/monitoring/docs/), which can be reached by clicking the “Monitoring” tab in [Cloud Console](console.cloud.google.com/).
Attributes
@private
Public Class Methods
Configure the AlertPolicyService
Client
class.
See {::Google::Cloud::Monitoring::V3::AlertPolicyService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all AlertPolicyService clients ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/monitoring/v3/alert_policy_service/client.rb, line 64 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: [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: [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: [14] } default_config.rpcs.update_alert_policy.timeout = 30.0 default_config end yield @configure if block_given? @configure end
Create a new AlertPolicyService
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the AlertPolicyService
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/monitoring/v3/alert_policy_service/client.rb, line 136 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 endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @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
Public Instance Methods
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 {Client.configure}.
See {::Google::Cloud::Monitoring::V3::AlertPolicyService::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/monitoring/v3/alert_policy_service/client.rb, line 115 def configure yield @config if block_given? @config end
Creates a new alerting policy.
@overload create_alert_policy
(request, options = nil)
Pass arguments to `create_alert_policy` via a request object, either of type {::Google::Cloud::Monitoring::V3::CreateAlertPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::Monitoring::V3::CreateAlertPolicyRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_alert_policy
(name: nil, alert_policy: nil)
Pass arguments to `create_alert_policy` 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). @param name [::String] Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a workspace, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the container. @param alert_policy [::Google::Cloud::Monitoring::V3::AlertPolicy, ::Hash] Required. The requested alerting policy. You should omit the `name` field in this policy. The name will be returned in the new policy, including a new `[ALERT_POLICY_ID]` value.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Monitoring::V3::AlertPolicy] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Monitoring::V3::AlertPolicy]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/monitoring/v3/alert_policy_service/client.rb, line 385 def create_alert_policy request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_alert_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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 metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_alert_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.create_alert_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @alert_policy_service_stub.call_rpc :create_alert_policy, request, options: 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
Deletes an alerting policy.
@overload delete_alert_policy
(request, options = nil)
Pass arguments to `delete_alert_policy` via a request object, either of type {::Google::Cloud::Monitoring::V3::DeleteAlertPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::Monitoring::V3::DeleteAlertPolicyRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_alert_policy
(name: nil)
Pass arguments to `delete_alert_policy` 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). @param name [::String] Required. The alerting policy to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] For more information, see {::Google::Cloud::Monitoring::V3::AlertPolicy AlertPolicy}.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Protobuf::Empty]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/monitoring/v3/alert_policy_service/client.rb, line 457 def delete_alert_policy request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_alert_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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 metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_alert_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_alert_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @alert_policy_service_stub.call_rpc :delete_alert_policy, request, options: 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
Gets a single alerting policy.
@overload get_alert_policy
(request, options = nil)
Pass arguments to `get_alert_policy` via a request object, either of type {::Google::Cloud::Monitoring::V3::GetAlertPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::Monitoring::V3::GetAlertPolicyRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_alert_policy
(name: nil)
Pass arguments to `get_alert_policy` 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). @param name [::String] Required. The alerting policy to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Monitoring::V3::AlertPolicy] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Monitoring::V3::AlertPolicy]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/monitoring/v3/alert_policy_service/client.rb, line 302 def get_alert_policy request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_alert_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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 metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_alert_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.get_alert_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @alert_policy_service_stub.call_rpc :get_alert_policy, request, options: 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
Lists the existing alerting policies for the workspace.
@overload list_alert_policies
(request, options = nil)
Pass arguments to `list_alert_policies` via a request object, either of type {::Google::Cloud::Monitoring::V3::ListAlertPoliciesRequest} or an equivalent Hash. @param request [::Google::Cloud::Monitoring::V3::ListAlertPoliciesRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_alert_policies
(name: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil)
Pass arguments to `list_alert_policies` 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). @param name [::String] Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) whose alert policies are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the {::Google::Cloud::Monitoring::V3::AlertPolicyService::Client#get_alert_policy GetAlertPolicy} operation, instead. @param filter [::String] If provided, this field specifies the criteria that must be met by alert policies to be included in the response. For more details, see [sorting and filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). @param order_by [::String] A comma-separated list of fields by which to sort the result. Supports the same set of field references as the `filter` field. Entries can be prefixed with a minus sign to sort by the field in descending order. For more details, see [sorting and filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). @param page_size [::Integer] The maximum number of results to return in a single response. @param page_token [::String] If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::AlertPolicy>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::AlertPolicy>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/monitoring/v3/alert_policy_service/client.rb, line 231 def list_alert_policies request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_alert_policies.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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 metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_alert_policies.timeout, metadata: metadata, retry_policy: @config.rpcs.list_alert_policies.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @alert_policy_service_stub.call_rpc :list_alert_policies, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @alert_policy_service_stub, :list_alert_policies, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
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.
@overload update_alert_policy
(request, options = nil)
Pass arguments to `update_alert_policy` via a request object, either of type {::Google::Cloud::Monitoring::V3::UpdateAlertPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::Monitoring::V3::UpdateAlertPolicyRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_alert_policy
(update_mask: nil, alert_policy: nil)
Pass arguments to `update_alert_policy` 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). @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (`alert_policy`), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value. Examples of valid field masks include `display_name`, `documentation`, `documentation.content`, `documentation.mime_type`, `user_labels`, `user_label.nameofkey`, `enabled`, `conditions`, `combiner`, etc. If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following: + The new policy will have the same `[ALERT_POLICY_ID]` as the former policy. This gives you continuity with the former policy in your notifications and incidents. + Conditions in the new policy will keep their former `[CONDITION_ID]` if the supplied condition includes the `name` field with that `[CONDITION_ID]`. If the supplied condition omits the `name` field, then a new `[CONDITION_ID]` is created. @param alert_policy [::Google::Cloud::Monitoring::V3::AlertPolicy, ::Hash] Required. The updated alerting policy or the updated values for the fields listed in `update_mask`. If `update_mask` is not empty, any fields in this policy that are not in `update_mask` are ignored.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Monitoring::V3::AlertPolicy] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Monitoring::V3::AlertPolicy]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/monitoring/v3/alert_policy_service/client.rb, line 553 def update_alert_policy request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_alert_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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 metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_alert_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.update_alert_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @alert_policy_service_stub.call_rpc :update_alert_policy, request, options: 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