com.amazonaws.services.batch.model

Class DescribeJobQueuesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.batch.model.DescribeJobQueuesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Contains the parameters for DescribeJobQueues.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeJobQueuesRequest()

Method Summary

Modifier and Type	Method and Description
DescribeJobQueuesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getJobQueues() A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
Integer	getMaxResults() The maximum number of results returned by DescribeJobQueues in paginated output.
String	getNextToken() The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter.
int	hashCode()
void	setJobQueues(Collection<String> jobQueues) A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
void	setMaxResults(Integer maxResults) The maximum number of results returned by DescribeJobQueues in paginated output.
void	setNextToken(String nextToken) The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter.
String	toString() Returns a string representation of this object.
DescribeJobQueuesRequest	withJobQueues(Collection<String> jobQueues) A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
DescribeJobQueuesRequest	withJobQueues(String... jobQueues) A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
DescribeJobQueuesRequest	withMaxResults(Integer maxResults) The maximum number of results returned by DescribeJobQueues in paginated output.
DescribeJobQueuesRequest	withNextToken(String nextToken) The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeJobQueuesRequest

public DescribeJobQueuesRequest()

Method Detail

getJobQueues

public List<String> getJobQueues()

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

Returns:

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

setJobQueues

public void setJobQueues(Collection<String> jobQueues)

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

Parameters:

jobQueues - A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

withJobQueues

public DescribeJobQueuesRequest withJobQueues(String... jobQueues)

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

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

Parameters:

jobQueues - A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Returns:

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

withJobQueues

public DescribeJobQueuesRequest withJobQueues(Collection<String> jobQueues)

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

Parameters:

jobQueues - A list of up to 100 queue names or full queue 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 results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

Parameters:

maxResults - The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

getMaxResults

public Integer getMaxResults()

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

Returns:

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

withMaxResults

public DescribeJobQueuesRequest withMaxResults(Integer maxResults)

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

Parameters:

maxResults - The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues 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 DescribeJobQueues 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.

Parameters:

nextToken - The nextToken value returned from a previous paginated DescribeJobQueues 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.

getNextToken

public String getNextToken()

The nextToken value returned from a previous paginated DescribeJobQueues 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 DescribeJobQueues 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.

withNextToken

public DescribeJobQueuesRequest withNextToken(String nextToken)

The nextToken value returned from a previous paginated DescribeJobQueues 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.

Parameters:

nextToken - The nextToken value returned from a previous paginated DescribeJobQueues 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:

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 DescribeJobQueuesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()