com.amazonaws.services.batch.model.ListJobsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-batch Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.batch.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Contains the parameters for ListJobs.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListJobsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
*
*/
private String jobQueue;
/**
*
* The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the
* specified array.
*
*/
private String arrayJobId;
/**
*
* 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.
*
*/
private String multiNodeJobId;
/**
*
* The job status used to filter jobs in the specified queue. If the filters parameter is specified,
* the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a
* status, only RUNNING jobs are returned.
*
*/
private String jobStatus;
/**
*
* The maximum number of results returned by ListJobs in a paginated output. When this parameter is
* used, ListJobs returns up to maxResults results in a single page and a
* nextToken response element, if applicable. The remaining results of the initial request can be seen
* by sending another ListJobs request with the returned nextToken value.
*
*
* The following outlines key parameters and limitations:
*
*
* -
*
* The minimum value is 1.
*
*
* -
*
* When --job-status is used, Batch returns up to 1000 values.
*
*
* -
*
* When --filters is used, Batch returns up to 100 values.
*
*
* -
*
* If neither parameter is used, then ListJobs returns up to 1000 results (jobs that are in the
* RUNNING status) and a nextToken value, if applicable.
*
*
*
*/
private Integer maxResults;
/**
*
* The nextToken value returned from a previous paginated ListJobs 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.
*
*
*/
private String nextToken;
/**
*
* 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 the createdAt 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 both Test1 and
* test1, and test1* matches both test1 and Test10. When the
* JOB_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 only jd1, and jd1* matches both
* jd1 and jd1A. The version of the job definition that's used doesn't affect the sort
* order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form
* arn:${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.
*
*
*
*/
private java.util.List filters;
/**
*
* The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
*
*
* @param jobQueue
* The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
*/
public void setJobQueue(String jobQueue) {
this.jobQueue = jobQueue;
}
/**
*
* The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
*
*
* @return The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
*/
public String getJobQueue() {
return this.jobQueue;
}
/**
*
* The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
*
*
* @param jobQueue
* The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withJobQueue(String jobQueue) {
setJobQueue(jobQueue);
return this;
}
/**
*
* The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the
* specified array.
*
*
* @param 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.
*/
public void setArrayJobId(String arrayJobId) {
this.arrayJobId = 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.
*
*
* @return The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from
* within the specified array.
*/
public String getArrayJobId() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withArrayJobId(String arrayJobId) {
setArrayJobId(arrayJobId);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setMultiNodeJobId(String multiNodeJobId) {
this.multiNodeJobId = 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.
*
*
* @return 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.
*/
public String getMultiNodeJobId() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withMultiNodeJobId(String multiNodeJobId) {
setMultiNodeJobId(multiNodeJobId);
return this;
}
/**
*
* The job status used to filter jobs in the specified queue. If the filters parameter is specified,
* the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a
* status, only RUNNING jobs are returned.
*
*
* @param jobStatus
* The job status used to filter jobs in the specified queue. If the filters parameter is
* specified, the jobStatus parameter is ignored and jobs with any status are returned. If you
* don't specify a status, only RUNNING jobs are returned.
* @see JobStatus
*/
public void setJobStatus(String jobStatus) {
this.jobStatus = jobStatus;
}
/**
*
* The job status used to filter jobs in the specified queue. If the filters parameter is specified,
* the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a
* status, only RUNNING jobs are returned.
*
*
* @return The job status used to filter jobs in the specified queue. If the filters parameter is
* specified, the jobStatus parameter is ignored and jobs with any status are returned. If you
* don't specify a status, only RUNNING jobs are returned.
* @see JobStatus
*/
public String getJobStatus() {
return this.jobStatus;
}
/**
*
* The job status used to filter jobs in the specified queue. If the filters parameter is specified,
* the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a
* status, only RUNNING jobs are returned.
*
*
* @param jobStatus
* The job status used to filter jobs in the specified queue. If the filters parameter is
* specified, the jobStatus parameter is ignored and jobs with any status are returned. If you
* don't specify a status, only RUNNING jobs are returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public ListJobsRequest withJobStatus(String jobStatus) {
setJobStatus(jobStatus);
return this;
}
/**
*
* The job status used to filter jobs in the specified queue. If the filters parameter is specified,
* the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a
* status, only RUNNING jobs are returned.
*
*
* @param jobStatus
* The job status used to filter jobs in the specified queue. If the filters parameter is
* specified, the jobStatus parameter is ignored and jobs with any status are returned. If you
* don't specify a status, only RUNNING jobs are returned.
* @see JobStatus
*/
public void setJobStatus(JobStatus jobStatus) {
withJobStatus(jobStatus);
}
/**
*
* The job status used to filter jobs in the specified queue. If the filters parameter is specified,
* the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a
* status, only RUNNING jobs are returned.
*
*
* @param jobStatus
* The job status used to filter jobs in the specified queue. If the filters parameter is
* specified, the jobStatus parameter is ignored and jobs with any status are returned. If you
* don't specify a status, only RUNNING jobs are returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public ListJobsRequest withJobStatus(JobStatus jobStatus) {
this.jobStatus = jobStatus.toString();
return this;
}
/**
*
* The maximum number of results returned by ListJobs in a paginated output. When this parameter is
* used, ListJobs returns up to maxResults results in a single page and a
* nextToken response element, if applicable. The remaining results of the initial request can be seen
* by sending another ListJobs request with the returned nextToken value.
*
*
* The following outlines key parameters and limitations:
*
*
* -
*
* The minimum value is 1.
*
*
* -
*
* When --job-status is used, Batch returns up to 1000 values.
*
*
* -
*
* When --filters is used, Batch returns up to 100 values.
*
*
* -
*
* If neither parameter is used, then ListJobs returns up to 1000 results (jobs that are in the
* RUNNING status) and a nextToken value, if applicable.
*
*
*
*
* @param maxResults
* The maximum number of results returned by ListJobs in a paginated output. When this parameter
* is used, ListJobs returns up to maxResults results in a single page and a
* nextToken response element, if applicable. The remaining results of the initial request can
* be seen by sending another ListJobs request with the returned nextToken
* value.
*
* The following outlines key parameters and limitations:
*
*
* -
*
* The minimum value is 1.
*
*
* -
*
* When --job-status is used, Batch returns up to 1000 values.
*
*
* -
*
* When --filters is used, Batch returns up to 100 values.
*
*
* -
*
* If neither parameter is used, then ListJobs returns up to 1000 results (jobs that are in the
* RUNNING status) and a nextToken value, if applicable.
*
*
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results returned by ListJobs in a paginated output. When this parameter is
* used, ListJobs returns up to maxResults results in a single page and a
* nextToken response element, if applicable. The remaining results of the initial request can be seen
* by sending another ListJobs request with the returned nextToken value.
*
*
* The following outlines key parameters and limitations:
*
*
* -
*
* The minimum value is 1.
*
*
* -
*
* When --job-status is used, Batch returns up to 1000 values.
*
*
* -
*
* When --filters is used, Batch returns up to 100 values.
*
*
* -
*
* If neither parameter is used, then ListJobs returns up to 1000 results (jobs that are in the
* RUNNING status) and a nextToken value, if applicable.
*
*
*
*
* @return The maximum number of results returned by ListJobs in a paginated output. When this
* parameter is used, ListJobs returns up to maxResults results in a single page
* and a nextToken response element, if applicable. The remaining results of the initial
* request can be seen by sending another ListJobs request with the returned
* nextToken value.
*
* The following outlines key parameters and limitations:
*
*
* -
*
* The minimum value is 1.
*
*
* -
*
* When --job-status is used, Batch returns up to 1000 values.
*
*
* -
*
* When --filters is used, Batch returns up to 100 values.
*
*
* -
*
* If neither parameter is used, then ListJobs returns up to 1000 results (jobs that are in the
* RUNNING status) and a nextToken value, if applicable.
*
*
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results returned by ListJobs in a paginated output. When this parameter is
* used, ListJobs returns up to maxResults results in a single page and a
* nextToken response element, if applicable. The remaining results of the initial request can be seen
* by sending another ListJobs request with the returned nextToken value.
*
*
* The following outlines key parameters and limitations:
*
*
* -
*
* The minimum value is 1.
*
*
* -
*
* When --job-status is used, Batch returns up to 1000 values.
*
*
* -
*
* When --filters is used, Batch returns up to 100 values.
*
*
* -
*
* If neither parameter is used, then ListJobs returns up to 1000 results (jobs that are in the
* RUNNING status) and a nextToken value, if applicable.
*
*
*
*
* @param maxResults
* The maximum number of results returned by ListJobs in a paginated output. When this parameter
* is used, ListJobs returns up to maxResults results in a single page and a
* nextToken response element, if applicable. The remaining results of the initial request can
* be seen by sending another ListJobs request with the returned nextToken
* value.
*
* The following outlines key parameters and limitations:
*
*
* -
*
* The minimum value is 1.
*
*
* -
*
* When --job-status is used, Batch returns up to 1000 values.
*
*
* -
*
* When --filters is used, Batch returns up to 100 values.
*
*
* -
*
* If neither parameter is used, then ListJobs returns up to 1000 results (jobs that are in the
* RUNNING status) and a nextToken value, if applicable.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The nextToken value returned from a previous paginated ListJobs 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.
*
*
*
* @param nextToken
* The nextToken value returned from a previous paginated ListJobs 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 void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The nextToken value returned from a previous paginated ListJobs 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.
*
*
*
* @return The nextToken value returned from a previous paginated ListJobs 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 String getNextToken() {
return this.nextToken;
}
/**
*
* The nextToken value returned from a previous paginated ListJobs 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.
*
*
*
* @param nextToken
* The nextToken value returned from a previous paginated ListJobs 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* 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 the createdAt 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 both Test1 and
* test1, and test1* matches both test1 and Test10. When the
* JOB_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 only jd1, and jd1* matches both
* jd1 and jd1A. The version of the job definition that's used doesn't affect the sort
* order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form
* arn:${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.
*
*
*
*
* @return 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 the createdAt 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 both Test1 and
* test1, and test1* matches both test1 and Test10. When
* the JOB_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 only jd1, and
* jd1* matches both jd1 and jd1A. The version of the job definition
* that's used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the
* ARN is used (which is in the form
* arn:${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.
*
*
*/
public java.util.List getFilters() {
return 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 the createdAt 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 both Test1 and
* test1, and test1* matches both test1 and Test10. When the
* JOB_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 only jd1, and jd1* matches both
* jd1 and jd1A. The version of the job definition that's used doesn't affect the sort
* order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form
* arn:${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.
*
*
*
*
* @param 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 the createdAt 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 both Test1 and
* test1, and test1* matches both test1 and Test10. When
* the JOB_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 only jd1, and jd1*
* matches both jd1 and jd1A. The version of the job definition that's used doesn't
* affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is
* in the form
* arn:${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.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new java.util.ArrayList(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 the createdAt 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 both Test1 and
* test1, and test1* matches both test1 and Test10. When the
* JOB_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 only jd1, and jd1* matches both
* jd1 and jd1A. The version of the job definition that's used doesn't affect the sort
* order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form
* arn:${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.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param 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 the createdAt 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 both Test1 and
* test1, and test1* matches both test1 and Test10. When
* the JOB_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 only jd1, and jd1*
* matches both jd1 and jd1A. The version of the job definition that's used doesn't
* affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is
* in the form
* arn:${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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withFilters(KeyValuesPair... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayList(filters.length));
}
for (KeyValuesPair ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* 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 the createdAt 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 both Test1 and
* test1, and test1* matches both test1 and Test10. When the
* JOB_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 only jd1, and jd1* matches both
* jd1 and jd1A. The version of the job definition that's used doesn't affect the sort
* order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form
* arn:${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.
*
*
*
*
* @param 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 the createdAt 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 both Test1 and
* test1, and test1* matches both test1 and Test10. When
* the JOB_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 only jd1, and jd1*
* matches both jd1 and jd1A. The version of the job definition that's used doesn't
* affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is
* in the form
* arn:${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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getJobQueue() != null)
sb.append("JobQueue: ").append(getJobQueue()).append(",");
if (getArrayJobId() != null)
sb.append("ArrayJobId: ").append(getArrayJobId()).append(",");
if (getMultiNodeJobId() != null)
sb.append("MultiNodeJobId: ").append(getMultiNodeJobId()).append(",");
if (getJobStatus() != null)
sb.append("JobStatus: ").append(getJobStatus()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListJobsRequest == false)
return false;
ListJobsRequest other = (ListJobsRequest) obj;
if (other.getJobQueue() == null ^ this.getJobQueue() == null)
return false;
if (other.getJobQueue() != null && other.getJobQueue().equals(this.getJobQueue()) == false)
return false;
if (other.getArrayJobId() == null ^ this.getArrayJobId() == null)
return false;
if (other.getArrayJobId() != null && other.getArrayJobId().equals(this.getArrayJobId()) == false)
return false;
if (other.getMultiNodeJobId() == null ^ this.getMultiNodeJobId() == null)
return false;
if (other.getMultiNodeJobId() != null && other.getMultiNodeJobId().equals(this.getMultiNodeJobId()) == false)
return false;
if (other.getJobStatus() == null ^ this.getJobStatus() == null)
return false;
if (other.getJobStatus() != null && other.getJobStatus().equals(this.getJobStatus()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobQueue() == null) ? 0 : getJobQueue().hashCode());
hashCode = prime * hashCode + ((getArrayJobId() == null) ? 0 : getArrayJobId().hashCode());
hashCode = prime * hashCode + ((getMultiNodeJobId() == null) ? 0 : getMultiNodeJobId().hashCode());
hashCode = prime * hashCode + ((getJobStatus() == null) ? 0 : getJobStatus().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public ListJobsRequest clone() {
return (ListJobsRequest) super.clone();
}
}