Package software.amazon.awssdk.services.autoscaling.model

Class EnableMetricsCollectionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest

software.amazon.awssdk.services.autoscaling.model.EnableMetricsCollectionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<EnableMetricsCollectionRequest.Builder,EnableMetricsCollectionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class EnableMetricsCollectionRequest
extends AutoScalingRequest
implements ToCopyableBuilder<EnableMetricsCollectionRequest.Builder,EnableMetricsCollectionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EnableMetricsCollectionRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	autoScalingGroupName()	The name of the Auto Scaling group.
static EnableMetricsCollectionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	granularity()	The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch.
int	hashCode()
boolean	hasMetrics()	For responses, this returns true if the service returned a value for the Metrics property.
List<String>	metrics()	Identifies the metrics to enable.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EnableMetricsCollectionRequest.Builder>	serializableBuilderClass()
EnableMetricsCollectionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

autoScalingGroupName

public final String autoScalingGroupName()

The name of the Auto Scaling group.

Returns:

The name of the Auto Scaling group.

hasMetrics

public final boolean hasMetrics()

For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

metrics

public final List<String> metrics()

Identifies the metrics to enable.

You can specify one or more of the following metrics:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

• GroupInServiceCapacity

• GroupPendingCapacity

• GroupStandbyCapacity

• GroupTerminatingCapacity

• GroupTotalCapacity

• WarmPoolDesiredCapacity

• WarmPoolWarmedCapacity

• WarmPoolPendingCapacity

• WarmPoolTerminatingCapacity

• WarmPoolTotalCapacity

• GroupAndWarmPoolDesiredCapacity

• GroupAndWarmPoolTotalCapacity

If you specify Granularity and don't specify any metrics, all metrics are enabled.

For more information, see Amazon CloudWatch metrics for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.

Returns:

Identifies the metrics to enable.

You can specify one or more of the following metrics:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

• GroupInServiceCapacity

• GroupPendingCapacity

• GroupStandbyCapacity

• GroupTerminatingCapacity

• GroupTotalCapacity

• WarmPoolDesiredCapacity

• WarmPoolWarmedCapacity

• WarmPoolPendingCapacity

• WarmPoolTerminatingCapacity

• WarmPoolTotalCapacity

• GroupAndWarmPoolDesiredCapacity

• GroupAndWarmPoolTotalCapacity

If you specify Granularity and don't specify any metrics, all metrics are enabled.

For more information, see Amazon CloudWatch metrics for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

granularity

public final String granularity()

The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is 1Minute.

Returns:

The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is 1Minute.

toBuilder

public EnableMetricsCollectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EnableMetricsCollectionRequest.Builder,EnableMetricsCollectionRequest>

Specified by:

toBuilder in class AutoScalingRequest

builder

public static EnableMetricsCollectionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends EnableMetricsCollectionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo