com.amazonaws.services.ecs.model

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

Container for the parameters to the ListTaskDefinitions operation.

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

See Also:

AmazonECS.listTaskDefinitions(ListTaskDefinitionsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListTaskDefinitionsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListTaskDefinitionsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getFamilyPrefix() The full family name that you want to filter the ListTaskDefinitions results with.
Integer	getMaxResults() The maximum number of task definition results returned by ListTaskDefinitions in paginated output.
String	getNextToken() The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults 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 that you want to filter the ListTaskDefinitions results with.
int	hashCode()
void	setFamilyPrefix(String familyPrefix) The full family name that you want to filter the ListTaskDefinitions results with.
void	setMaxResults(Integer maxResults) The maximum number of task definition results returned by ListTaskDefinitions in paginated output.
void	setNextToken(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.
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(String status) The task definition status that you want to filter the ListTaskDefinitions results with.
void	setStatus(TaskDefinitionStatus status) The task definition status that you want to filter the ListTaskDefinitions results with.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListTaskDefinitionsRequest	withFamilyPrefix(String familyPrefix) The full family name that you want to filter the ListTaskDefinitions results with.
ListTaskDefinitionsRequest	withMaxResults(Integer maxResults) The maximum number of task definition results returned by ListTaskDefinitions in paginated output.
ListTaskDefinitionsRequest	withNextToken(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	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(String status) The task definition status that you want to filter the ListTaskDefinitions results with.
ListTaskDefinitionsRequest	withStatus(TaskDefinitionStatus status) The task definition status that you want to filter the ListTaskDefinitions results with.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListTaskDefinitionsRequest

public ListTaskDefinitionsRequest()

Method Detail

getFamilyPrefix

public String getFamilyPrefix()

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

Returns:

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

setFamilyPrefix

public void setFamilyPrefix(String familyPrefix)

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

Parameters:

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

withFamilyPrefix

public ListTaskDefinitionsRequest withFamilyPrefix(String familyPrefix)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getStatus

public String getStatus()

The task definition status that you want 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.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Returns:

The task definition status that you want 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.

See Also:

TaskDefinitionStatus

setStatus

public void setStatus(String status)

The task definition status that you want 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.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

status - The task definition status that you want 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.

See Also:

TaskDefinitionStatus

withStatus

public ListTaskDefinitionsRequest withStatus(String status)

The task definition status that you want 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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

status - The task definition status that you want 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:

A reference to this updated object so that method calls can be chained together.

See Also:

TaskDefinitionStatus

setStatus

public void setStatus(TaskDefinitionStatus status)

The task definition status that you want 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.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

status - The task definition status that you want 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.

See Also:

TaskDefinitionStatus

withStatus

public ListTaskDefinitionsRequest withStatus(TaskDefinitionStatus status)

The task definition status that you want 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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

status - The task definition status that you want 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:

A reference to this updated object so that method calls can be chained together.

See Also:

TaskDefinitionStatus

getSort

public String getSort()

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.

Constraints:
Allowed Values: ASC, DESC

Returns:

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.

See Also:

SortOrder

setSort

public void setSort(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.

Constraints:
Allowed Values: ASC, DESC

Parameters:

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.

See Also:

SortOrder

withSort

public ListTaskDefinitionsRequest withSort(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.

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

Constraints:
Allowed Values: ASC, DESC

Parameters:

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.

Returns:

A reference to this updated 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 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.

Constraints:
Allowed Values: ASC, DESC

Parameters:

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.

See Also:

SortOrder

withSort

public ListTaskDefinitionsRequest withSort(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.

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

Constraints:
Allowed Values: ASC, DESC

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

SortOrder

getNextToken

public String getNextToken()

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.

Returns:

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.

setNextToken

public void setNextToken(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.

Parameters:

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.

withNextToken

public ListTaskDefinitionsRequest withNextToken(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.

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

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public Integer getMaxResults()

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.

Returns:

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.

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

Parameters:

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.

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

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

Parameters:

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.

Returns:

A reference to this updated 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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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 class AmazonWebServiceRequest

See Also:

Object.clone()