software.amazon.awssdk.services.autoscaling.model.PredefinedMetricSpecification Maven / Gradle / Ivy
Show all versions of autoscaling Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.autoscaling.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PredefinedMetricSpecification implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField PREDEFINED_METRIC_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PredefinedMetricType").getter(getter(PredefinedMetricSpecification::predefinedMetricTypeAsString))
.setter(setter(Builder::predefinedMetricType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PredefinedMetricType").build())
.build();
private static final SdkField RESOURCE_LABEL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResourceLabel").getter(getter(PredefinedMetricSpecification::resourceLabel))
.setter(setter(Builder::resourceLabel))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResourceLabel").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PREDEFINED_METRIC_TYPE_FIELD,
RESOURCE_LABEL_FIELD));
private static final long serialVersionUID = 1L;
private final String predefinedMetricType;
private final String resourceLabel;
private PredefinedMetricSpecification(BuilderImpl builder) {
this.predefinedMetricType = builder.predefinedMetricType;
this.resourceLabel = builder.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 - Average Application Load Balancer request count per target for your Auto
* Scaling group.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #predefinedMetricType} will return {@link MetricType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by
* the service is available from {@link #predefinedMetricTypeAsString}.
*
*
* @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 - Average Application Load Balancer request count per target for
* your Auto Scaling group.
*
*
* @see MetricType
*/
public final MetricType predefinedMetricType() {
return MetricType.fromValue(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 - Average Application Load Balancer request count per target for your Auto
* Scaling group.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #predefinedMetricType} will return {@link MetricType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by
* the service is available from {@link #predefinedMetricTypeAsString}.
*
*
* @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 - Average Application Load Balancer request count per target for
* your Auto Scaling group.
*
*
* @see MetricType
*/
public final String predefinedMetricTypeAsString() {
return predefinedMetricType;
}
/**
*
* A label that uniquely identifies a specific Application Load Balancer target group from which to determine the
* average request count served by your Auto Scaling group. You can't specify a resource label unless the target
* group is attached to the Auto Scaling group.
*
*
* You create the resource label by appending the final portion of the load balancer ARN and the final portion of
* the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
*
*
* app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
*
*
* Where:
*
*
* -
*
* app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
*
*
* -
*
* targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
*
*
*
*
* To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
*
*
* @return A label that uniquely identifies a specific Application Load Balancer target group from which to
* determine the average request count served by your Auto Scaling group. You can't specify a resource label
* unless the target group is attached to the Auto Scaling group.
*
* You create the resource label by appending the final portion of the load balancer ARN and the final
* portion of the target group ARN into a single value, separated by a forward slash (/). The format of the
* resource label is:
*
*
* app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
*
*
* Where:
*
*
* -
*
* app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
*
*
* -
*
* targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group
* ARN.
*
*
*
*
* To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
*/
public final String resourceLabel() {
return resourceLabel;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(predefinedMetricTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(resourceLabel());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PredefinedMetricSpecification)) {
return false;
}
PredefinedMetricSpecification other = (PredefinedMetricSpecification) obj;
return Objects.equals(predefinedMetricTypeAsString(), other.predefinedMetricTypeAsString())
&& Objects.equals(resourceLabel(), other.resourceLabel());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("PredefinedMetricSpecification").add("PredefinedMetricType", predefinedMetricTypeAsString())
.add("ResourceLabel", resourceLabel()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "PredefinedMetricType":
return Optional.ofNullable(clazz.cast(predefinedMetricTypeAsString()));
case "ResourceLabel":
return Optional.ofNullable(clazz.cast(resourceLabel()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PredefinedMetricSpecification) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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 - Average Application Load Balancer request count per target for your
* Auto Scaling 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 - Average Application Load Balancer request count per target for
* your Auto Scaling group.
*
*
* @see MetricType
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricType
*/
Builder predefinedMetricType(String 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 - Average Application Load Balancer request count per target for your
* Auto Scaling 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 - Average Application Load Balancer request count per target for
* your Auto Scaling group.
*
*
* @see MetricType
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricType
*/
Builder predefinedMetricType(MetricType predefinedMetricType);
/**
*
* A label that uniquely identifies a specific Application Load Balancer target group from which to determine
* the average request count served by your Auto Scaling group. You can't specify a resource label unless the
* target group is attached to the Auto Scaling group.
*
*
* You create the resource label by appending the final portion of the load balancer ARN and the final portion
* of the target group ARN into a single value, separated by a forward slash (/). The format of the resource
* label is:
*
*
* app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
*
*
* Where:
*
*
* -
*
* app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
*
*
* -
*
* targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
*
*
*
*
* To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
*
*
* @param resourceLabel
* A label that uniquely identifies a specific Application Load Balancer target group from which to
* determine the average request count served by your Auto Scaling group. You can't specify a resource
* label unless the target group is attached to the Auto Scaling group.
*
* You create the resource label by appending the final portion of the load balancer ARN and the final
* portion of the target group ARN into a single value, separated by a forward slash (/). The format of
* the resource label is:
*
*
* app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
*
*
* Where:
*
*
* -
*
* app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
*
*
* -
*
* targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group
* ARN.
*
*
*
*
* To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceLabel(String resourceLabel);
}
static final class BuilderImpl implements Builder {
private String predefinedMetricType;
private String resourceLabel;
private BuilderImpl() {
}
private BuilderImpl(PredefinedMetricSpecification model) {
predefinedMetricType(model.predefinedMetricType);
resourceLabel(model.resourceLabel);
}
public final String getPredefinedMetricType() {
return predefinedMetricType;
}
public final void setPredefinedMetricType(String predefinedMetricType) {
this.predefinedMetricType = predefinedMetricType;
}
@Override
public final Builder predefinedMetricType(String predefinedMetricType) {
this.predefinedMetricType = predefinedMetricType;
return this;
}
@Override
public final Builder predefinedMetricType(MetricType predefinedMetricType) {
this.predefinedMetricType(predefinedMetricType == null ? null : predefinedMetricType.toString());
return this;
}
public final String getResourceLabel() {
return resourceLabel;
}
public final void setResourceLabel(String resourceLabel) {
this.resourceLabel = resourceLabel;
}
@Override
public final Builder resourceLabel(String resourceLabel) {
this.resourceLabel = resourceLabel;
return this;
}
@Override
public PredefinedMetricSpecification build() {
return new PredefinedMetricSpecification(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}