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(value="software.amazon.awssdk:codegen")
public final class DescribeComputeEnvironmentsRequest
extends BatchRequest
implements ToCopyableBuilder<DescribeComputeEnvironmentsRequest.Builder,DescribeComputeEnvironmentsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeComputeEnvironmentsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeComputeEnvironmentsRequest.Builder	builder()
List<String>	computeEnvironments() A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeComputeEnvironmentsRequest.Builder>	serializableBuilderClass()
DescribeComputeEnvironmentsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

computeEnvironments

public 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.

Returns:

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

maxResults

public 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 is not 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 is not used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

nextToken

public 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.

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 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.

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.

toBuilder

public DescribeComputeEnvironmentsRequest.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<DescribeComputeEnvironmentsRequest.Builder,DescribeComputeEnvironmentsRequest>

Specified by:

toBuilder in class BatchRequest

Returns:

a builder for type T

builder

public static DescribeComputeEnvironmentsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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 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.