Class ListTaskDefinitionsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.ecs.model.ListTaskDefinitionsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class ListTaskDefinitionsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ListTaskDefinitionsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListTaskDefinitionsRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getFamilyPrefix()
The full family name with which to filter theListTaskDefinitions
results.Integer
getMaxResults()
The maximum number of task definition results returned byListTaskDefinitions
in paginated output.String
getNextToken()
ThenextToken
value returned from a previous paginatedListTaskDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter.String
getSort()
The order in which to sort the results.String
getStatus()
The task definition status with which to filter theListTaskDefinitions
results.int
hashCode()
void
setFamilyPrefix(String familyPrefix)
The full family name with which to filter theListTaskDefinitions
results.void
setMaxResults(Integer maxResults)
The maximum number of task definition results returned byListTaskDefinitions
in paginated output.void
setNextToken(String nextToken)
ThenextToken
value returned from a previous paginatedListTaskDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter.void
setSort(SortOrder sort)
The order in which to sort the results.void
setSort(String sort)
The order in which to sort the results.void
setStatus(TaskDefinitionStatus status)
The task definition status with which to filter theListTaskDefinitions
results.void
setStatus(String status)
The task definition status with which to filter theListTaskDefinitions
results.String
toString()
Returns a string representation of this object; useful for testing and debugging.ListTaskDefinitionsRequest
withFamilyPrefix(String familyPrefix)
The full family name with which to filter theListTaskDefinitions
results.ListTaskDefinitionsRequest
withMaxResults(Integer maxResults)
The maximum number of task definition results returned byListTaskDefinitions
in paginated output.ListTaskDefinitionsRequest
withNextToken(String nextToken)
ThenextToken
value returned from a previous paginatedListTaskDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter.ListTaskDefinitionsRequest
withSort(SortOrder sort)
The order in which to sort the results.ListTaskDefinitionsRequest
withSort(String sort)
The order in which to sort the results.ListTaskDefinitionsRequest
withStatus(TaskDefinitionStatus status)
The task definition status with which to filter theListTaskDefinitions
results.ListTaskDefinitionsRequest
withStatus(String status)
The task definition status with which to filter theListTaskDefinitions
results.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setFamilyPrefix
public void setFamilyPrefix(String familyPrefix)
The full family name with which to filter the
ListTaskDefinitions
results. Specifying afamilyPrefix
limits the listed task definitions to task definition revisions that belong to that family.- Parameters:
familyPrefix
- The full family name with which to filter theListTaskDefinitions
results. Specifying afamilyPrefix
limits the listed task definitions to task definition revisions that belong to that family.
-
getFamilyPrefix
public String getFamilyPrefix()
The full family name with which to filter the
ListTaskDefinitions
results. Specifying afamilyPrefix
limits the listed task definitions to task definition revisions that belong to that family.- Returns:
- The full family name with which to filter the
ListTaskDefinitions
results. Specifying afamilyPrefix
limits the listed task definitions to task definition revisions that belong to that family.
-
withFamilyPrefix
public ListTaskDefinitionsRequest withFamilyPrefix(String familyPrefix)
The full family name with which to filter the
ListTaskDefinitions
results. Specifying afamilyPrefix
limits the listed task definitions to task definition revisions that belong to that family.- Parameters:
familyPrefix
- The full family name with which to filter theListTaskDefinitions
results. Specifying afamilyPrefix
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.
-
setStatus
public void setStatus(String status)
The task definition status with which to filter the
ListTaskDefinitions
results. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- Parameters:
status
- The task definition status with which to filter theListTaskDefinitions
results. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- See Also:
TaskDefinitionStatus
-
getStatus
public String getStatus()
The task definition status with which to filter the
ListTaskDefinitions
results. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- Returns:
- The task definition status with which to filter the
ListTaskDefinitions
results. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request. - See Also:
TaskDefinitionStatus
-
withStatus
public ListTaskDefinitionsRequest withStatus(String status)
The task definition status with which to filter the
ListTaskDefinitions
results. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- Parameters:
status
- The task definition status with which to filter theListTaskDefinitions
results. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TaskDefinitionStatus
-
setStatus
public void setStatus(TaskDefinitionStatus status)
The task definition status with which to filter the
ListTaskDefinitions
results. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- Parameters:
status
- The task definition status with which to filter theListTaskDefinitions
results. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- See Also:
TaskDefinitionStatus
-
withStatus
public ListTaskDefinitionsRequest withStatus(TaskDefinitionStatus status)
The task definition status with which to filter the
ListTaskDefinitions
results. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- Parameters:
status
- The task definition status with which to filter theListTaskDefinitions
results. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TaskDefinitionStatus
-
setSort
public void setSort(String sort)
The order in which to sort the results. Valid values are
ASC
andDESC
. 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 toDESC
reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.- Parameters:
sort
- The order in which to sort the results. Valid values areASC
andDESC
. 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 toDESC
reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.- See Also:
SortOrder
-
getSort
public String getSort()
The order in which to sort the results. Valid values are
ASC
andDESC
. 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 toDESC
reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.- Returns:
- The order in which to sort the results. Valid values are
ASC
andDESC
. 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 toDESC
reverses the sort order on family name and revision so that the newest task definitions in a family are listed first. - See Also:
SortOrder
-
withSort
public ListTaskDefinitionsRequest withSort(String sort)
The order in which to sort the results. Valid values are
ASC
andDESC
. 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 toDESC
reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.- Parameters:
sort
- The order in which to sort the results. Valid values areASC
andDESC
. 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 toDESC
reverses the sort order on family name and revision 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
-
setSort
public void setSort(SortOrder sort)
The order in which to sort the results. Valid values are
ASC
andDESC
. 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 toDESC
reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.- Parameters:
sort
- The order in which to sort the results. Valid values areASC
andDESC
. 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 toDESC
reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.- See Also:
SortOrder
-
withSort
public ListTaskDefinitionsRequest withSort(SortOrder sort)
The order in which to sort the results. Valid values are
ASC
andDESC
. 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 toDESC
reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.- Parameters:
sort
- The order in which to sort the results. Valid values areASC
andDESC
. 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 toDESC
reverses the sort order on family name and revision 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
-
setNextToken
public void setNextToken(String nextToken)
The
nextToken
value returned from a previous paginatedListTaskDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
- Parameters:
nextToken
- ThenextToken
value returned from a previous paginatedListTaskDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
-
getNextToken
public String getNextToken()
The
nextToken
value returned from a previous paginatedListTaskDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
- Returns:
- The
nextToken
value returned from a previous paginatedListTaskDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
-
withNextToken
public ListTaskDefinitionsRequest withNextToken(String nextToken)
The
nextToken
value returned from a previous paginatedListTaskDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
- Parameters:
nextToken
- ThenextToken
value returned from a previous paginatedListTaskDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxResults
public void setMaxResults(Integer maxResults)
The maximum number of task definition results returned by
ListTaskDefinitions
in paginated output. When this parameter is used,ListTaskDefinitions
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitions
returns up to 100 results and anextToken
value if applicable.- Parameters:
maxResults
- The maximum number of task definition results returned byListTaskDefinitions
in paginated output. When this parameter is used,ListTaskDefinitions
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitions
returns up to 100 results and anextToken
value if applicable.
-
getMaxResults
public Integer getMaxResults()
The maximum number of task definition results returned by
ListTaskDefinitions
in paginated output. When this parameter is used,ListTaskDefinitions
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitions
returns up to 100 results and anextToken
value if applicable.- Returns:
- The maximum number of task definition results returned by
ListTaskDefinitions
in paginated output. When this parameter is used,ListTaskDefinitions
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitions
returns up to 100 results and anextToken
value if applicable.
-
withMaxResults
public ListTaskDefinitionsRequest withMaxResults(Integer maxResults)
The maximum number of task definition results returned by
ListTaskDefinitions
in paginated output. When this parameter is used,ListTaskDefinitions
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitions
returns up to 100 results and anextToken
value if applicable.- Parameters:
maxResults
- The maximum number of task definition results returned byListTaskDefinitions
in paginated output. When this parameter is used,ListTaskDefinitions
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitions
returns up to 100 results and anextToken
value if applicable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ListTaskDefinitionsRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-