Package software.amazon.awssdk.services.batch.model

Class DescribeComputeEnvironmentsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.batch.model.BatchRequest
software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeComputeEnvironmentsRequest.Builder,DescribeComputeEnvironmentsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeComputeEnvironmentsRequest extends BatchRequest implements ToCopyableBuilder<DescribeComputeEnvironmentsRequest.Builder,DescribeComputeEnvironmentsRequest>

Contains the parameters for DescribeComputeEnvironments.

  • Method Details

    • hasComputeEnvironments

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

    • computeEnvironments

      public final List<String> computeEnvironments()

      A list of up to 100 compute environment names 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 hasComputeEnvironments() method.

      Returns:
      A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

    • maxResults

      public final Integer maxResults()

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

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

    • nextToken

      public final String nextToken()

      The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

      Returns:
      The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

    • toBuilder

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

    • builder

      public static DescribeComputeEnvironmentsRequest.Builder builder()

    • serializableBuilderClass

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