Class ListTaskDefinitionFamiliesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.ecs.model.ListTaskDefinitionFamiliesRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class ListTaskDefinitionFamiliesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ListTaskDefinitionFamiliesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListTaskDefinitionFamiliesRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getFamilyPrefix()
ThefamilyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
.Integer
getMaxResults()
The maximum number of task definition family results returned byListTaskDefinitionFamilies
in paginated output.String
getNextToken()
ThenextToken
value returned from a previous paginatedListTaskDefinitionFamilies
request wheremaxResults
was used and the results exceeded the value of that parameter.String
getStatus()
The task definition family status with which to filter theListTaskDefinitionFamilies
results.int
hashCode()
void
setFamilyPrefix(String familyPrefix)
ThefamilyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
.void
setMaxResults(Integer maxResults)
The maximum number of task definition family results returned byListTaskDefinitionFamilies
in paginated output.void
setNextToken(String nextToken)
ThenextToken
value returned from a previous paginatedListTaskDefinitionFamilies
request wheremaxResults
was used and the results exceeded the value of that parameter.void
setStatus(TaskDefinitionFamilyStatus status)
The task definition family status with which to filter theListTaskDefinitionFamilies
results.void
setStatus(String status)
The task definition family status with which to filter theListTaskDefinitionFamilies
results.String
toString()
Returns a string representation of this object; useful for testing and debugging.ListTaskDefinitionFamiliesRequest
withFamilyPrefix(String familyPrefix)
ThefamilyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
.ListTaskDefinitionFamiliesRequest
withMaxResults(Integer maxResults)
The maximum number of task definition family results returned byListTaskDefinitionFamilies
in paginated output.ListTaskDefinitionFamiliesRequest
withNextToken(String nextToken)
ThenextToken
value returned from a previous paginatedListTaskDefinitionFamilies
request wheremaxResults
was used and the results exceeded the value of that parameter.ListTaskDefinitionFamiliesRequest
withStatus(TaskDefinitionFamilyStatus status)
The task definition family status with which to filter theListTaskDefinitionFamilies
results.ListTaskDefinitionFamiliesRequest
withStatus(String status)
The task definition family status with which to filter theListTaskDefinitionFamilies
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
familyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
. If you specify afamilyPrefix
, only task definition family names that begin with thefamilyPrefix
string are returned.- Parameters:
familyPrefix
- ThefamilyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
. If you specify afamilyPrefix
, only task definition family names that begin with thefamilyPrefix
string are returned.
-
getFamilyPrefix
public String getFamilyPrefix()
The
familyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
. If you specify afamilyPrefix
, only task definition family names that begin with thefamilyPrefix
string are returned.- Returns:
- The
familyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
. If you specify afamilyPrefix
, only task definition family names that begin with thefamilyPrefix
string are returned.
-
withFamilyPrefix
public ListTaskDefinitionFamiliesRequest withFamilyPrefix(String familyPrefix)
The
familyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
. If you specify afamilyPrefix
, only task definition family names that begin with thefamilyPrefix
string are returned.- Parameters:
familyPrefix
- ThefamilyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
. If you specify afamilyPrefix
, only task definition family names that begin with thefamilyPrefix
string are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatus
public void setStatus(String status)
The task definition family status with which to filter the
ListTaskDefinitionFamilies
results. By default, bothACTIVE
andINACTIVE
task definition families are listed. If this parameter is set toACTIVE
, only task definition families that have anACTIVE
task definition revision are returned. If this parameter is set toINACTIVE
, only task definition families that do not have anyACTIVE
task definition revisions are returned. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- Parameters:
status
- The task definition family status with which to filter theListTaskDefinitionFamilies
results. By default, bothACTIVE
andINACTIVE
task definition families are listed. If this parameter is set toACTIVE
, only task definition families that have anACTIVE
task definition revision are returned. If this parameter is set toINACTIVE
, only task definition families that do not have anyACTIVE
task definition revisions are returned. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- See Also:
TaskDefinitionFamilyStatus
-
getStatus
public String getStatus()
The task definition family status with which to filter the
ListTaskDefinitionFamilies
results. By default, bothACTIVE
andINACTIVE
task definition families are listed. If this parameter is set toACTIVE
, only task definition families that have anACTIVE
task definition revision are returned. If this parameter is set toINACTIVE
, only task definition families that do not have anyACTIVE
task definition revisions are returned. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- Returns:
- The task definition family status with which to filter the
ListTaskDefinitionFamilies
results. By default, bothACTIVE
andINACTIVE
task definition families are listed. If this parameter is set toACTIVE
, only task definition families that have anACTIVE
task definition revision are returned. If this parameter is set toINACTIVE
, only task definition families that do not have anyACTIVE
task definition revisions are returned. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request. - See Also:
TaskDefinitionFamilyStatus
-
withStatus
public ListTaskDefinitionFamiliesRequest withStatus(String status)
The task definition family status with which to filter the
ListTaskDefinitionFamilies
results. By default, bothACTIVE
andINACTIVE
task definition families are listed. If this parameter is set toACTIVE
, only task definition families that have anACTIVE
task definition revision are returned. If this parameter is set toINACTIVE
, only task definition families that do not have anyACTIVE
task definition revisions are returned. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- Parameters:
status
- The task definition family status with which to filter theListTaskDefinitionFamilies
results. By default, bothACTIVE
andINACTIVE
task definition families are listed. If this parameter is set toACTIVE
, only task definition families that have anACTIVE
task definition revision are returned. If this parameter is set toINACTIVE
, only task definition families that do not have anyACTIVE
task definition revisions are returned. 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:
TaskDefinitionFamilyStatus
-
setStatus
public void setStatus(TaskDefinitionFamilyStatus status)
The task definition family status with which to filter the
ListTaskDefinitionFamilies
results. By default, bothACTIVE
andINACTIVE
task definition families are listed. If this parameter is set toACTIVE
, only task definition families that have anACTIVE
task definition revision are returned. If this parameter is set toINACTIVE
, only task definition families that do not have anyACTIVE
task definition revisions are returned. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- Parameters:
status
- The task definition family status with which to filter theListTaskDefinitionFamilies
results. By default, bothACTIVE
andINACTIVE
task definition families are listed. If this parameter is set toACTIVE
, only task definition families that have anACTIVE
task definition revision are returned. If this parameter is set toINACTIVE
, only task definition families that do not have anyACTIVE
task definition revisions are returned. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- See Also:
TaskDefinitionFamilyStatus
-
withStatus
public ListTaskDefinitionFamiliesRequest withStatus(TaskDefinitionFamilyStatus status)
The task definition family status with which to filter the
ListTaskDefinitionFamilies
results. By default, bothACTIVE
andINACTIVE
task definition families are listed. If this parameter is set toACTIVE
, only task definition families that have anACTIVE
task definition revision are returned. If this parameter is set toINACTIVE
, only task definition families that do not have anyACTIVE
task definition revisions are returned. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.- Parameters:
status
- The task definition family status with which to filter theListTaskDefinitionFamilies
results. By default, bothACTIVE
andINACTIVE
task definition families are listed. If this parameter is set toACTIVE
, only task definition families that have anACTIVE
task definition revision are returned. If this parameter is set toINACTIVE
, only task definition families that do not have anyACTIVE
task definition revisions are returned. 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:
TaskDefinitionFamilyStatus
-
setNextToken
public void setNextToken(String nextToken)
The
nextToken
value returned from a previous paginatedListTaskDefinitionFamilies
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 paginatedListTaskDefinitionFamilies
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 paginatedListTaskDefinitionFamilies
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 paginatedListTaskDefinitionFamilies
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 ListTaskDefinitionFamiliesRequest withNextToken(String nextToken)
The
nextToken
value returned from a previous paginatedListTaskDefinitionFamilies
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 paginatedListTaskDefinitionFamilies
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 family results returned by
ListTaskDefinitionFamilies
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 anotherListTaskDefinitionFamilies
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitionFamilies
returns up to 100 results and anextToken
value if applicable.- Parameters:
maxResults
- The maximum number of task definition family results returned byListTaskDefinitionFamilies
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 anotherListTaskDefinitionFamilies
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitionFamilies
returns up to 100 results and anextToken
value if applicable.
-
getMaxResults
public Integer getMaxResults()
The maximum number of task definition family results returned by
ListTaskDefinitionFamilies
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 anotherListTaskDefinitionFamilies
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitionFamilies
returns up to 100 results and anextToken
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 returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitionFamilies
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitionFamilies
returns up to 100 results and anextToken
value if applicable.
-
withMaxResults
public ListTaskDefinitionFamiliesRequest withMaxResults(Integer maxResults)
The maximum number of task definition family results returned by
ListTaskDefinitionFamilies
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 anotherListTaskDefinitionFamilies
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitionFamilies
returns up to 100 results and anextToken
value if applicable.- Parameters:
maxResults
- The maximum number of task definition family results returned byListTaskDefinitionFamilies
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 anotherListTaskDefinitionFamilies
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitionFamilies
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 ListTaskDefinitionFamiliesRequest 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()
-
-