Class ListJobsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListJobsRequest.Builder,
ListJobsRequest>
Contains the parameters for ListJobs
.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The job ID for an array job.static ListJobsRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<KeyValuesPair> filters()
The filter to apply to the query.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final String
jobQueue()
The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.final JobStatus
The job status used to filter jobs in the specified queue.final String
The job status used to filter jobs in the specified queue.final Integer
The maximum number of results returned byListJobs
in paginated output.final String
The job ID for a multi-node parallel job.final String
ThenextToken
value returned from a previous paginatedListJobs
request wheremaxResults
was used and the results exceeded the value of that parameter.static Class
<? extends ListJobsRequest.Builder> 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
-
jobQueue
The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
- Returns:
- The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
-
arrayJobId
The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
- Returns:
- The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
-
multiNodeJobId
The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.
- Returns:
- The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.
-
jobStatus
The job status used to filter jobs in the specified queue. If the
filters
parameter is specified, thejobStatus
parameter is ignored and jobs with any status are returned. If you don't specify a status, onlyRUNNING
jobs are returned.If the service returns an enum value that is not available in the current SDK version,
jobStatus
will returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobStatusAsString()
.- Returns:
- The job status used to filter jobs in the specified queue. If the
filters
parameter is specified, thejobStatus
parameter is ignored and jobs with any status are returned. If you don't specify a status, onlyRUNNING
jobs are returned. - See Also:
-
jobStatusAsString
The job status used to filter jobs in the specified queue. If the
filters
parameter is specified, thejobStatus
parameter is ignored and jobs with any status are returned. If you don't specify a status, onlyRUNNING
jobs are returned.If the service returns an enum value that is not available in the current SDK version,
jobStatus
will returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobStatusAsString()
.- Returns:
- The job status used to filter jobs in the specified queue. If the
filters
parameter is specified, thejobStatus
parameter is ignored and jobs with any status are returned. If you don't specify a status, onlyRUNNING
jobs are returned. - See Also:
-
maxResults
The maximum number of results returned by
ListJobs
in paginated output. When this parameter is used,ListJobs
only returnsmaxResults
results in a single page and anextToken
response element. The remaining results of the initial request can be seen by sending anotherListJobs
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenListJobs
returns up to 100 results and anextToken
value if applicable.- Returns:
- The maximum number of results returned by
ListJobs
in paginated output. When this parameter is used,ListJobs
only returnsmaxResults
results in a single page and anextToken
response element. The remaining results of the initial request can be seen by sending anotherListJobs
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenListJobs
returns up to 100 results and anextToken
value if applicable.
-
nextToken
The
nextToken
value returned from a previous paginatedListJobs
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 paginatedListJobs
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.
-
hasFilters
public final boolean hasFilters()For responses, this returns true if the service returned a value for the Filters 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. -
filters
The filter to apply to the query. Only one filter can be used at a time. When the filter is used,
jobStatus
is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by thecreatedAt
field, with the most recent jobs being first.- JOB_NAME
-
The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches any job name that begins with the string before the '*'. This corresponds to the
jobName
value. For example,test1
matches bothTest1
andtest1
, andtest1*
matches bothtest1
andTest10
. When theJOB_NAME
filter is used, the results are grouped by the job name and version. - JOB_DEFINITION
-
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the
jobDefinition
value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For example,jd1
matches onlyjd1
, andjd1*
matches bothjd1
andjd1A
. The version of the job definition that's used doesn't affect the sort order. When theJOB_DEFINITION
filter is used and the ARN is used (which is in the formarn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used. - BEFORE_CREATED_AT
-
The value for the filter is the time that's before the job was created. This corresponds to the
createdAt
value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970. - AFTER_CREATED_AT
-
The value for the filter is the time that's after the job was created. This corresponds to the
createdAt
value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
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
hasFilters()
method.- Returns:
- The filter to apply to the query. Only one filter can be used at a time. When the filter is used,
jobStatus
is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by thecreatedAt
field, with the most recent jobs being first.- JOB_NAME
-
The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches any job name that begins with the string before the '*'. This corresponds to the
jobName
value. For example,test1
matches bothTest1
andtest1
, andtest1*
matches bothtest1
andTest10
. When theJOB_NAME
filter is used, the results are grouped by the job name and version. - JOB_DEFINITION
-
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the
jobDefinition
value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For example,jd1
matches onlyjd1
, andjd1*
matches bothjd1
andjd1A
. The version of the job definition that's used doesn't affect the sort order. When theJOB_DEFINITION
filter is used and the ARN is used (which is in the formarn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used. - BEFORE_CREATED_AT
-
The value for the filter is the time that's before the job was created. This corresponds to the
createdAt
value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970. - AFTER_CREATED_AT
-
The value for the filter is the time that's after the job was created. This corresponds to the
createdAt
value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
-
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<ListJobsRequest.Builder,
ListJobsRequest> - 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
-