Class ListTaskDefinitionsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ecs.model.EcsRequest
-
- software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListTaskDefinitionsRequest.Builder,ListTaskDefinitionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListTaskDefinitionsRequest extends EcsRequest implements ToCopyableBuilder<ListTaskDefinitionsRequest.Builder,ListTaskDefinitionsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ListTaskDefinitionsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListTaskDefinitionsRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
familyPrefix()
The full family name to filter theListTaskDefinitions
results with.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Integer
maxResults()
The maximum number of task definition results thatListTaskDefinitions
returned in paginated output.String
nextToken()
ThenextToken
value returned from aListTaskDefinitions
request indicating that more results are available to fulfill the request and further calls will be needed.List<SdkField<?>>
sdkFields()
static Class<? extends ListTaskDefinitionsRequest.Builder>
serializableBuilderClass()
SortOrder
sort()
The order to sort the results in.String
sortAsString()
The order to sort the results in.TaskDefinitionStatus
status()
The task definition status to filter theListTaskDefinitions
results with.String
statusAsString()
The task definition status to filter theListTaskDefinitions
results with.ListTaskDefinitionsRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
familyPrefix
public final String 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
public final TaskDefinitionStatus 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:
TaskDefinitionStatus
-
statusAsString
public final String 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:
TaskDefinitionStatus
-
sort
public final SortOrder 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:
SortOrder
-
sortAsString
public final String 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:
SortOrder
-
nextToken
public final String 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
public final Integer 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
public ListTaskDefinitionsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListTaskDefinitionsRequest.Builder,ListTaskDefinitionsRequest>
- Specified by:
toBuilder
in classEcsRequest
-
builder
public static ListTaskDefinitionsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListTaskDefinitionsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-