Class: Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoTaskAlertConfig

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 alerting in the @code TaskConfig protos for tasks in 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) ⇒ EnterpriseCrmEventbusProtoTaskAlertConfig

Returns a new instance of EnterpriseCrmEventbusProtoTaskAlertConfig.



2825
2826
2827
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2825

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

Instance Attribute Details

#aggregation_period ⇒ String

The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). Corresponds to the JSON property aggregationPeriod

Returns:

  • (String) 


2746
2747
2748
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2746

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) 


2752
2753
2754
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2752

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 in within the scope of the containing workflow. Corresponds to the JSON property alertName

Returns:

  • (String) 


2759
2760
2761
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2759

def alert_name
  @alert_name
end

#client_id ⇒ String

Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers. Corresponds to the JSON property clientId

Returns:

  • (String) 


2765
2766
2767
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2765

def client_id
  @client_id
end

#duration_threshold_ms ⇒ Fixnum

Should be specified only for TASK_AVERAGE_DURATION and TASK_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) 


2772
2773
2774
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2772

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:



2777
2778
2779
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2777

def error_enum_list
  @error_enum_list
end

#metric_type ⇒ String

Corresponds to the JSON property metricType

Returns:

  • (String) 


2782
2783
2784
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2782

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) 


2788
2789
2790
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2788

def num_aggregation_periods
  @num_aggregation_periods
end

#only_final_attempt ⇒ Boolean Also known as: only_final_attempt?

Only count final task attempts, not retries. Corresponds to the JSON property onlyFinalAttempt

Returns:

  • (Boolean) 


2793
2794
2795
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2793

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) 


2799
2800
2801
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2799

def playbook_url
  @playbook_url
end

#threshold_type ⇒ String

The threshold type 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) 


2805
2806
2807
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2805

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:



2818
2819
2820
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2818

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:



2823
2824
2825
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2823

def warning_enum_list
  @warning_enum_list
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2830

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