software.amazon.awssdk.services.ecs.model

Class ListAttributesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAttributesRequest.Builder,ListAttributesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListAttributesRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	attributeName() The name of the attribute with which to filter the results.
String	attributeValue() The value of the attribute with which to filter results.
static ListAttributesRequest.Builder	builder()
String	cluster() The short name or full Amazon Resource Name (ARN) of the cluster to list attributes.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of cluster results returned by ListAttributes in paginated output.
String	nextToken() The nextToken value returned from a previous paginated ListAttributes request where maxResults was used and the results exceeded the value of that parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends ListAttributesRequest.Builder>	serializableBuilderClass()
TargetType	targetType() The type of the target with which to list attributes.
String	targetTypeAsString() The type of the target with which to list attributes.
ListAttributesRequest.Builder	toBuilder()
String	toString()

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

cluster

public String cluster()

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. 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 to list attributes. If you do not specify a cluster, the default cluster is assumed.

targetType

public TargetType targetType()

The type of the target with which to list attributes.

If the service returns an enum value that is not available in the current SDK version, targetType will return TargetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

Returns:

The type of the target with which to list attributes.

See Also:

TargetType

targetTypeAsString

public String targetTypeAsString()

The type of the target with which to list attributes.

If the service returns an enum value that is not available in the current SDK version, targetType will return TargetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

Returns:

The type of the target with which to list attributes.

See Also:

TargetType

attributeName

public String attributeName()

The name of the attribute with which to filter the results.

Returns:

The name of the attribute with which to filter the results.

attributeValue

public String attributeValue()

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

Returns:

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

nextToken

public String nextToken()

The nextToken value returned from a previous paginated ListAttributes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

The nextToken value returned from a previous paginated ListAttributes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

maxResults

public Integer maxResults()

The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

Returns:

The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

toBuilder

public ListAttributesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAttributesRequest.Builder,ListAttributesRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static ListAttributesRequest.Builder builder()

serializableBuilderClass

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo