Class ListTaskDefinitionFamiliesRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
ThefamilyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
.The maximum number of task definition family results returned byListTaskDefinitionFamilies
in paginated output.ThenextToken
value returned from a previous paginatedListTaskDefinitionFamilies
request wheremaxResults
was used and the results exceeded the value of that parameter.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
The task definition family status with which to filter theListTaskDefinitionFamilies
results.toString()
Returns a string representation of this object; useful for testing and debugging.withFamilyPrefix
(String familyPrefix) ThefamilyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
.withMaxResults
(Integer maxResults) The maximum number of task definition family results returned byListTaskDefinitionFamilies
in paginated output.withNextToken
(String nextToken) ThenextToken
value returned from a previous paginatedListTaskDefinitionFamilies
request wheremaxResults
was used and the results exceeded the value of that parameter.withStatus
(TaskDefinitionFamilyStatus status) The task definition family status with which to filter theListTaskDefinitionFamilies
results.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
-
Constructor Details
-
ListTaskDefinitionFamiliesRequest
public ListTaskDefinitionFamiliesRequest()
-
-
Method Details
-
setFamilyPrefix
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
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
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
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:
-
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:
-
withStatus
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:
-
setStatus
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:
-
withStatus
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:
-
setNextToken
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-