software.amazon.awssdk.services.ecs.model

Class ListTaskDefinitionFamiliesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListTaskDefinitionFamiliesRequest.Builder,ListTaskDefinitionFamiliesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListTaskDefinitionFamiliesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListTaskDefinitionFamiliesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	familyPrefix() The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output.
String	nextToken() The nextToken value returned from a ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed.
List<SdkField<?>>	sdkFields()
static Class<? extends ListTaskDefinitionFamiliesRequest.Builder>	serializableBuilderClass()
TaskDefinitionFamilyStatus	status() The task definition family status with which to filter the ListTaskDefinitionFamilies results.
String	statusAsString() The task definition family status with which to filter the ListTaskDefinitionFamilies results.
ListTaskDefinitionFamiliesRequest.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

familyPrefix

public final String familyPrefix()

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

Returns:

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

status

public final TaskDefinitionFamilyStatus status()

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

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

Returns:

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

See Also:

TaskDefinitionFamilyStatus

statusAsString

public final String statusAsString()

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

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

Returns:

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

See Also:

TaskDefinitionFamilyStatus

nextToken

public final String nextToken()

The nextToken value returned from a ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is 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 ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is 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 task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

Returns:

The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

toBuilder

public ListTaskDefinitionFamiliesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListTaskDefinitionFamiliesRequest.Builder,ListTaskDefinitionFamiliesRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static ListTaskDefinitionFamiliesRequest.Builder builder()

serializableBuilderClass

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