software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest Maven / Gradle / Ivy
Show all versions of batch Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.batch.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains the parameters for DescribeComputeEnvironments.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeComputeEnvironmentsRequest extends BatchRequest implements
ToCopyableBuilder {
private static final SdkField> COMPUTE_ENVIRONMENTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("computeEnvironments")
.getter(getter(DescribeComputeEnvironmentsRequest::computeEnvironments))
.setter(setter(Builder::computeEnvironments))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("computeEnvironments").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maxResults").getter(getter(DescribeComputeEnvironmentsRequest::maxResults))
.setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(DescribeComputeEnvironmentsRequest::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("nextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(COMPUTE_ENVIRONMENTS_FIELD,
MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD));
private final List computeEnvironments;
private final Integer maxResults;
private final String nextToken;
private DescribeComputeEnvironmentsRequest(BuilderImpl builder) {
super(builder);
this.computeEnvironments = builder.computeEnvironments;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
}
/**
* For responses, this returns true if the service returned a value for the ComputeEnvironments property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} 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.
*/
public final boolean hasComputeEnvironments() {
return computeEnvironments != null && !(computeEnvironments instanceof SdkAutoConstructList);
}
/**
*
* A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
*
*
* 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 {@link #hasComputeEnvironments} method.
*
*
* @return A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
*/
public final List computeEnvironments() {
return 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.
*
*
* @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 final Integer maxResults() {
return 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.
*
*
*
* @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 final String nextToken() {
return nextToken;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(hasComputeEnvironments() ? computeEnvironments() : null);
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeComputeEnvironmentsRequest)) {
return false;
}
DescribeComputeEnvironmentsRequest other = (DescribeComputeEnvironmentsRequest) obj;
return hasComputeEnvironments() == other.hasComputeEnvironments()
&& Objects.equals(computeEnvironments(), other.computeEnvironments())
&& Objects.equals(maxResults(), other.maxResults()) && Objects.equals(nextToken(), other.nextToken());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeComputeEnvironmentsRequest")
.add("ComputeEnvironments", hasComputeEnvironments() ? computeEnvironments() : null)
.add("MaxResults", maxResults()).add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "computeEnvironments":
return Optional.ofNullable(clazz.cast(computeEnvironments()));
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeComputeEnvironmentsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends BatchRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder computeEnvironments(Collection 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder computeEnvironments(String... 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.
*
*
* @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.
*/
Builder maxResults(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.
*
*
*
* @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.
*/
Builder nextToken(String nextToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends BatchRequest.BuilderImpl implements Builder {
private List computeEnvironments = DefaultSdkAutoConstructList.getInstance();
private Integer maxResults;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeComputeEnvironmentsRequest model) {
super(model);
computeEnvironments(model.computeEnvironments);
maxResults(model.maxResults);
nextToken(model.nextToken);
}
public final Collection getComputeEnvironments() {
if (computeEnvironments instanceof SdkAutoConstructList) {
return null;
}
return computeEnvironments;
}
public final void setComputeEnvironments(Collection computeEnvironments) {
this.computeEnvironments = StringListCopier.copy(computeEnvironments);
}
@Override
public final Builder computeEnvironments(Collection computeEnvironments) {
this.computeEnvironments = StringListCopier.copy(computeEnvironments);
return this;
}
@Override
@SafeVarargs
public final Builder computeEnvironments(String... computeEnvironments) {
computeEnvironments(Arrays.asList(computeEnvironments));
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeComputeEnvironmentsRequest build() {
return new DescribeComputeEnvironmentsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}