@Generated(value="software.amazon.awssdk:codegen") public final class DescribeJobDefinitionsRequest extends BatchRequest implements ToCopyableBuilder<DescribeJobDefinitionsRequest.Builder,DescribeJobDefinitionsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeJobDefinitionsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeJobDefinitionsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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() |
overrideConfiguration
copy
public List<String> jobDefinitions()
A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
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.public String jobDefinitionName()
The name of the job definition to describe.
public String status()
The status with which to filter job definitions.
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.
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.
public DescribeJobDefinitionsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeJobDefinitionsRequest.Builder,DescribeJobDefinitionsRequest>
toBuilder
in class BatchRequest
public static DescribeJobDefinitionsRequest.Builder builder()
public static Class<? extends DescribeJobDefinitionsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.