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

Class ListJobsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.batch.model.ListJobsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

@Generated("software.amazon.awssdk:codegen")
public class ListJobsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListJobsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static ListJobsRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	jobQueue()	The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
String	jobStatus()	The job status with which to filter jobs in the specified queue.
Integer	maxResults()	The maximum number of results returned by ListJobs in paginated output.
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.
static Class<? extends ListJobsRequest.Builder>	serializableBuilderClass()
ListJobsRequest.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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

jobQueue

public String jobQueue()

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.

jobStatus

public String jobStatus()

The job status with which to filter jobs in the specified queue.

Returns:

The job status with which to filter jobs in the specified queue.

See Also:

JobStatus

maxResults

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

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.

nextToken

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

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.

toBuilder

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

Returns:

a builder for type T

builder

public static ListJobsRequest.Builder builder()

serializableBuilderClass

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