Class: Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoWorkflowAlertConfig

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

Overview

Message to be used to configure custom alerting in the @code EventConfig protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseCrmEventbusProtoWorkflowAlertConfig

Returns a new instance of EnterpriseCrmEventbusProtoWorkflowAlertConfig.



3265
3266
3267
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3265

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

Instance Attribute Details

#aggregation_period ⇒ String

For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. Corresponds to the JSON property aggregationPeriod

Returns:

  • (String) 


3185
3186
3187
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3185

def aggregation_period
  @aggregation_period
end

#alert_disabled ⇒ Boolean Also known as: alert_disabled?

Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. Corresponds to the JSON property alertDisabled

Returns:

  • (Boolean) 


3191
3192
3193
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3191

def alert_disabled
  @alert_disabled
end

#alert_name ⇒ String

A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. Corresponds to the JSON property alertName

Returns:

  • (String) 


3198
3199
3200
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3198

def alert_name
  @alert_name
end

#client_id ⇒ String

Client associated with this alert configuration. Corresponds to the JSON property clientId

Returns:

  • (String) 


3203
3204
3205
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3203

def client_id
  @client_id
end

#duration_threshold_ms ⇒ Fixnum

Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger. Corresponds to the JSON property durationThresholdMs

Returns:

  • (Fixnum) 


3210
3211
3212
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3210

def duration_threshold_ms
  @duration_threshold_ms
end

#error_enum_list ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList

List of error enums for alerts. Corresponds to the JSON property errorEnumList

Returns:



3215
3216
3217
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3215

def error_enum_list
  @error_enum_list
end

#metric_type ⇒ String

Corresponds to the JSON property metricType

Returns:

  • (String) 


3220
3221
3222
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3220

def metric_type
  @metric_type
end

#num_aggregation_periods ⇒ Fixnum

For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired. Corresponds to the JSON property numAggregationPeriods

Returns:

  • (Fixnum) 


3226
3227
3228
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3226

def num_aggregation_periods
  @num_aggregation_periods
end

#only_final_attempt ⇒ Boolean Also known as: only_final_attempt?

For either events or tasks, depending on the type of alert, count only final attempts, not retries. Corresponds to the JSON property onlyFinalAttempt

Returns:

  • (Boolean) 


3232
3233
3234
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3232

def only_final_attempt
  @only_final_attempt
end

#playbook_url ⇒ String

Link to a playbook for resolving the issue that triggered this alert. Corresponds to the JSON property playbookUrl

Returns:

  • (String) 


3238
3239
3240
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3238

def playbook_url
  @playbook_url
end

#threshold_type ⇒ String

The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired. Corresponds to the JSON property thresholdType

Returns:

  • (String) 


3245
3246
3247
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3245

def threshold_type
  @threshold_type
end

#threshold_value ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue

The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For * PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples Corresponds to the JSON property thresholdValue

Returns:



3258
3259
3260
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3258

def threshold_value
  @threshold_value
end

#warning_enum_list ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList

List of error enums for alerts. Corresponds to the JSON property warningEnumList

Returns:



3263
3264
3265
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3263

def warning_enum_list
  @warning_enum_list
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 3270

def update!(**args)
  @aggregation_period = args[:aggregation_period] if args.key?(:aggregation_period)
  @alert_disabled = args[:alert_disabled] if args.key?(:alert_disabled)
  @alert_name = args[:alert_name] if args.key?(:alert_name)
  @client_id = args[:client_id] if args.key?(:client_id)
  @duration_threshold_ms = args[:duration_threshold_ms] if args.key?(:duration_threshold_ms)
  @error_enum_list = args[:error_enum_list] if args.key?(:error_enum_list)
  @metric_type = args[:metric_type] if args.key?(:metric_type)
  @num_aggregation_periods = args[:num_aggregation_periods] if args.key?(:num_aggregation_periods)
  @only_final_attempt = args[:only_final_attempt] if args.key?(:only_final_attempt)
  @playbook_url = args[:playbook_url] if args.key?(:playbook_url)
  @threshold_type = args[:threshold_type] if args.key?(:threshold_type)
  @threshold_value = args[:threshold_value] if args.key?(:threshold_value)
  @warning_enum_list = args[:warning_enum_list] if args.key?(:warning_enum_list)
end