Class: Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoTaskAlertConfig

Inherits:
Object
  • Object
show all
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 alerting in the @code TaskConfig protos for tasks in an event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseCrmEventbusProtoTaskAlertConfig

Returns a new instance of EnterpriseCrmEventbusProtoTaskAlertConfig.



2863
2864
2865
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2863

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) 


2784
2785
2786
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2784

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) 


2790
2791
2792
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2790

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) 


2797
2798
2799
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2797

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) 


2803
2804
2805
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2803

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) 


2810
2811
2812
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2810

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

Returns:



2815
2816
2817
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2815

def error_enum_list
  @error_enum_list
end

#metric_type ⇒ String

Corresponds to the JSON property metricType

Returns:

  • (String) 


2820
2821
2822
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2820

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) 


2826
2827
2828
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2826

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) 


2831
2832
2833
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2831

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) 


2837
2838
2839
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2837

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) 


2843
2844
2845
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2843

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

Returns:



2856
2857
2858
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2856

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

Returns:



2861
2862
2863
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2861

def warning_enum_list
  @warning_enum_list
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2868

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