Package software.amazon.awssdk.services.ecs.model

Class DescribeContainerInstancesRequest

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

  • Method Details

    • cluster

      public final String cluster()

      The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

      Returns:
      The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

    • hasContainerInstances

      public final boolean hasContainerInstances()
      For responses, this returns true if the service returned a value for the ContainerInstances 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.

    • containerInstances

      public final List<String> containerInstances()

      A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

      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 hasContainerInstances() method.

      Returns:
      A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

    • include

      public final List<ContainerInstanceField> include()

      Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.

      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:
      Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.

    • 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()

      Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.

      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:
      Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.

    • toBuilder

      public DescribeContainerInstancesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeContainerInstancesRequest.Builder,DescribeContainerInstancesRequest>
      Specified by:
      toBuilder in class EcsRequest

    • builder

      public static DescribeContainerInstancesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeContainerInstancesRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo