Class ListDaemonTaskDefinitionsRequest

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.ListDaemonTaskDefinitionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListDaemonTaskDefinitionsRequest.Builder,ListDaemonTaskDefinitionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListDaemonTaskDefinitionsRequest extends EcsRequest implements ToCopyableBuilder<ListDaemonTaskDefinitionsRequest.Builder,ListDaemonTaskDefinitionsRequest>

  • Method Details

    • familyPrefix

      public final String familyPrefix()

      The full family name to filter the ListDaemonTaskDefinitions results with. Specifying a familyPrefix limits the listed daemon task definitions to daemon task definition families that start with the familyPrefix string.

      Returns:
      The full family name to filter the ListDaemonTaskDefinitions results with. Specifying a familyPrefix limits the listed daemon task definitions to daemon task definition families that start with the familyPrefix string.

    • family

      public final String family()

      The exact name of the daemon task definition family to filter results with.

      Returns:
      The exact name of the daemon task definition family to filter results with.

    • revision

      public final DaemonTaskDefinitionRevisionFilter revision()

      The revision filter to apply. Specify LAST_REGISTERED to return only the last registered revision for each daemon task definition family.

      If the service returns an enum value that is not available in the current SDK version, revision will return DaemonTaskDefinitionRevisionFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from revisionAsString().

      Returns:
      The revision filter to apply. Specify LAST_REGISTERED to return only the last registered revision for each daemon task definition family.
      See Also:

    • revisionAsString

      public final String revisionAsString()

      The revision filter to apply. Specify LAST_REGISTERED to return only the last registered revision for each daemon task definition family.

      If the service returns an enum value that is not available in the current SDK version, revision will return DaemonTaskDefinitionRevisionFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from revisionAsString().

      Returns:
      The revision filter to apply. Specify LAST_REGISTERED to return only the last registered revision for each daemon task definition family.
      See Also:

    • status

      public final DaemonTaskDefinitionStatusFilter status()

      The daemon task definition status to filter the ListDaemonTaskDefinitions results with. By default, only ACTIVE daemon task definitions are listed. If you set this parameter to DELETE_IN_PROGRESS, only daemon task definitions that are in the process of being deleted are listed. If you set this parameter to ALL, all daemon task definitions are listed regardless of status.

      If the service returns an enum value that is not available in the current SDK version, status will return DaemonTaskDefinitionStatusFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The daemon task definition status to filter the ListDaemonTaskDefinitions results with. By default, only ACTIVE daemon task definitions are listed. If you set this parameter to DELETE_IN_PROGRESS, only daemon task definitions that are in the process of being deleted are listed. If you set this parameter to ALL, all daemon task definitions are listed regardless of status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The daemon task definition status to filter the ListDaemonTaskDefinitions results with. By default, only ACTIVE daemon task definitions are listed. If you set this parameter to DELETE_IN_PROGRESS, only daemon task definitions that are in the process of being deleted are listed. If you set this parameter to ALL, all daemon task definitions are listed regardless of status.

      If the service returns an enum value that is not available in the current SDK version, status will return DaemonTaskDefinitionStatusFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The daemon task definition status to filter the ListDaemonTaskDefinitions results with. By default, only ACTIVE daemon task definitions are listed. If you set this parameter to DELETE_IN_PROGRESS, only daemon task definitions that are in the process of being deleted are listed. If you set this parameter to ALL, all daemon task definitions are listed regardless of status.
      See Also:

    • sort

      public final SortOrder sort()

      The order to sort the results. Valid values are ASC and DESC. By default ( ASC), daemon task definitions are listed in ascending order by family name and revision number.

      If the service returns an enum value that is not available in the current SDK version, sort will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortAsString().

      Returns:
      The order to sort the results. Valid values are ASC and DESC. By default ( ASC), daemon task definitions are listed in ascending order by family name and revision number.
      See Also:

    • sortAsString

      public final String sortAsString()

      The order to sort the results. Valid values are ASC and DESC. By default ( ASC), daemon task definitions are listed in ascending order by family name and revision number.

      If the service returns an enum value that is not available in the current SDK version, sort will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortAsString().

      Returns:
      The order to sort the results. Valid values are ASC and DESC. By default ( ASC), daemon task definitions are listed in ascending order by family name and revision number.
      See Also:

    • nextToken

      public final String nextToken()

      The nextToken value returned from a ListDaemonTaskDefinitions request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible for the number of results to be fewer than maxResults.

      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 ListDaemonTaskDefinitions request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible for the number of results to be fewer than maxResults.

      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 daemon task definition results that ListDaemonTaskDefinitions returned in paginated output. When this parameter is used, ListDaemonTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDaemonTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListDaemonTaskDefinitions returns up to 100 results and a nextToken value if applicable.

      Returns:
      The maximum number of daemon task definition results that ListDaemonTaskDefinitions returned in paginated output. When this parameter is used, ListDaemonTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDaemonTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListDaemonTaskDefinitions returns up to 100 results and a nextToken value if applicable.

    • toBuilder

      public ListDaemonTaskDefinitionsRequest.Builder 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 interface ToCopyableBuilder<ListDaemonTaskDefinitionsRequest.Builder,ListDaemonTaskDefinitionsRequest>
      Specified by:
      toBuilder in class EcsRequest
      Returns:
      a builder for type T

    • builder

      public static ListDaemonTaskDefinitionsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListDaemonTaskDefinitionsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.