com.amazonaws.services.batch.model

Class ListJobsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.batch.model.ListJobsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListJobsRequest()

Method Summary

Modifier and Type	Method and Description
ListJobsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getArrayJobId() The job ID for an array job.
String	getJobQueue() The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
String	getJobStatus() The job status with which to filter jobs in the specified queue.
Integer	getMaxResults() The maximum number of results returned by ListJobs in paginated output.
String	getMultiNodeJobId() The job ID for a multi-node parallel job.
String	getNextToken() The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter.
int	hashCode()
void	setArrayJobId(String arrayJobId) The job ID for an array job.
void	setJobQueue(String jobQueue) The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
void	setJobStatus(JobStatus jobStatus) The job status with which to filter jobs in the specified queue.
void	setJobStatus(String jobStatus) The job status with which to filter jobs in the specified queue.
void	setMaxResults(Integer maxResults) The maximum number of results returned by ListJobs in paginated output.
void	setMultiNodeJobId(String multiNodeJobId) The job ID for a multi-node parallel job.
void	setNextToken(String nextToken) The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter.
String	toString() Returns a string representation of this object.
ListJobsRequest	withArrayJobId(String arrayJobId) The job ID for an array job.
ListJobsRequest	withJobQueue(String jobQueue) The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
ListJobsRequest	withJobStatus(JobStatus jobStatus) The job status with which to filter jobs in the specified queue.
ListJobsRequest	withJobStatus(String jobStatus) The job status with which to filter jobs in the specified queue.
ListJobsRequest	withMaxResults(Integer maxResults) The maximum number of results returned by ListJobs in paginated output.
ListJobsRequest	withMultiNodeJobId(String multiNodeJobId) The job ID for a multi-node parallel job.
ListJobsRequest	withNextToken(String nextToken) The nextToken value returned from a previous paginated ListJobs 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

ListJobsRequest

public ListJobsRequest()

Method Detail

setJobQueue

public void setJobQueue(String jobQueue)

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

Parameters:

jobQueue - The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

getJobQueue

public String getJobQueue()

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

Returns:

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

withJobQueue

public ListJobsRequest withJobQueue(String jobQueue)

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

Parameters:

jobQueue - The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

Returns:

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

setArrayJobId

public void setArrayJobId(String arrayJobId)

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Parameters:

arrayJobId - The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

getArrayJobId

public String getArrayJobId()

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Returns:

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

withArrayJobId

public ListJobsRequest withArrayJobId(String arrayJobId)

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Parameters:

arrayJobId - The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Returns:

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

setMultiNodeJobId

public void setMultiNodeJobId(String multiNodeJobId)

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

Parameters:

multiNodeJobId - The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

getMultiNodeJobId

public String getMultiNodeJobId()

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

Returns:

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

withMultiNodeJobId

public ListJobsRequest withMultiNodeJobId(String multiNodeJobId)

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

Parameters:

multiNodeJobId - The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

Returns:

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

setJobStatus

public void setJobStatus(String jobStatus)

The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

Parameters:

jobStatus - The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

See Also:

JobStatus

getJobStatus

public String getJobStatus()

The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

Returns:

The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

See Also:

JobStatus

withJobStatus

public ListJobsRequest withJobStatus(String jobStatus)

The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

Parameters:

jobStatus - The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

Returns:

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

See Also:

JobStatus

setJobStatus

public void setJobStatus(JobStatus jobStatus)

The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

Parameters:

jobStatus - The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

See Also:

JobStatus

withJobStatus

public ListJobsRequest withJobStatus(JobStatus jobStatus)

The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

Parameters:

jobStatus - The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

Returns:

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

See Also:

JobStatus

setMaxResults

public void setMaxResults(Integer maxResults)

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

Parameters:

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

getMaxResults

public Integer getMaxResults()

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

Returns:

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

withMaxResults

public ListJobsRequest withMaxResults(Integer maxResults)

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

Parameters:

maxResults - The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs 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 ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListJobs 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 ListJobs 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.

Parameters:

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

getNextToken

public String getNextToken()

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

withNextToken

public ListJobsRequest withNextToken(String nextToken)

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

Parameters:

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

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