com.amazonaws.services.batch.model.DescribeComputeEnvironmentsRequest 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 DescribeComputeEnvironments.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeComputeEnvironmentsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
*
*/
private java.util.List computeEnvironments;
/**
*
* The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output.
* When this parameter is used, DescribeComputeEnvironments 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 DescribeComputeEnvironments request with the returned
* nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
* DescribeComputeEnvironments returns up to 100 results and a nextToken value if
* applicable.
*
*/
private Integer maxResults;
/**
*
* The nextToken value returned from a previous paginated DescribeComputeEnvironments
* 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;
/**
*
* A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
*
*
* @return A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
*/
public java.util.List getComputeEnvironments() {
return computeEnvironments;
}
/**
*
* A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
*
*
* @param computeEnvironments
* A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
*/
public void setComputeEnvironments(java.util.Collection computeEnvironments) {
if (computeEnvironments == null) {
this.computeEnvironments = null;
return;
}
this.computeEnvironments = new java.util.ArrayList(computeEnvironments);
}
/**
*
* A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setComputeEnvironments(java.util.Collection)} or {@link #withComputeEnvironments(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param computeEnvironments
* A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeComputeEnvironmentsRequest withComputeEnvironments(String... computeEnvironments) {
if (this.computeEnvironments == null) {
setComputeEnvironments(new java.util.ArrayList(computeEnvironments.length));
}
for (String ele : computeEnvironments) {
this.computeEnvironments.add(ele);
}
return this;
}
/**
*
* A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
*
*
* @param computeEnvironments
* A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeComputeEnvironmentsRequest withComputeEnvironments(java.util.Collection computeEnvironments) {
setComputeEnvironments(computeEnvironments);
return this;
}
/**
*
* The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output.
* When this parameter is used, DescribeComputeEnvironments 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 DescribeComputeEnvironments request with the returned
* nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
* DescribeComputeEnvironments returns up to 100 results and a nextToken value if
* applicable.
*
*
* @param maxResults
* The maximum number of cluster results returned by DescribeComputeEnvironments in paginated
* output. When this parameter is used, DescribeComputeEnvironments 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
* DescribeComputeEnvironments request with the returned nextToken value. This
* value can be between 1 and 100. If this parameter isn't used, then
* DescribeComputeEnvironments returns up to 100 results and a nextToken value if
* applicable.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output.
* When this parameter is used, DescribeComputeEnvironments 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 DescribeComputeEnvironments request with the returned
* nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
* DescribeComputeEnvironments returns up to 100 results and a nextToken value if
* applicable.
*
*
* @return The maximum number of cluster results returned by DescribeComputeEnvironments in paginated
* output. When this parameter is used, DescribeComputeEnvironments 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
* DescribeComputeEnvironments request with the returned nextToken value. This
* value can be between 1 and 100. If this parameter isn't used, then
* DescribeComputeEnvironments returns up to 100 results and a nextToken value if
* applicable.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output.
* When this parameter is used, DescribeComputeEnvironments 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 DescribeComputeEnvironments request with the returned
* nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
* DescribeComputeEnvironments returns up to 100 results and a nextToken value if
* applicable.
*
*
* @param maxResults
* The maximum number of cluster results returned by DescribeComputeEnvironments in paginated
* output. When this parameter is used, DescribeComputeEnvironments 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
* DescribeComputeEnvironments request with the returned nextToken value. This
* value can be between 1 and 100. If this parameter isn't used, then
* DescribeComputeEnvironments 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 DescribeComputeEnvironmentsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The nextToken value returned from a previous paginated DescribeComputeEnvironments
* 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
* DescribeComputeEnvironments 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 DescribeComputeEnvironments
* 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
* DescribeComputeEnvironments 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 DescribeComputeEnvironments
* 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
* DescribeComputeEnvironments 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 DescribeComputeEnvironmentsRequest 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 (getComputeEnvironments() != null)
sb.append("ComputeEnvironments: ").append(getComputeEnvironments()).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 DescribeComputeEnvironmentsRequest == false)
return false;
DescribeComputeEnvironmentsRequest other = (DescribeComputeEnvironmentsRequest) obj;
if (other.getComputeEnvironments() == null ^ this.getComputeEnvironments() == null)
return false;
if (other.getComputeEnvironments() != null && other.getComputeEnvironments().equals(this.getComputeEnvironments()) == 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 + ((getComputeEnvironments() == null) ? 0 : getComputeEnvironments().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribeComputeEnvironmentsRequest clone() {
return (DescribeComputeEnvironmentsRequest) super.clone();
}
}