Class ListServicesRequest

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

  • Method Details

    • cluster

      public final String cluster()

      The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.

      Returns:
      The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.

    • nextToken

      public final String nextToken()

      The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible 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 ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible 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 service results that ListServices returned in paginated output. When this parameter is used, ListServices 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 ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a nextToken value if applicable.

      Returns:
      The maximum number of service results that ListServices returned in paginated output. When this parameter is used, ListServices 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 ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a nextToken value if applicable.

    • launchType

      public final LaunchType launchType()

      The launch type to use when filtering the ListServices results.

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

      Returns:
      The launch type to use when filtering the ListServices results.
      See Also:

    • launchTypeAsString

      public final String launchTypeAsString()

      The launch type to use when filtering the ListServices results.

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

      Returns:
      The launch type to use when filtering the ListServices results.
      See Also:

    • schedulingStrategy

      public final SchedulingStrategy schedulingStrategy()

      The scheduling strategy to use when filtering the ListServices results.

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

      Returns:
      The scheduling strategy to use when filtering the ListServices results.
      See Also:

    • schedulingStrategyAsString

      public final String schedulingStrategyAsString()

      The scheduling strategy to use when filtering the ListServices results.

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

      Returns:
      The scheduling strategy to use when filtering the ListServices results.
      See Also:

    • toBuilder

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

    • builder

      public static ListServicesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListServicesRequest.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.