Class: Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoWorkflowAlertConfig
- Inherits:
-
Object
- Object
- Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoWorkflowAlertConfig
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/integrations_v1/classes.rb,
lib/google/apis/integrations_v1/representations.rb,
lib/google/apis/integrations_v1/representations.rb
Overview
Message to be used to configure custom alerting in the @code EventConfig
protos for an event.
Instance Attribute Summary collapse
-
#aggregation_period ⇒ String
For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
-
#alert_disabled ⇒ Boolean
(also: #alert_disabled?)
Set to false by default.
-
#alert_name ⇒ String
A name to identify this alert.
-
#client_id ⇒ String
Client associated with this alert configuration.
-
#duration_threshold_ms ⇒ Fixnum
Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics.
-
#error_enum_list ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList
List of error enums for alerts.
-
#metric_type ⇒ String
Corresponds to the JSON property
metricType
. -
#num_aggregation_periods ⇒ Fixnum
For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
-
#only_final_attempt ⇒ Boolean
(also: #only_final_attempt?)
For either events or tasks, depending on the type of alert, count only final attempts, not retries.
-
#playbook_url ⇒ String
Link to a playbook for resolving the issue that triggered this alert.
-
#threshold_type ⇒ String
The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured.
-
#threshold_value ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue
The threshold value of the metric, above or below which the alert should be triggered.
-
#warning_enum_list ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList
List of error enums for alerts.
Instance Method Summary collapse
-
#initialize(**args) ⇒ EnterpriseCrmEventbusProtoWorkflowAlertConfig
constructor
A new instance of EnterpriseCrmEventbusProtoWorkflowAlertConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ EnterpriseCrmEventbusProtoWorkflowAlertConfig
Returns a new instance of EnterpriseCrmEventbusProtoWorkflowAlertConfig.
3478 3479 3480 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3478 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
3398 3399 3400 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3398 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
3404 3405 3406 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3404 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
3411 3412 3413 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3411 def alert_name @alert_name end |
#client_id ⇒ String
Client associated with this alert configuration.
Corresponds to the JSON property clientId
3416 3417 3418 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3416 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
3423 3424 3425 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3423 def duration_threshold_ms @duration_threshold_ms end |
#error_enum_list ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList
List of error enums for alerts.
Corresponds to the JSON property errorEnumList
3428 3429 3430 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3428 def error_enum_list @error_enum_list end |
#metric_type ⇒ String
Corresponds to the JSON property metricType
3433 3434 3435 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3433 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
3439 3440 3441 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3439 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
3445 3446 3447 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3445 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
3451 3452 3453 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3451 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
3458 3459 3460 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3458 def threshold_type @threshold_type end |
#threshold_value ⇒ Google::Apis::IntegrationsV1::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.
Corresponds to the JSON property thresholdValue
3471 3472 3473 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3471 def threshold_value @threshold_value end |
#warning_enum_list ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList
List of error enums for alerts.
Corresponds to the JSON property warningEnumList
3476 3477 3478 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3476 def warning_enum_list @warning_enum_list end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 |
# File 'lib/google/apis/integrations_v1/classes.rb', line 3483 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 |