com.amazonaws.services.batch.model

Class DescribeComputeEnvironmentsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.batch.model.DescribeComputeEnvironmentsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeComputeEnvironmentsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Contains the parameters for DescribeComputeEnvironments.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeComputeEnvironmentsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeComputeEnvironmentsRequest	clone()
boolean	equals(Object obj)
List<String>	getComputeEnvironments() A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
Integer	getMaxResults() The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output.
String	getNextToken() The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter.
int	hashCode()
void	setComputeEnvironments(Collection<String> computeEnvironments) A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
void	setMaxResults(Integer maxResults) The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output.
void	setNextToken(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.
String	toString() Returns a string representation of this object.
DescribeComputeEnvironmentsRequest	withComputeEnvironments(Collection<String> computeEnvironments) A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
DescribeComputeEnvironmentsRequest	withComputeEnvironments(String... computeEnvironments) A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
DescribeComputeEnvironmentsRequest	withMaxResults(Integer maxResults) The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output.
DescribeComputeEnvironmentsRequest	withNextToken(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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeComputeEnvironmentsRequest

public DescribeComputeEnvironmentsRequest()

Method Detail

getComputeEnvironments

public List<String> getComputeEnvironments()

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

Returns:

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

setComputeEnvironments

public void setComputeEnvironments(Collection<String> computeEnvironments)

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

Parameters:

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

withComputeEnvironments

public DescribeComputeEnvironmentsRequest withComputeEnvironments(String... computeEnvironments)

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

NOTE: This method appends the values to the existing list (if any). Use setComputeEnvironments(java.util.Collection) or withComputeEnvironments(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withComputeEnvironments

public DescribeComputeEnvironmentsRequest withComputeEnvironments(Collection<String> computeEnvironments)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(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.

Parameters:

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.

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public DescribeComputeEnvironmentsRequest withMaxResults(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(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's only used to retrieve the next items in a list and not for other programmatic purposes.

Parameters:

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's only used to retrieve the next items in a list and not for other programmatic purposes.

getNextToken

public String getNextToken()

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

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

withNextToken

public DescribeComputeEnvironmentsRequest withNextToken(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's only used to retrieve the next items in a list and not for other programmatic purposes.

Parameters:

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's only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeComputeEnvironmentsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest