Package 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("software.amazon.awssdk:codegen")
public final class ListAttributesRequest
extends EcsRequest
implements ToCopyableBuilder<ListAttributesRequest.Builder,ListAttributesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListAttributesRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	attributeName()	The name of the attribute to filter the results with.
String	attributeValue()	The value of the attribute to filter results with.
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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of cluster results that ListAttributes returned in paginated output.
String	nextToken()	The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls are needed.
List<SdkField<?>>	sdkFields()
static Class<? extends ListAttributesRequest.Builder>	serializableBuilderClass()
TargetType	targetType()	The type of the target to list attributes with.
String	targetTypeAsString()	The type of the target to list attributes with.
ListAttributesRequest.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

cluster

public final 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 final TargetType targetType()

The type of the target to list attributes with.

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 to list attributes with.

See Also:

TargetType

targetTypeAsString

public final String targetTypeAsString()

The type of the target to list attributes with.

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 to list attributes with.

See Also:

TargetType

attributeName

public final String attributeName()

The name of the attribute to filter the results with.

Returns:

The name of the attribute to filter the results with.

attributeValue

public final String attributeValue()

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

Returns:

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

nextToken

public final String nextToken()

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

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 ListAttributes request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

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 final Integer maxResults()

The maximum number of cluster results that ListAttributes returned 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 isn't used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

Returns:

The maximum number of cluster results that ListAttributes returned 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 isn't 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 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