Class DescribeClustersRequest

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

  • Method Details

    • hasClusters

      public final boolean hasClusters()
      For responses, this returns true if the service returned a value for the Clusters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • clusters

      public final List<String> clusters()

      A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClusters() method.

      Returns:
      A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

    • include

      public final List<ClusterField> include()

      Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

      If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

      If SETTINGS is specified, the settings for the cluster are included.

      If CONFIGURATIONS is specified, the configuration for the cluster is included.

      If STATISTICS is specified, the task and service count is included, separated by launch type.

      If TAGS is specified, the metadata tags associated with the cluster are included.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInclude() method.

      Returns:
      Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

      If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

      If SETTINGS is specified, the settings for the cluster are included.

      If CONFIGURATIONS is specified, the configuration for the cluster is included.

      If STATISTICS is specified, the task and service count is included, separated by launch type.

      If TAGS is specified, the metadata tags associated with the cluster are included.

    • hasInclude

      public final boolean hasInclude()
      For responses, this returns true if the service returned a value for the Include property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • includeAsStrings

      public final List<String> includeAsStrings()

      Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

      If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

      If SETTINGS is specified, the settings for the cluster are included.

      If CONFIGURATIONS is specified, the configuration for the cluster is included.

      If STATISTICS is specified, the task and service count is included, separated by launch type.

      If TAGS is specified, the metadata tags associated with the cluster are included.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInclude() method.

      Returns:
      Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

      If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

      If SETTINGS is specified, the settings for the cluster are included.

      If CONFIGURATIONS is specified, the configuration for the cluster is included.

      If STATISTICS is specified, the task and service count is included, separated by launch type.

      If TAGS is specified, the metadata tags associated with the cluster are included.

    • toBuilder

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

    • builder

      public static DescribeClustersRequest.Builder builder()

    • serializableBuilderClass

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