class Google::Apis::MonitoringV3::AlertPolicy

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. For an overview of alert policies, see Introduction to Alerting ( cloud.google.com/monitoring/alerts/).

Attributes

alert_strategy[RW]

Control over how the notification channels in notification_channels are notified when this alert fires. Corresponds to the JSON property `alertStrategy` @return [Google::Apis::MonitoringV3::AlertStrategy]

combiner[RW]

How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED. Corresponds to the JSON property `combiner` @return [String]

conditions[RW]

A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition. Corresponds to the JSON property `conditions` @return [Array<Google::Apis::MonitoringV3::Condition>]

creation_record[RW]

Describes a change made to a configuration. Corresponds to the JSON property `creationRecord` @return [Google::Apis::MonitoringV3::MutationRecord]

display_name[RW]

A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters. Corresponds to the JSON property `displayName` @return [String]

documentation[RW]

A content string and a MIME type that describes the content string's format. Corresponds to the JSON property `documentation` @return [Google::Apis::MonitoringV3::Documentation]

enabled[RW]

Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. Corresponds to the JSON property `enabled` @return [Boolean]

enabled?[RW]

Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. Corresponds to the JSON property `enabled` @return [Boolean]

mutation_record[RW]

Describes a change made to a configuration. Corresponds to the JSON property `mutationRecord` @return [Google::Apis::MonitoringV3::MutationRecord]

name[RW]

Required if the policy exists. The resource name for this policy. The format is: projects//alertPolicies/ [ ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. Corresponds to the JSON property `name` @return [String]

notification_channels[RW]

Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects//notificationChannels/ Corresponds to the JSON property `notificationChannels` @return [Array<String>]

user_labels[RW]

User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. Corresponds to the JSON property `userLabels` @return [Hash<String,String>]

validity[RW]

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (cloud. google.com/apis/design/errors). Corresponds to the JSON property `validity` @return [Google::Apis::MonitoringV3::Status]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/monitoring_v3/classes.rb, line 218
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/monitoring_v3/classes.rb, line 223
def update!(**args)
  @alert_strategy = args[:alert_strategy] if args.key?(:alert_strategy)
  @combiner = args[:combiner] if args.key?(:combiner)
  @conditions = args[:conditions] if args.key?(:conditions)
  @creation_record = args[:creation_record] if args.key?(:creation_record)
  @display_name = args[:display_name] if args.key?(:display_name)
  @documentation = args[:documentation] if args.key?(:documentation)
  @enabled = args[:enabled] if args.key?(:enabled)
  @mutation_record = args[:mutation_record] if args.key?(:mutation_record)
  @name = args[:name] if args.key?(:name)
  @notification_channels = args[:notification_channels] if args.key?(:notification_channels)
  @user_labels = args[:user_labels] if args.key?(:user_labels)
  @validity = args[:validity] if args.key?(:validity)
end