com.amazonaws.services.batch.model.ListJobsRequest Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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;
/**
*
* @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 with which 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 with which to filter jobs in the specified queue. If you do not specify a status, only
* RUNNING jobs are returned.
*
*/
private String jobStatus;
/**
*
* The maximum number of results returned by ListJobs in paginated output. When this parameter is used,
* ListJobs 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 ListJobs request with the returned nextToken value. This value can be between 1
* and 100. If this parameter is not used, then ListJobs returns up to 100 results 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.
*
*
*
* 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.
*
*
*/
private String nextToken;
/**
*
* The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
*
*
* @param jobQueue
* The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
*/
public void setJobQueue(String jobQueue) {
this.jobQueue = jobQueue;
}
/**
*
* The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
*
*
* @return The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
*/
public String getJobQueue() {
return this.jobQueue;
}
/**
*
* The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
*
*
* @param jobQueue
* The name or full Amazon Resource Name (ARN) of the job queue with which 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 with which to filter jobs in the specified queue. If you do not specify a status, only
* RUNNING jobs are returned.
*
*
* @param jobStatus
* The job status with which to filter jobs in the specified queue. If you do not specify a status, only
* RUNNING jobs are returned.
* @see JobStatus
*/
public void setJobStatus(String jobStatus) {
this.jobStatus = jobStatus;
}
/**
*
* The job status with which to filter jobs in the specified queue. If you do not specify a status, only
* RUNNING jobs are returned.
*
*
* @return The job status with which to filter jobs in the specified queue. If you do not specify a status, only
* RUNNING jobs are returned.
* @see JobStatus
*/
public String getJobStatus() {
return this.jobStatus;
}
/**
*
* The job status with which to filter jobs in the specified queue. If you do not specify a status, only
* RUNNING jobs are returned.
*
*
* @param jobStatus
* The job status with which to filter jobs in the specified queue. If you do not 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 with which to filter jobs in the specified queue. If you do not specify a status, only
* RUNNING jobs are returned.
*
*
* @param jobStatus
* The job status with which to filter jobs in the specified queue. If you do not specify a status, only
* RUNNING jobs are returned.
* @see JobStatus
*/
public void setJobStatus(JobStatus jobStatus) {
withJobStatus(jobStatus);
}
/**
*
* The job status with which to filter jobs in the specified queue. If you do not specify a status, only
* RUNNING jobs are returned.
*
*
* @param jobStatus
* The job status with which to filter jobs in the specified queue. If you do not 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 paginated output. When this parameter is used,
* ListJobs 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 ListJobs request with the returned nextToken value. This value can be between 1
* and 100. If this parameter is not used, then ListJobs returns up to 100 results and a
* nextToken value if applicable.
*
*
* @param maxResults
* The maximum number of results returned by ListJobs in paginated output. When this parameter
* is used, ListJobs 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 ListJobs request with the returned nextToken value. This value
* can be between 1 and 100. If this parameter is not used, then ListJobs returns up to 100
* results and a nextToken value if applicable.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results returned by ListJobs in paginated output. When this parameter is used,
* ListJobs 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 ListJobs request with the returned nextToken value. This value can be between 1
* and 100. If this parameter is not used, then ListJobs returns up to 100 results and a
* nextToken value if applicable.
*
*
* @return The maximum number of results returned by ListJobs in paginated output. When this parameter
* is used, ListJobs 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 ListJobs request with the returned nextToken value. This value
* can be between 1 and 100. If this parameter is not used, then ListJobs returns up to 100
* results and a nextToken value if applicable.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results returned by ListJobs in paginated output. When this parameter is used,
* ListJobs 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 ListJobs request with the returned nextToken value. This value can be between 1
* and 100. If this parameter is not used, then ListJobs returns up to 100 results and a
* nextToken value if applicable.
*
*
* @param maxResults
* The maximum number of results returned by ListJobs in paginated output. When this parameter
* is used, ListJobs 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 ListJobs request with the returned nextToken value. This value
* can be between 1 and 100. If this parameter is not used, then ListJobs returns up to 100
* results 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.
*
*
*
* 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.
*
*
*
* @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.
*
* 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 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.
*
*
*
* 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.
*
*
*
* @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.
*
* 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 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.
*
*
*
* 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.
*
*
*
* @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.
*
* 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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());
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;
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());
return hashCode;
}
@Override
public ListJobsRequest clone() {
return (ListJobsRequest) super.clone();
}
}