com.google.api.services.integrations.v1alpha.model.EnterpriseCrmEventbusProtoTaskAlertConfig Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.integrations.v1alpha.model;
/**
* 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.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Application Integration API. For a detailed
* explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class EnterpriseCrmEventbusProtoTaskAlertConfig extends com.google.api.client.json.GenericJson {
/**
* 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).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String aggregationPeriod;
/**
* Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch
* for this workflow alert.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean alertDisabled;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String alertName;
/**
* Client associated with this alert configuration. Must be a client enabled in one of the
* containing workflow's triggers.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String clientId;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long durationThresholdMs;
/**
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList errorEnumList;
/**
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String metricType;
/**
* For how many contiguous aggregation periods should the expected min or max be violated for the
* alert to be fired.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer numAggregationPeriods;
/**
* Only count final task attempts, not retries.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean onlyFinalAttempt;
/**
* Link to a playbook for resolving the issue that triggered this alert.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String playbookUrl;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String thresholdType;
/**
* The metric value, above or below which the alert should be triggered.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue thresholdValue;
/**
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList warningEnumList;
/**
* 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).
* @return value or {@code null} for none
*/
public java.lang.String getAggregationPeriod() {
return aggregationPeriod;
}
/**
* 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).
* @param aggregationPeriod aggregationPeriod or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setAggregationPeriod(java.lang.String aggregationPeriod) {
this.aggregationPeriod = aggregationPeriod;
return this;
}
/**
* Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch
* for this workflow alert.
* @return value or {@code null} for none
*/
public java.lang.Boolean getAlertDisabled() {
return alertDisabled;
}
/**
* Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch
* for this workflow alert.
* @param alertDisabled alertDisabled or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setAlertDisabled(java.lang.Boolean alertDisabled) {
this.alertDisabled = alertDisabled;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getAlertName() {
return alertName;
}
/**
* 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.
* @param alertName alertName or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setAlertName(java.lang.String alertName) {
this.alertName = alertName;
return this;
}
/**
* Client associated with this alert configuration. Must be a client enabled in one of the
* containing workflow's triggers.
* @return value or {@code null} for none
*/
public java.lang.String getClientId() {
return clientId;
}
/**
* Client associated with this alert configuration. Must be a client enabled in one of the
* containing workflow's triggers.
* @param clientId clientId or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setClientId(java.lang.String clientId) {
this.clientId = clientId;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.Long getDurationThresholdMs() {
return durationThresholdMs;
}
/**
* 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.
* @param durationThresholdMs durationThresholdMs or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setDurationThresholdMs(java.lang.Long durationThresholdMs) {
this.durationThresholdMs = durationThresholdMs;
return this;
}
/**
* @return value or {@code null} for none
*/
public EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList getErrorEnumList() {
return errorEnumList;
}
/**
* @param errorEnumList errorEnumList or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setErrorEnumList(EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList errorEnumList) {
this.errorEnumList = errorEnumList;
return this;
}
/**
* @return value or {@code null} for none
*/
public java.lang.String getMetricType() {
return metricType;
}
/**
* @param metricType metricType or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setMetricType(java.lang.String metricType) {
this.metricType = metricType;
return this;
}
/**
* For how many contiguous aggregation periods should the expected min or max be violated for the
* alert to be fired.
* @return value or {@code null} for none
*/
public java.lang.Integer getNumAggregationPeriods() {
return numAggregationPeriods;
}
/**
* For how many contiguous aggregation periods should the expected min or max be violated for the
* alert to be fired.
* @param numAggregationPeriods numAggregationPeriods or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setNumAggregationPeriods(java.lang.Integer numAggregationPeriods) {
this.numAggregationPeriods = numAggregationPeriods;
return this;
}
/**
* Only count final task attempts, not retries.
* @return value or {@code null} for none
*/
public java.lang.Boolean getOnlyFinalAttempt() {
return onlyFinalAttempt;
}
/**
* Only count final task attempts, not retries.
* @param onlyFinalAttempt onlyFinalAttempt or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setOnlyFinalAttempt(java.lang.Boolean onlyFinalAttempt) {
this.onlyFinalAttempt = onlyFinalAttempt;
return this;
}
/**
* Link to a playbook for resolving the issue that triggered this alert.
* @return value or {@code null} for none
*/
public java.lang.String getPlaybookUrl() {
return playbookUrl;
}
/**
* Link to a playbook for resolving the issue that triggered this alert.
* @param playbookUrl playbookUrl or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setPlaybookUrl(java.lang.String playbookUrl) {
this.playbookUrl = playbookUrl;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getThresholdType() {
return thresholdType;
}
/**
* 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.
* @param thresholdType thresholdType or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setThresholdType(java.lang.String thresholdType) {
this.thresholdType = thresholdType;
return this;
}
/**
* The metric value, above or below which the alert should be triggered.
* @return value or {@code null} for none
*/
public EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue getThresholdValue() {
return thresholdValue;
}
/**
* The metric value, above or below which the alert should be triggered.
* @param thresholdValue thresholdValue or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setThresholdValue(EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue thresholdValue) {
this.thresholdValue = thresholdValue;
return this;
}
/**
* @return value or {@code null} for none
*/
public EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList getWarningEnumList() {
return warningEnumList;
}
/**
* @param warningEnumList warningEnumList or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskAlertConfig setWarningEnumList(EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList warningEnumList) {
this.warningEnumList = warningEnumList;
return this;
}
@Override
public EnterpriseCrmEventbusProtoTaskAlertConfig set(String fieldName, Object value) {
return (EnterpriseCrmEventbusProtoTaskAlertConfig) super.set(fieldName, value);
}
@Override
public EnterpriseCrmEventbusProtoTaskAlertConfig clone() {
return (EnterpriseCrmEventbusProtoTaskAlertConfig) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy