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 interfaceListTaskDefinitionsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListTaskDefinitionsRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfamilyPrefix()The full family name to filter theListTaskDefinitionsresults with.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()IntegermaxResults()The maximum number of task definition results thatListTaskDefinitionsreturned in paginated output.StringnextToken()ThenextTokenvalue returned from aListTaskDefinitionsrequest indicating that more results are available to fulfill the request and further calls will be needed.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ListTaskDefinitionsRequest.Builder>serializableBuilderClass()SortOrdersort()The order to sort the results in.StringsortAsString()The order to sort the results in.TaskDefinitionStatusstatus()The task definition status to filter theListTaskDefinitionsresults with.StringstatusAsString()The task definition status to filter theListTaskDefinitionsresults with.ListTaskDefinitionsRequest.BuildertoBuilder()StringtoString()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
ListTaskDefinitionsresults with. Specifying afamilyPrefixlimits the listed task definitions to task definition revisions that belong to that family.- Returns:
- The full family name to filter the
ListTaskDefinitionsresults with. Specifying afamilyPrefixlimits 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
ListTaskDefinitionsresults with. By default, onlyACTIVEtask definitions are listed. By setting this parameter toINACTIVE, you can view task definitions that areINACTIVEas long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatusvalue constant in each subsequent request.If the service returns an enum value that is not available in the current SDK version,
statuswill returnTaskDefinitionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The task definition status to filter the
ListTaskDefinitionsresults with. By default, onlyACTIVEtask definitions are listed. By setting this parameter toINACTIVE, you can view task definitions that areINACTIVEas long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatusvalue constant in each subsequent request. - See Also:
TaskDefinitionStatus
-
statusAsString
public final String statusAsString()
The task definition status to filter the
ListTaskDefinitionsresults with. By default, onlyACTIVEtask definitions are listed. By setting this parameter toINACTIVE, you can view task definitions that areINACTIVEas long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatusvalue constant in each subsequent request.If the service returns an enum value that is not available in the current SDK version,
statuswill returnTaskDefinitionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The task definition status to filter the
ListTaskDefinitionsresults with. By default, onlyACTIVEtask definitions are listed. By setting this parameter toINACTIVE, you can view task definitions that areINACTIVEas long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatusvalue constant in each subsequent request. - See Also:
TaskDefinitionStatus
-
sort
public final SortOrder sort()
The order to sort the results in. Valid values are
ASCandDESC. 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 toDESCreverses 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,
sortwill 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
ASCandDESC. 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 toDESCreverses 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
ASCandDESC. 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 toDESCreverses 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,
sortwill 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
ASCandDESC. 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 toDESCreverses 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
nextTokenvalue returned from aListTaskDefinitionsrequest indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResultswas 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
nextTokenvalue returned from aListTaskDefinitionsrequest indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResultswas 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
ListTaskDefinitionsreturned in paginated output. When this parameter is used,ListTaskDefinitionsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitionsrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter isn't used, thenListTaskDefinitionsreturns up to 100 results and anextTokenvalue if applicable.- Returns:
- The maximum number of task definition results that
ListTaskDefinitionsreturned in paginated output. When this parameter is used,ListTaskDefinitionsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitionsrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter isn't used, thenListTaskDefinitionsreturns up to 100 results and anextTokenvalue if applicable.
-
toBuilder
public ListTaskDefinitionsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListTaskDefinitionsRequest.Builder,ListTaskDefinitionsRequest>- Specified by:
toBuilderin classEcsRequest
-
builder
public static ListTaskDefinitionsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListTaskDefinitionsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-