Class DescribeJobDefinitionsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeJobDefinitionsRequest.Builder,
DescribeJobDefinitionsRequest>
Contains the parameters for DescribeJobDefinitions
.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the JobDefinitions property.final String
The name of the job definition to describe.A list of up to 100 job definitions.final Integer
The maximum number of results returned byDescribeJobDefinitions
in paginated output.final String
ThenextToken
value returned from a previous paginatedDescribeJobDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter.static Class
<? extends DescribeJobDefinitionsRequest.Builder> final String
status()
The status used to filter job definitions.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasJobDefinitions
public final boolean hasJobDefinitions()For responses, this returns true if the service returned a value for the JobDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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}
. This parameter can't be used with other parameters.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.- Returns:
- 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}
. This parameter can't be used with other parameters.
-
maxResults
The maximum number of results returned by
DescribeJobDefinitions
in paginated output. When this parameter is used,DescribeJobDefinitions
only returnsmaxResults
results in a single page and anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeJobDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenDescribeJobDefinitions
returns up to 100 results and anextToken
value if applicable.- Returns:
- The maximum number of results returned by
DescribeJobDefinitions
in paginated output. When this parameter is used,DescribeJobDefinitions
only returnsmaxResults
results in a single page and anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeJobDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenDescribeJobDefinitions
returns up to 100 results and anextToken
value if applicable.
-
jobDefinitionName
The name of the job definition to describe.
- Returns:
- The name of the job definition to describe.
-
status
The status used to filter job definitions.
- Returns:
- The status used to filter job definitions.
-
nextToken
The
nextToken
value returned from a previous paginatedDescribeJobDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
- Returns:
- The
nextToken
value returned from a previous paginatedDescribeJobDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
-
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 interfaceToCopyableBuilder<DescribeJobDefinitionsRequest.Builder,
DescribeJobDefinitionsRequest> - Specified by:
toBuilder
in classBatchRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-