public static interface ListTaskDefinitionsRequest.Builder extends ECSRequest.Builder, CopyableBuilder<ListTaskDefinitionsRequest.Builder,ListTaskDefinitionsRequest>
Modifier and Type | Method and Description |
---|---|
ListTaskDefinitionsRequest.Builder |
familyPrefix(String familyPrefix)
The full family name with which to filter the
ListTaskDefinitions results. |
ListTaskDefinitionsRequest.Builder |
maxResults(Integer maxResults)
The maximum number of task definition results returned by
ListTaskDefinitions in paginated
output. |
ListTaskDefinitionsRequest.Builder |
nextToken(String nextToken)
The
nextToken value returned from a previous paginated ListTaskDefinitions request
where maxResults was used and the results exceeded the value of that parameter. |
ListTaskDefinitionsRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
ListTaskDefinitionsRequest.Builder |
sort(SortOrder sort)
The order in which to sort the results.
|
ListTaskDefinitionsRequest.Builder |
sort(String sort)
The order in which to sort the results.
|
ListTaskDefinitionsRequest.Builder |
status(String status)
The task definition status with which to filter the
ListTaskDefinitions results. |
ListTaskDefinitionsRequest.Builder |
status(TaskDefinitionStatus status)
The task definition status with which to filter the
ListTaskDefinitions results. |
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
ListTaskDefinitionsRequest.Builder familyPrefix(String familyPrefix)
The full family name with which to filter the ListTaskDefinitions
results. Specifying a
familyPrefix
limits the listed task definitions to task definition revisions that belong to that
family.
familyPrefix
- The full family name with which to filter the ListTaskDefinitions
results. Specifying a
familyPrefix
limits the listed task definitions to task definition revisions that belong
to that family.ListTaskDefinitionsRequest.Builder status(String status)
The task definition status with which to filter the ListTaskDefinitions
results. 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.
status
- The task definition status with which to filter the ListTaskDefinitions
results. 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.TaskDefinitionStatus
,
TaskDefinitionStatus
ListTaskDefinitionsRequest.Builder status(TaskDefinitionStatus status)
The task definition status with which to filter the ListTaskDefinitions
results. 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.
status
- The task definition status with which to filter the ListTaskDefinitions
results. 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.TaskDefinitionStatus
,
TaskDefinitionStatus
ListTaskDefinitionsRequest.Builder sort(String sort)
The order in which to sort the results. 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 so that the newest task definitions in
a family are listed first.
sort
- The order in which to sort the results. 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 so
that the newest task definitions in a family are listed first.SortOrder
,
SortOrder
ListTaskDefinitionsRequest.Builder sort(SortOrder sort)
The order in which to sort the results. 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 so that the newest task definitions in
a family are listed first.
sort
- The order in which to sort the results. 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 so
that the newest task definitions in a family are listed first.SortOrder
,
SortOrder
ListTaskDefinitionsRequest.Builder nextToken(String nextToken)
The nextToken
value returned from a previous paginated ListTaskDefinitions
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 value is
null
when there are no more results to return.
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.
nextToken
- The nextToken
value returned from a previous paginated ListTaskDefinitions
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 value is null
when there are no more results to return. 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.
ListTaskDefinitionsRequest.Builder maxResults(Integer maxResults)
The maximum number of task definition results returned by ListTaskDefinitions
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 is not used, then
ListTaskDefinitions
returns up to 100 results and a nextToken
value if applicable.
maxResults
- The maximum number of task definition results returned by ListTaskDefinitions
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 is not used, then ListTaskDefinitions
returns
up to 100 results and a nextToken
value if applicable.ListTaskDefinitionsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.