software.amazon.awssdk.services.ecs.model

Interface ListTaskDefinitionsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListTaskDefinitionsRequest.Builder,ListTaskDefinitionsRequest>, EcsRequest.Builder, SdkBuilder<ListTaskDefinitionsRequest.Builder,ListTaskDefinitionsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListTaskDefinitionsRequest

public static interface ListTaskDefinitionsRequest.Builder
extends EcsRequest.Builder, SdkPojo, CopyableBuilder<ListTaskDefinitionsRequest.Builder,ListTaskDefinitionsRequest>

Method Summary

Modifier and Type	Method and Description
ListTaskDefinitionsRequest.Builder	familyPrefix(String familyPrefix) The full family name to filter the ListTaskDefinitions results with.
ListTaskDefinitionsRequest.Builder	maxResults(Integer maxResults) The maximum number of task definition results that ListTaskDefinitions returned in paginated output.
ListTaskDefinitionsRequest.Builder	nextToken(String nextToken) The nextToken value returned from a ListTaskDefinitions request indicating that more results are available to fulfill the request and further calls will be needed.
ListTaskDefinitionsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListTaskDefinitionsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListTaskDefinitionsRequest.Builder	sort(SortOrder sort) The order to sort the results in.
ListTaskDefinitionsRequest.Builder	sort(String sort) The order to sort the results in.
ListTaskDefinitionsRequest.Builder	status(String status) The task definition status to filter the ListTaskDefinitions results with.
ListTaskDefinitionsRequest.Builder	status(TaskDefinitionStatus status) The task definition status to filter the ListTaskDefinitions results with.

Methods inherited from interface software.amazon.awssdk.services.ecs.model.EcsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

familyPrefix

ListTaskDefinitionsRequest.Builder familyPrefix(String familyPrefix)

The full family name to filter the ListTaskDefinitions results with. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Parameters:

familyPrefix - The full family name to filter the ListTaskDefinitions results with. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

ListTaskDefinitionsRequest.Builder status(String status)

The task definition status to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Parameters:

status - The task definition status to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TaskDefinitionStatus, TaskDefinitionStatus

status

ListTaskDefinitionsRequest.Builder status(TaskDefinitionStatus status)

The task definition status to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Parameters:

status - The task definition status to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TaskDefinitionStatus, TaskDefinitionStatus

sort

ListTaskDefinitionsRequest.Builder sort(String sort)

The order to sort the results in. Valid values are ASC and DESC. By default, ( ASC) task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision. This is so that the newest task definitions in a family are listed first.

Parameters:

sort - The order to sort the results in. Valid values are ASC and DESC. By default, (ASC) task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision. This is so that the newest task definitions in a family are listed first.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SortOrder, SortOrder

sort

ListTaskDefinitionsRequest.Builder sort(SortOrder sort)

The order to sort the results in. Valid values are ASC and DESC. By default, ( ASC) task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision. This is so that the newest task definitions in a family are listed first.

Parameters:

sort - The order to sort the results in. Valid values are ASC and DESC. By default, (ASC) task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision. This is so that the newest task definitions in a family are listed first.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SortOrder, SortOrder

nextToken

ListTaskDefinitionsRequest.Builder nextToken(String nextToken)

The nextToken value returned from a ListTaskDefinitions 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.

Parameters:

nextToken - The nextToken value returned from a ListTaskDefinitions 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:

Returns a reference to this object so that method calls can be chained together.

maxResults

ListTaskDefinitionsRequest.Builder maxResults(Integer maxResults)

The maximum number of task definition results that ListTaskDefinitions returned 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

Parameters:

maxResults - The maximum number of task definition results that ListTaskDefinitions returned 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ListTaskDefinitionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListTaskDefinitionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder