Class ListTaskDefinitionsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListTaskDefinitionsRequest.Builder,
ListTaskDefinitionsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The full family name to filter theListTaskDefinitions
results with.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
The maximum number of task definition results thatListTaskDefinitions
returned in paginated output.final String
ThenextToken
value returned from aListTaskDefinitions
request indicating that more results are available to fulfill the request and further calls will be needed.static Class
<? extends ListTaskDefinitionsRequest.Builder> final SortOrder
sort()
The order to sort the results in.final String
The order to sort the results in.final TaskDefinitionStatus
status()
The task definition status to filter theListTaskDefinitions
results with.final String
The task definition status to filter theListTaskDefinitions
results with.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
familyPrefix
The full family name to filter the
ListTaskDefinitions
results with. Specifying afamilyPrefix
limits the listed task definitions to task definition revisions that belong to that family.- Returns:
- The full family name to filter the
ListTaskDefinitions
results with. Specifying afamilyPrefix
limits the listed task definitions to task definition revisions that belong to that family.
-
status
The task definition status to filter the
ListTaskDefinitions
results with. 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.If the service returns an enum value that is not available in the current SDK version,
status
will returnTaskDefinitionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The task definition status to filter the
ListTaskDefinitions
results with. 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:
-
statusAsString
The task definition status to filter the
ListTaskDefinitions
results with. 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.If the service returns an enum value that is not available in the current SDK version,
status
will returnTaskDefinitionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The task definition status to filter the
ListTaskDefinitions
results with. 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:
-
sort
The order to sort the results in. 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. This is so that the newest task definitions in a family are listed first.If the service returns an enum value that is not available in the current SDK version,
sort
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortAsString()
.- Returns:
- The order to sort the results in. 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. This is so that the newest task definitions in a family are listed first. - See Also:
-
sortAsString
The order to sort the results in. 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. This is so that the newest task definitions in a family are listed first.If the service returns an enum value that is not available in the current SDK version,
sort
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortAsString()
.- Returns:
- The order to sort the results in. 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. This is so that the newest task definitions in a family are listed first. - See Also:
-
nextToken
The
nextToken
value returned from aListTaskDefinitions
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it is possible the number of results to be fewer thanmaxResults
.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 aListTaskDefinitions
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it is possible the number of results to be fewer thanmaxResults
.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.
-
maxResults
The maximum number of task definition results that
ListTaskDefinitions
returned 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 isn't used, thenListTaskDefinitions
returns up to 100 results and anextToken
value if applicable.- Returns:
- The maximum number of task definition results that
ListTaskDefinitions
returned 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 isn't used, thenListTaskDefinitions
returns up to 100 results and anextToken
value if applicable.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListTaskDefinitionsRequest.Builder,
ListTaskDefinitionsRequest> - Specified by:
toBuilder
in classEcsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-