com.amazonaws.services.autoscaling.model.PredefinedMetricSpecification Maven / Gradle / Ivy
Show all versions of aws-java-sdk-autoscaling Show documentation
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file 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.
*/
package com.amazonaws.services.autoscaling.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PredefinedMetricSpecification implements Serializable, Cloneable {
/**
*
* The metric type. The following predefined metrics are available:
*
*
* -
*
* ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
*
*
* -
*
* ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling
* group.
*
*
* -
*
* ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer
* target group.
*
*
*
*/
private String predefinedMetricType;
/**
*
* Identifies the resource associated with the metric type. You can't specify a resource label unless the metric
* type is ALBRequestCountPerTarget and there is a target group attached to the Auto Scaling group.
*
*
* The format is
* app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id
* , where
*
*
* -
*
* app/load-balancer-name/load-balancer-id is the final portion of the load balancer
* ARN, and
*
*
* -
*
* targetgroup/target-group-name/target-group-id is the final portion of the target
* group ARN.
*
*
*
*/
private String resourceLabel;
/**
*
* The metric type. The following predefined metrics are available:
*
*
* -
*
* ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
*
*
* -
*
* ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling
* group.
*
*
* -
*
* ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer
* target group.
*
*
*
*
* @param predefinedMetricType
* The metric type. The following predefined metrics are available:
*
* -
*
* ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
*
*
* -
*
* ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ALBRequestCountPerTarget - Number of requests completed per target in an Application Load
* Balancer target group.
*
*
* @see MetricType
*/
public void setPredefinedMetricType(String predefinedMetricType) {
this.predefinedMetricType = predefinedMetricType;
}
/**
*
* The metric type. The following predefined metrics are available:
*
*
* -
*
* ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
*
*
* -
*
* ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling
* group.
*
*
* -
*
* ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer
* target group.
*
*
*
*
* @return The metric type. The following predefined metrics are available:
*
* -
*
* ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
*
*
* -
*
* ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the
* Auto Scaling group.
*
*
* -
*
* ALBRequestCountPerTarget - Number of requests completed per target in an Application Load
* Balancer target group.
*
*
* @see MetricType
*/
public String getPredefinedMetricType() {
return this.predefinedMetricType;
}
/**
*
* The metric type. The following predefined metrics are available:
*
*
* -
*
* ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
*
*
* -
*
* ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling
* group.
*
*
* -
*
* ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer
* target group.
*
*
*
*
* @param predefinedMetricType
* The metric type. The following predefined metrics are available:
*
* -
*
* ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
*
*
* -
*
* ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ALBRequestCountPerTarget - Number of requests completed per target in an Application Load
* Balancer target group.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricType
*/
public PredefinedMetricSpecification withPredefinedMetricType(String predefinedMetricType) {
setPredefinedMetricType(predefinedMetricType);
return this;
}
/**
*
* The metric type. The following predefined metrics are available:
*
*
* -
*
* ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
*
*
* -
*
* ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling
* group.
*
*
* -
*
* ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer
* target group.
*
*
*
*
* @param predefinedMetricType
* The metric type. The following predefined metrics are available:
*
* -
*
* ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
*
*
* -
*
* ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ALBRequestCountPerTarget - Number of requests completed per target in an Application Load
* Balancer target group.
*
*
* @see MetricType
*/
public void setPredefinedMetricType(MetricType predefinedMetricType) {
withPredefinedMetricType(predefinedMetricType);
}
/**
*
* The metric type. The following predefined metrics are available:
*
*
* -
*
* ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
*
*
* -
*
* ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling
* group.
*
*
* -
*
* ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer
* target group.
*
*
*
*
* @param predefinedMetricType
* The metric type. The following predefined metrics are available:
*
* -
*
* ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
*
*
* -
*
* ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto
* Scaling group.
*
*
* -
*
* ALBRequestCountPerTarget - Number of requests completed per target in an Application Load
* Balancer target group.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricType
*/
public PredefinedMetricSpecification withPredefinedMetricType(MetricType predefinedMetricType) {
this.predefinedMetricType = predefinedMetricType.toString();
return this;
}
/**
*
* Identifies the resource associated with the metric type. You can't specify a resource label unless the metric
* type is ALBRequestCountPerTarget and there is a target group attached to the Auto Scaling group.
*
*
* The format is
* app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id
* , where
*
*
* -
*
* app/load-balancer-name/load-balancer-id is the final portion of the load balancer
* ARN, and
*
*
* -
*
* targetgroup/target-group-name/target-group-id is the final portion of the target
* group ARN.
*
*
*
*
* @param resourceLabel
* Identifies the resource associated with the metric type. You can't specify a resource label unless the
* metric type is ALBRequestCountPerTarget and there is a target group attached to the Auto
* Scaling group.
*
* The format is
* app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id
* , where
*
*
* -
*
* app/load-balancer-name/load-balancer-id is the final portion of the load
* balancer ARN, and
*
*
* -
*
* targetgroup/target-group-name/target-group-id is the final portion of the
* target group ARN.
*
*
*/
public void setResourceLabel(String resourceLabel) {
this.resourceLabel = resourceLabel;
}
/**
*
* Identifies the resource associated with the metric type. You can't specify a resource label unless the metric
* type is ALBRequestCountPerTarget and there is a target group attached to the Auto Scaling group.
*
*
* The format is
* app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id
* , where
*
*
* -
*
* app/load-balancer-name/load-balancer-id is the final portion of the load balancer
* ARN, and
*
*
* -
*
* targetgroup/target-group-name/target-group-id is the final portion of the target
* group ARN.
*
*
*
*
* @return Identifies the resource associated with the metric type. You can't specify a resource label unless the
* metric type is ALBRequestCountPerTarget and there is a target group attached to the Auto
* Scaling group.
*
* The format is
* app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id
* , where
*
*
* -
*
* app/load-balancer-name/load-balancer-id is the final portion of the load
* balancer ARN, and
*
*
* -
*
* targetgroup/target-group-name/target-group-id is the final portion of the
* target group ARN.
*
*
*/
public String getResourceLabel() {
return this.resourceLabel;
}
/**
*
* Identifies the resource associated with the metric type. You can't specify a resource label unless the metric
* type is ALBRequestCountPerTarget and there is a target group attached to the Auto Scaling group.
*
*
* The format is
* app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id
* , where
*
*
* -
*
* app/load-balancer-name/load-balancer-id is the final portion of the load balancer
* ARN, and
*
*
* -
*
* targetgroup/target-group-name/target-group-id is the final portion of the target
* group ARN.
*
*
*
*
* @param resourceLabel
* Identifies the resource associated with the metric type. You can't specify a resource label unless the
* metric type is ALBRequestCountPerTarget and there is a target group attached to the Auto
* Scaling group.
*
* The format is
* app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id
* , where
*
*
* -
*
* app/load-balancer-name/load-balancer-id is the final portion of the load
* balancer ARN, and
*
*
* -
*
* targetgroup/target-group-name/target-group-id is the final portion of the
* target group ARN.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredefinedMetricSpecification withResourceLabel(String resourceLabel) {
setResourceLabel(resourceLabel);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPredefinedMetricType() != null)
sb.append("PredefinedMetricType: ").append(getPredefinedMetricType()).append(",");
if (getResourceLabel() != null)
sb.append("ResourceLabel: ").append(getResourceLabel());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PredefinedMetricSpecification == false)
return false;
PredefinedMetricSpecification other = (PredefinedMetricSpecification) obj;
if (other.getPredefinedMetricType() == null ^ this.getPredefinedMetricType() == null)
return false;
if (other.getPredefinedMetricType() != null && other.getPredefinedMetricType().equals(this.getPredefinedMetricType()) == false)
return false;
if (other.getResourceLabel() == null ^ this.getResourceLabel() == null)
return false;
if (other.getResourceLabel() != null && other.getResourceLabel().equals(this.getResourceLabel()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPredefinedMetricType() == null) ? 0 : getPredefinedMetricType().hashCode());
hashCode = prime * hashCode + ((getResourceLabel() == null) ? 0 : getResourceLabel().hashCode());
return hashCode;
}
@Override
public PredefinedMetricSpecification clone() {
try {
return (PredefinedMetricSpecification) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}