@Generated(value="software.amazon.awssdk:codegen") public final class DescribeJobDefinitionsRequest extends BatchRequest implements ToCopyableBuilder<DescribeJobDefinitionsRequest.Builder,DescribeJobDefinitionsRequest>
Contains the parameters for DescribeJobDefinitions.
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeJobDefinitionsRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static DescribeJobDefinitionsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasJobDefinitions()
For responses, this returns true if the service returned a value for the JobDefinitions property.
|
String |
jobDefinitionName()
The name of the job definition to describe.
|
List<String> |
jobDefinitions()
A list of up to 100 job definitions.
|
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. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeJobDefinitionsRequest.Builder> |
serializableBuilderClass() |
String |
status()
The status used to filter job definitions.
|
DescribeJobDefinitionsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasJobDefinitions()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> jobDefinitions()
A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format
arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short
version using the form ${JobDefinitionName}:${Revision}.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasJobDefinitions() method.
arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a
short version using the form ${JobDefinitionName}:${Revision}.public final 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 and 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 isn't 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 and 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 isn't used, then
DescribeJobDefinitions returns up to 100 results and a nextToken value if
applicable.public final String jobDefinitionName()
The name of the job definition to describe.
public final String status()
The status used to filter job definitions.
public final 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.
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.
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. 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.
public DescribeJobDefinitionsRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeJobDefinitionsRequest.Builder,DescribeJobDefinitionsRequest>toBuilder in class BatchRequestpublic static DescribeJobDefinitionsRequest.Builder builder()
public static Class<? extends DescribeJobDefinitionsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.