Class: Google::Apis::MonitoringV3::AlertPolicy

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/monitoring_v3/classes.rb,
generated/google/apis/monitoring_v3/representations.rb,
generated/google/apis/monitoring_v3/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AlertPolicy

Returns a new instance of AlertPolicy.


210
211
212
# File 'generated/google/apis/monitoring_v3/classes.rb', line 210

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#combinerString

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

Returns:

  • (String)

128
129
130
# File 'generated/google/apis/monitoring_v3/classes.rb', line 128

def combiner
  @combiner
end

#conditionsArray<Google::Apis::MonitoringV3::Condition>

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


136
137
138
# File 'generated/google/apis/monitoring_v3/classes.rb', line 136

def conditions
  @conditions
end

#creation_recordGoogle::Apis::MonitoringV3::MutationRecord

Describes a change made to a configuration. Corresponds to the JSON property creationRecord


141
142
143
# File 'generated/google/apis/monitoring_v3/classes.rb', line 141

def creation_record
  @creation_record
end

#display_nameString

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

Returns:

  • (String)

149
150
151
# File 'generated/google/apis/monitoring_v3/classes.rb', line 149

def display_name
  @display_name
end

#documentationGoogle::Apis::MonitoringV3::Documentation

A content string and a MIME type that describes the content string's format. Corresponds to the JSON property documentation


154
155
156
# File 'generated/google/apis/monitoring_v3/classes.rb', line 154

def documentation
  @documentation
end

#enabledBoolean Also known as: enabled?

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

Returns:

  • (Boolean)

163
164
165
# File 'generated/google/apis/monitoring_v3/classes.rb', line 163

def enabled
  @enabled
end

#mutation_recordGoogle::Apis::MonitoringV3::MutationRecord

Describes a change made to a configuration. Corresponds to the JSON property mutationRecord


169
170
171
# File 'generated/google/apis/monitoring_v3/classes.rb', line 169

def mutation_record
  @mutation_record
end

#nameString

Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [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

Returns:

  • (String)

179
180
181
# File 'generated/google/apis/monitoring_v3/classes.rb', line 179

def name
  @name
end

#notification_channelsArray<String>

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/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] Corresponds to the JSON property notificationChannels

Returns:

  • (Array<String>)

189
190
191
# File 'generated/google/apis/monitoring_v3/classes.rb', line 189

def notification_channels
  @notification_channels
end

#user_labelsHash<String,String>

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

Returns:

  • (Hash<String,String>)

198
199
200
# File 'generated/google/apis/monitoring_v3/classes.rb', line 198

def user_labels
  @user_labels
end

#validityGoogle::Apis::MonitoringV3::Status

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 (https://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 (https://cloud. google.com/apis/design/errors). Corresponds to the JSON property validity


208
209
210
# File 'generated/google/apis/monitoring_v3/classes.rb', line 208

def validity
  @validity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'generated/google/apis/monitoring_v3/classes.rb', line 215

def update!(**args)
  @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