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

Class DescribeJobDefinitionsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeJobDefinitionsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeJobDefinitionsRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	jobDefinitionName()	The name of the job definition to describe.
List<String>	jobDefinitions()	A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
Integer	maxResults()	The maximum number of results returned by DescribeJobDefinitions in paginated output.
String	nextToken()	The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter.
static Class<? extends DescribeJobDefinitionsRequest.Builder>	serializableBuilderClass()
String	status()	The status with which to filter job definitions.
DescribeJobDefinitionsRequest.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

jobDefinitions

public List<String> jobDefinitions()

A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

Returns:

A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

maxResults

public Integer maxResults()

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

Returns:

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

jobDefinitionName

public String jobDefinitionName()

The name of the job definition to describe.

Returns:

The name of the job definition to describe.

status

public String status()

The status with which to filter job definitions.

Returns:

The status with which to filter job definitions.

nextToken

public String nextToken()

The nextToken value returned from a previous paginated DescribeJobDefinitions 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 DescribeJobDefinitions 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 DescribeJobDefinitionsRequest.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<DescribeJobDefinitionsRequest.Builder,DescribeJobDefinitionsRequest>

Returns:

a builder for type T

builder

public static DescribeJobDefinitionsRequest.Builder builder()

serializableBuilderClass

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