software.amazon.awssdk.services.ecs.model

Class DescribeClustersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ecs.model.EcsRequest

software.amazon.awssdk.services.ecs.model.DescribeClustersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeClustersRequest
extends EcsRequest
implements ToCopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeClustersRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeClustersRequest.Builder	builder()
List<String>	clusters() A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<ClusterField>	include() Additional information about your clusters to be separated by launch type, including:
List<String>	includeAsStrings() Additional information about your clusters to be separated by launch type, including:
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeClustersRequest.Builder>	serializableBuilderClass()
DescribeClustersRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

clusters

public List<String> clusters()

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

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

Returns:

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

include

public List<ClusterField> include()

Additional information about your clusters to be separated by launch type, including:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

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

Returns:

Additional information about your clusters to be separated by launch type, including:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

includeAsStrings

public List<String> includeAsStrings()

Additional information about your clusters to be separated by launch type, including:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

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

Returns:

Additional information about your clusters to be separated by launch type, including:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

toBuilder

public DescribeClustersRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>

Specified by:

toBuilder in class EcsRequest

Returns:

a builder for type T

builder

public static DescribeClustersRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.