/* * Copyright 2018-2023 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 DescribeJobDefinitions
.
*
* 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}
.
*
* 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.
*
* The name of the job definition to describe. *
*/ private String jobDefinitionName; /** ** The status used to filter job definitions. *
*/ private String status; /** *
* 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. *
*
* 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}
.
*
arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
or a
* short version using the form ${JobDefinitionName}:${Revision}
.
*/
public java.util.List
* 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}
.
*
arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
or a short
* version using the form ${JobDefinitionName}:${Revision}
.
*/
public void setJobDefinitions(java.util.Collection
* 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}
.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setJobDefinitions(java.util.Collection)} or {@link #withJobDefinitions(java.util.Collection)} if you want * to override the existing values. *
* * @param 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}
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeJobDefinitionsRequest withJobDefinitions(String... jobDefinitions) {
if (this.jobDefinitions == null) {
setJobDefinitions(new java.util.ArrayList
* 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}
.
*
arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
or a short
* version using the form ${JobDefinitionName}:${Revision}
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeJobDefinitionsRequest withJobDefinitions(java.util.Collection
* 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 void setMaxResults(Integer maxResults) {
this.maxResults = 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 Integer getMaxResults() {
return this.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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeJobDefinitionsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
* * The name of the job definition to describe. *
* * @param jobDefinitionName * The name of the job definition to describe. */ public void setJobDefinitionName(String jobDefinitionName) { this.jobDefinitionName = jobDefinitionName; } /** ** The name of the job definition to describe. *
* * @return The name of the job definition to describe. */ public String getJobDefinitionName() { return this.jobDefinitionName; } /** ** The name of the job definition to describe. *
* * @param jobDefinitionName * The name of the job definition to describe. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeJobDefinitionsRequest withJobDefinitionName(String jobDefinitionName) { setJobDefinitionName(jobDefinitionName); return this; } /** ** The status used to filter job definitions. *
* * @param status * The status used to filter job definitions. */ public void setStatus(String status) { this.status = status; } /** ** The status used to filter job definitions. *
* * @return The status used to filter job definitions. */ public String getStatus() { return this.status; } /** ** The status used to filter job definitions. *
* * @param status * The status used to filter job definitions. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeJobDefinitionsRequest withStatus(String status) { setStatus(status); return this; } /** *
* 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 void setNextToken(String nextToken) { this.nextToken = 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 String getNextToken() { return this.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. *
* @return Returns a reference to this object so that method calls can be chained together. */ public DescribeJobDefinitionsRequest 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 (getJobDefinitions() != null) sb.append("JobDefinitions: ").append(getJobDefinitions()).append(","); if (getMaxResults() != null) sb.append("MaxResults: ").append(getMaxResults()).append(","); if (getJobDefinitionName() != null) sb.append("JobDefinitionName: ").append(getJobDefinitionName()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).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 DescribeJobDefinitionsRequest == false) return false; DescribeJobDefinitionsRequest other = (DescribeJobDefinitionsRequest) obj; if (other.getJobDefinitions() == null ^ this.getJobDefinitions() == null) return false; if (other.getJobDefinitions() != null && other.getJobDefinitions().equals(this.getJobDefinitions()) == 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.getJobDefinitionName() == null ^ this.getJobDefinitionName() == null) return false; if (other.getJobDefinitionName() != null && other.getJobDefinitionName().equals(this.getJobDefinitionName()) == false) return false; if (other.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == 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 + ((getJobDefinitions() == null) ? 0 : getJobDefinitions().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getJobDefinitionName() == null) ? 0 : getJobDefinitionName().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); return hashCode; } @Override public DescribeJobDefinitionsRequest clone() { return (DescribeJobDefinitionsRequest) super.clone(); } }