com.aliyun.sdk.service.ess20220222.models.ModifyAlarmRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of alibabacloud-ess20220222 Show documentation
Show all versions of alibabacloud-ess20220222 Show documentation
Alibaba Cloud Ess (20220222) Async SDK for Java
The newest version!
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sdk.service.ess20220222.models;
import darabonba.core.RequestModel;
import darabonba.core.TeaModel;
import com.aliyun.sdk.gateway.pop.models.*;
/**
*
* {@link ModifyAlarmRequest} extends {@link RequestModel}
*
* ModifyAlarmRequest
*/
public class ModifyAlarmRequest extends Request {
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("AlarmActions")
private java.util.List < String > alarmActions;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("AlarmTaskId")
@com.aliyun.core.annotation.Validation(required = true)
private String alarmTaskId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ComparisonOperator")
private String comparisonOperator;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Description")
private String description;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Dimensions")
private java.util.List < Dimensions> dimensions;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Effective")
private String effective;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("EvaluationCount")
private Integer evaluationCount;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Expressions")
private java.util.List < Expressions> expressions;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ExpressionsLogicOperator")
private String expressionsLogicOperator;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("GroupId")
private Integer groupId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("MetricName")
private String metricName;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("MetricType")
private String metricType;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Name")
private String name;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("OwnerId")
private Long ownerId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Period")
private Integer period;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("RegionId")
@com.aliyun.core.annotation.Validation(required = true)
private String regionId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ResourceOwnerAccount")
private String resourceOwnerAccount;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Statistics")
private String statistics;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Threshold")
private Float threshold;
private ModifyAlarmRequest(Builder builder) {
super(builder);
this.alarmActions = builder.alarmActions;
this.alarmTaskId = builder.alarmTaskId;
this.comparisonOperator = builder.comparisonOperator;
this.description = builder.description;
this.dimensions = builder.dimensions;
this.effective = builder.effective;
this.evaluationCount = builder.evaluationCount;
this.expressions = builder.expressions;
this.expressionsLogicOperator = builder.expressionsLogicOperator;
this.groupId = builder.groupId;
this.metricName = builder.metricName;
this.metricType = builder.metricType;
this.name = builder.name;
this.ownerId = builder.ownerId;
this.period = builder.period;
this.regionId = builder.regionId;
this.resourceOwnerAccount = builder.resourceOwnerAccount;
this.statistics = builder.statistics;
this.threshold = builder.threshold;
}
public static Builder builder() {
return new Builder();
}
public static ModifyAlarmRequest create() {
return builder().build();
}
@Override
public Builder toBuilder() {
return new Builder(this);
}
/**
* @return alarmActions
*/
public java.util.List < String > getAlarmActions() {
return this.alarmActions;
}
/**
* @return alarmTaskId
*/
public String getAlarmTaskId() {
return this.alarmTaskId;
}
/**
* @return comparisonOperator
*/
public String getComparisonOperator() {
return this.comparisonOperator;
}
/**
* @return description
*/
public String getDescription() {
return this.description;
}
/**
* @return dimensions
*/
public java.util.List < Dimensions> getDimensions() {
return this.dimensions;
}
/**
* @return effective
*/
public String getEffective() {
return this.effective;
}
/**
* @return evaluationCount
*/
public Integer getEvaluationCount() {
return this.evaluationCount;
}
/**
* @return expressions
*/
public java.util.List < Expressions> getExpressions() {
return this.expressions;
}
/**
* @return expressionsLogicOperator
*/
public String getExpressionsLogicOperator() {
return this.expressionsLogicOperator;
}
/**
* @return groupId
*/
public Integer getGroupId() {
return this.groupId;
}
/**
* @return metricName
*/
public String getMetricName() {
return this.metricName;
}
/**
* @return metricType
*/
public String getMetricType() {
return this.metricType;
}
/**
* @return name
*/
public String getName() {
return this.name;
}
/**
* @return ownerId
*/
public Long getOwnerId() {
return this.ownerId;
}
/**
* @return period
*/
public Integer getPeriod() {
return this.period;
}
/**
* @return regionId
*/
public String getRegionId() {
return this.regionId;
}
/**
* @return resourceOwnerAccount
*/
public String getResourceOwnerAccount() {
return this.resourceOwnerAccount;
}
/**
* @return statistics
*/
public String getStatistics() {
return this.statistics;
}
/**
* @return threshold
*/
public Float getThreshold() {
return this.threshold;
}
public static final class Builder extends Request.Builder {
private java.util.List < String > alarmActions;
private String alarmTaskId;
private String comparisonOperator;
private String description;
private java.util.List < Dimensions> dimensions;
private String effective;
private Integer evaluationCount;
private java.util.List < Expressions> expressions;
private String expressionsLogicOperator;
private Integer groupId;
private String metricName;
private String metricType;
private String name;
private Long ownerId;
private Integer period;
private String regionId;
private String resourceOwnerAccount;
private String statistics;
private Float threshold;
private Builder() {
super();
}
private Builder(ModifyAlarmRequest request) {
super(request);
this.alarmActions = request.alarmActions;
this.alarmTaskId = request.alarmTaskId;
this.comparisonOperator = request.comparisonOperator;
this.description = request.description;
this.dimensions = request.dimensions;
this.effective = request.effective;
this.evaluationCount = request.evaluationCount;
this.expressions = request.expressions;
this.expressionsLogicOperator = request.expressionsLogicOperator;
this.groupId = request.groupId;
this.metricName = request.metricName;
this.metricType = request.metricType;
this.name = request.name;
this.ownerId = request.ownerId;
this.period = request.period;
this.regionId = request.regionId;
this.resourceOwnerAccount = request.resourceOwnerAccount;
this.statistics = request.statistics;
this.threshold = request.threshold;
}
/**
* The list of unique identifiers of the scaling rules that are associated with the event-triggered task.
*/
public Builder alarmActions(java.util.List < String > alarmActions) {
this.putQueryParameter("AlarmActions", alarmActions);
this.alarmActions = alarmActions;
return this;
}
/**
* The ID of the event-triggered task.
* This parameter is required.
*
* example:
* asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****
*/
public Builder alarmTaskId(String alarmTaskId) {
this.putQueryParameter("AlarmTaskId", alarmTaskId);
this.alarmTaskId = alarmTaskId;
return this;
}
/**
* The operator that is used to compare the metric value and the threshold. Valid values:
*
* - If the metric value is greater than or equal to the threshold, set the value to
>=.
* - If the metric value is less than or equal to the threshold, set the value to
<=.
* - If the metric value is greater than the threshold, set the value to
>.
* - If the metric value is less than the threshold, set the value to
<.
*
*
* example:
*
* =
*
*/
public Builder comparisonOperator(String comparisonOperator) {
this.putQueryParameter("ComparisonOperator", comparisonOperator);
this.comparisonOperator = comparisonOperator;
return this;
}
/**
* The description of the event-triggered task.
*
* example:
* Test alarm task.
*/
public Builder description(String description) {
this.putQueryParameter("Description", description);
this.description = description;
return this;
}
/**
* Details of the dimensions.
*/
public Builder dimensions(java.util.List < Dimensions> dimensions) {
this.putQueryParameter("Dimensions", dimensions);
this.dimensions = dimensions;
return this;
}
/**
* The effective period of the event-triggered task.
* This parameter follows the cron expression format. The default format is X X X X X ?, in which:
*
* - X: a placeholder for a field, which represents seconds, minutes, hours, days, and months in sequence. X can be a definite value or a special character that has logical meaning. For information about the valid values of X, see Cron expression.
* - ?: No value is specified.
*
*
* By default, the value of this parameter is specified in UTC+8. You can specify the time zone in the TZ=+yy format before a cron expression. y indicates the time zone. For example, TZ=+00 * * 1-2 * * ? specifies that the event-triggered task is in effect between 01:00 and 02:59 (UTC+0) every day.
*
* Examples:
*
* * * * * * ? : The event-triggered task is in effect all the time.* * 17-18 * * ? : The event-triggered task is in effect between 17:00 and 18:59 (UTC+8) every day.TZ=+00 * * 1-2 * * ?: The event-triggered task is in effect between 01:00 and 02:59 (UTC+0) every day.
*
* example:
* TZ=+00 * * 1-2 * * ?
*/
public Builder effective(String effective) {
this.putQueryParameter("Effective", effective);
this.effective = effective;
return this;
}
/**
* The number of times that the threshold must be reached before a scaling rule can be executed. For example, if you set this parameter to 3, the average CPU utilization must reach or exceed 80% three times in a row before a scaling rule is triggered.
*
* example:
* 3
*/
public Builder evaluationCount(Integer evaluationCount) {
this.putQueryParameter("EvaluationCount", evaluationCount);
this.evaluationCount = evaluationCount;
return this;
}
/**
* The expressions that are specified in the multi-metric alert rule.
*/
public Builder expressions(java.util.List < Expressions> expressions) {
this.putQueryParameter("Expressions", expressions);
this.expressions = expressions;
return this;
}
/**
* The relationship between the trigger conditions in the multi-metric alert rule. Valid values:
*
* &&: An alert is triggered only if all metrics in the multi-metric alert rule meet the trigger conditions. In this case, an alert is triggered only if the results of all trigger conditions that are specified in the multi-metric alert rule are true.||: An alert is triggered if one of the metrics in the multi-metric alert rule meets the trigger condition.
* Default value: &&.
*
* example:
* &&
*/
public Builder expressionsLogicOperator(String expressionsLogicOperator) {
this.putQueryParameter("ExpressionsLogicOperator", expressionsLogicOperator);
this.expressionsLogicOperator = expressionsLogicOperator;
return this;
}
/**
* The ID of the application group to which the custom metric belongs. If you set the MetricType parameter to custom, you must specify this parameter.
*
* example:
* 4055401
*/
public Builder groupId(Integer groupId) {
this.putQueryParameter("GroupId", groupId);
this.groupId = groupId;
return this;
}
/**
* The name of the metric. The valid values vary based on the metric type.
*
* If you set the MetricType parameter to custom, the valid values are your custom metrics.
* If you set the MetricType parameter to system, the MetricName parameter has the following valid values:
*
* - CpuUtilization: the CPU utilization of an ECS instance. Unit: %.
* - IntranetTx: the outbound traffic over the internal network from an ECS instance. Unit: KB/min.
* - IntranetRx: the inbound traffic over the Internet to an ECS instance that resides in a virtual private cloud (VPC). Unit: KB/min.
* - VpcInternetTx: the outbound traffic over the Internet from an ECS instance that resides in a VPC. Unit: KB/min.
* - VpcInternetRx: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.
* - SystemDiskReadBps: the number of bytes read from the system disk used by an ECS instance per second.
* - SystemDiskWriteBps: the number of bytes written to the system disk used by an ECS instance per second.
* - SystemDiskReadOps: the number of read operations on the system disk used by an ECS instance per second.
* - SystemDiskWriteOps: the number of write operations on the system disk used by an ECS instance per second.
* - CpuUtilizationAgent: the CPU utilization of an agent. Unit: %.
* - GpuMemoryFreeUtilizationAgent: the percentage of idle GPU memory of an agent.
* - GpuMemoryUtilizationAgent: the GPU memory usage of an agent. Unit: %.
* - MemoryUtilization: the memory usage of an agent. Unit: %.
* - LoadAverage: the average system load of an agent.
* - TcpConnection: the total number of TCP connections of an agent.
* - TcpConnection: the number of established TCP connections of an agent.
* - PackagesNetOut: the number of packets that are sent by the internal network interface controller (NIC) used by an agent.
* - PackagesNetIn: the number of packets that are received by the internal NIC used by an agent.
* - EciPodCpuUtilization: the CPU utilization of an elastic container instance. Unit: %.
* - EciPodMemoryUtilization: the memory usage of an elastic container instance. Unit: %.
*
*
* For more information, see Event-triggered task for system monitoring.
*
* example:
* MemoryUtilization
*/
public Builder metricName(String metricName) {
this.putQueryParameter("MetricName", metricName);
this.metricName = metricName;
return this;
}
/**
* The type of the metric. Valid values:
*
* - system: system metrics of CloudMonitor
* - custom: custom metrics that are reported to CloudMonitor
*
*
* example:
* system
*/
public Builder metricType(String metricType) {
this.putQueryParameter("MetricType", metricType);
this.metricType = metricType;
return this;
}
/**
* The name of the event-triggered task.
*
* example:
* alarmtask****
*/
public Builder name(String name) {
this.putQueryParameter("Name", name);
this.name = name;
return this;
}
/**
* OwnerId.
*/
public Builder ownerId(Long ownerId) {
this.putQueryParameter("OwnerId", ownerId);
this.ownerId = ownerId;
return this;
}
/**
* The period of time during which statistics about the metric is collected. Unit: seconds. Valid values:
*
* - 15
* - 60
* - 120
* - 300
* - 900
*
*
* If your scaling group is of the ECS type and uses CloudMonitor metrics, you can set the Period parameter to 15. In other cases, you can set the Period parameter to 60, 120, 300, or 900. In most cases, the name of a CloudMonitor metric contains Agent.
*
*
* example:
* 300
*/
public Builder period(Integer period) {
this.putQueryParameter("Period", period);
this.period = period;
return this;
}
/**
* The region ID of the event-triggered task.
* This parameter is required.
*
* example:
* cn-qingdao
*/
public Builder regionId(String regionId) {
this.putQueryParameter("RegionId", regionId);
this.regionId = regionId;
return this;
}
/**
* ResourceOwnerAccount.
*/
public Builder resourceOwnerAccount(String resourceOwnerAccount) {
this.putQueryParameter("ResourceOwnerAccount", resourceOwnerAccount);
this.resourceOwnerAccount = resourceOwnerAccount;
return this;
}
/**
* The method that is used to aggregate statistics for the metric. Valid values:
*
* - Average
* - Minimum
* - Maximum
*
*
* example:
* Average
*/
public Builder statistics(String statistics) {
this.putQueryParameter("Statistics", statistics);
this.statistics = statistics;
return this;
}
/**
* The thresholds of the metric values in the multi-metric alert rule. If the thresholds are reached the specified number of times within the specified period, a scaling rule is executed.
*
* example:
* 80
*/
public Builder threshold(Float threshold) {
this.putQueryParameter("Threshold", threshold);
this.threshold = threshold;
return this;
}
@Override
public ModifyAlarmRequest build() {
return new ModifyAlarmRequest(this);
}
}
/**
*
* {@link ModifyAlarmRequest} extends {@link TeaModel}
*
* ModifyAlarmRequest
*/
public static class Dimensions extends TeaModel {
@com.aliyun.core.annotation.NameInMap("DimensionKey")
private String dimensionKey;
@com.aliyun.core.annotation.NameInMap("DimensionValue")
private String dimensionValue;
private Dimensions(Builder builder) {
this.dimensionKey = builder.dimensionKey;
this.dimensionValue = builder.dimensionValue;
}
public static Builder builder() {
return new Builder();
}
public static Dimensions create() {
return builder().build();
}
/**
* @return dimensionKey
*/
public String getDimensionKey() {
return this.dimensionKey;
}
/**
* @return dimensionValue
*/
public String getDimensionValue() {
return this.dimensionValue;
}
public static final class Builder {
private String dimensionKey;
private String dimensionValue;
/**
* The key of the dimension. The valid values vary based on the metric type.
*
* If you set the MetricType parameter to custom, you can specify this parameter based on your business requirements.
* If you set the MetricType parameter to system, this parameter has the following valid values:
*
* - user_id: the ID of your Alibaba Cloud account
* - scaling_group: the scaling group that you want to monitor
* - device: the type of the NIC
* - state: the status of the TCP connection
*
*
*
* example:
* device
*/
public Builder dimensionKey(String dimensionKey) {
this.dimensionKey = dimensionKey;
return this;
}
/**
* The value of the dimension. The valid values vary based on the value of the DimensionKey parameter.
*
* If you set the MetricType parameter to custom, you can specify this parameter based on your business requirements.
* If you set the MetricType parameter to system, this parameter has the following valid values:
*
* If you set the DimensionKey parameter to user_id, the system specifies the value
* scaling_group: The system specifies the value of the DimensionValue parameter.
* If you set the DimensionKey parameter to device, you can set the DimensionValue parameter to eth0 or eth1.
*
* - For instances that reside in the classic network type, eth0 specifies the internal NIC. Only one eth0 NIC exists on each instance that resides in a VPC.
* - For instances that reside in the classic network, eth1 specifies the public NIC.
*
* If you set the DimensionKey parameter to state, you can set the DimensionValue parameter to TCP_TOTAL or ESTABLISHED.
*
* - TCP_TOTAL specifies the total number of TCP connections.
* - ESTABLISHED specifies the number of established TCP connections.
*
*
*
*
* example:
* eth0
*/
public Builder dimensionValue(String dimensionValue) {
this.dimensionValue = dimensionValue;
return this;
}
public Dimensions build() {
return new Dimensions(this);
}
}
}
/**
*
* {@link ModifyAlarmRequest} extends {@link TeaModel}
*
* ModifyAlarmRequest
*/
public static class Expressions extends TeaModel {
@com.aliyun.core.annotation.NameInMap("ComparisonOperator")
private String comparisonOperator;
@com.aliyun.core.annotation.NameInMap("MetricName")
private String metricName;
@com.aliyun.core.annotation.NameInMap("Period")
private Integer period;
@com.aliyun.core.annotation.NameInMap("Statistics")
private String statistics;
@com.aliyun.core.annotation.NameInMap("Threshold")
private Float threshold;
private Expressions(Builder builder) {
this.comparisonOperator = builder.comparisonOperator;
this.metricName = builder.metricName;
this.period = builder.period;
this.statistics = builder.statistics;
this.threshold = builder.threshold;
}
public static Builder builder() {
return new Builder();
}
public static Expressions create() {
return builder().build();
}
/**
* @return comparisonOperator
*/
public String getComparisonOperator() {
return this.comparisonOperator;
}
/**
* @return metricName
*/
public String getMetricName() {
return this.metricName;
}
/**
* @return period
*/
public Integer getPeriod() {
return this.period;
}
/**
* @return statistics
*/
public String getStatistics() {
return this.statistics;
}
/**
* @return threshold
*/
public Float getThreshold() {
return this.threshold;
}
public static final class Builder {
private String comparisonOperator;
private String metricName;
private Integer period;
private String statistics;
private Float threshold;
/**
* The operator that is used to compare the metric value and the threshold. Valid values:
*
* - If the metric value is greater than or equal to the threshold, set the value to
>=.
* - If the metric value is less than or equal to the threshold, set the value to
<=.
* - If the metric value is greater than the threshold, set the value to
>.
* - If the metric value is less than the threshold, set the value to
<.
*
* Default value: >=.
*
* example:
*
* =
*
*/
public Builder comparisonOperator(String comparisonOperator) {
this.comparisonOperator = comparisonOperator;
return this;
}
/**
* The name of the metric that is specified in the multi-metric alert rule. The valid values vary based on the metric type.
*
* If you set the MetricType parameter to custom, the valid values are your custom metrics.
* If you set the MetricType parameter to system, the MetricName parameter has the following valid values:
*
* - CpuUtilization: the CPU utilization of an ECS instance. Unit: %.
* - IntranetTx: the outbound traffic over the internal network from an ECS instance. Unit: KB/min.
* - IntranetRx: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.
* - VpcInternetTx: the outbound traffic over the Internet from an ECS instance that resides in a VPC. Unit: KB/min.
* - VpcInternetRx: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.
* - SystemDiskReadBps: the number of bytes read from the system disk used by an ECS instance per second.
* - SystemDiskWriteBps: the number of bytes written to the system disk used by an ECS instance per second.
* - SystemDiskReadOps: the number of read operations on the system disk used by an ECS instance per second.
* - SystemDiskWriteOps: the number of write operations on the system disk used by an ECS instance per second.
* - CpuUtilizationAgent: the CPU utilization of an agent. Unit: %.
* - GpuUtilizationAgent: the GPU utilization of an agent. Unit: %.
* - GpuMemoryFreeUtilizationAgent: the percentage of idle GPU memory of an agent.
* - GpuMemoryUtilizationAgent: the GPU memory usage of an agent. Unit: %.
* - MemoryUtilization: the memory usage of an agent. Unit: %.
* - LoadAverage: the average system load of an agent.
* - TcpConnection: the total number of TCP connections of an agent.
* - TcpConnection: the number of established TCP connections of an agent.
* - PackagesNetOut: the number of packets that are sent by the internal NIC used by an agent.
* - PackagesNetIn: the number of packets that are received by the internal NIC used by an agent.
* - EciPodCpuUtilization: the CPU utilization of an elastic container instance. Unit: %.
* - EciPodMemoryUtilization: the memory usage of an elastic container instance. Unit: %.
*
*
* For more information, see Event-triggered task for system monitoring.
*
* example:
* CpuUtilization
*/
public Builder metricName(String metricName) {
this.metricName = metricName;
return this;
}
/**
* The period of time during which statistics about the metrics in the multi-metric alert rule is collected. Unit: seconds. Valid values:
*
* - 15
* - 60
* - 120
* - 300
* - 900
*
*
* If your scaling group is of the ECS type and the event-triggered task associated with your scaling group monitors CloudMonitor metrics, you can set the Period parameter to 15. In other cases, you can set the Period parameter to 60, 120, 300, or 900. In most cases, the name of a CloudMonitor metric contains Agent.
*
* Default value: 300.
*
* example:
* 300
*/
public Builder period(Integer period) {
this.period = period;
return this;
}
/**
* The method that is used to aggregate statistics about the metrics that are specified in the multi-metric alert rule. Valid values:
*
* - Average
* - Minimum
* - Maximum
*
*
* example:
* Average
*/
public Builder statistics(String statistics) {
this.statistics = statistics;
return this;
}
/**
* The thresholds of the metric values in the multi-metric alert rule. If the thresholds are reached the specified number of times within the specified period, a scaling rule is executed.
*
* example:
* 40.0
*/
public Builder threshold(Float threshold) {
this.threshold = threshold;
return this;
}
public Expressions build() {
return new Expressions(this);
}
}
}
}