software.amazon.awssdk.services.ecs.model

Class DescribeContainerInstancesRequest

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.DescribeContainerInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeContainerInstancesRequest.Builder,DescribeContainerInstancesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeContainerInstancesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeContainerInstancesRequest.Builder	builder()
String	cluster() The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe.
List<String>	containerInstances() A list of up to 100 container instance IDs or full 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<ContainerInstanceField>	include() Specifies whether you want to see the resource tags for the container instance.
List<String>	includeAsStrings() Specifies whether you want to see the resource tags for the container instance.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeContainerInstancesRequest.Builder>	serializableBuilderClass()
DescribeContainerInstancesRequest.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

cluster

public String cluster()

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed.

containerInstances

public List<String> containerInstances()

A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

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

Returns:

A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

include

public List<ContainerInstanceField> include()

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

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

Returns:

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

includeAsStrings

public List<String> includeAsStrings()

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

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

Returns:

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

toBuilder

public DescribeContainerInstancesRequest.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<DescribeContainerInstancesRequest.Builder,DescribeContainerInstancesRequest>

Specified by:

toBuilder in class EcsRequest

Returns:

a builder for type T

builder

public static DescribeContainerInstancesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeContainerInstancesRequest.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.