software.amazon.awssdk.services.eks.model.ListClustersRequest Maven / Gradle / Ivy
/*
* 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.eks.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListClustersRequest extends EksRequest implements
ToCopyableBuilder {
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maxResults").getter(getter(ListClustersRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("maxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(ListClustersRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("nextToken").build()).build();
private static final SdkField> INCLUDE_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("include")
.getter(getter(ListClustersRequest::include))
.setter(setter(Builder::include))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("include").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MAX_RESULTS_FIELD,
NEXT_TOKEN_FIELD, INCLUDE_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("maxResults", MAX_RESULTS_FIELD);
put("nextToken", NEXT_TOKEN_FIELD);
put("include", INCLUDE_FIELD);
}
});
private final Integer maxResults;
private final String nextToken;
private final List include;
private ListClustersRequest(BuilderImpl builder) {
super(builder);
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.include = builder.include;
}
/**
*
* The maximum number of results, returned in paginated output. You receive maxResults in a single
* page, along with a nextToken response element. You can see the remaining results of the initial
* request by sending another request with the returned nextToken value. This value can be between 1
* and 100. If you don't use this parameter, 100 results and a nextToken value, if applicable, are
* returned.
*
*
* @return The maximum number of results, returned in paginated output. You receive maxResults in a
* single page, along with a nextToken response element. You can see the remaining results of
* the initial request by sending another request with the returned nextToken value. This value
* can be between 1 and 100. If you don't use this parameter, 100 results and a nextToken
* value, if applicable, are returned.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* The nextToken value returned from a previous paginated 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 used only to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*
* @return The nextToken value returned from a previous paginated 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 used only to retrieve the next items in a
* list and not for other programmatic purposes.
*
*/
public final String nextToken() {
return nextToken;
}
/**
* For responses, this returns true if the service returned a value for the Include 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 hasInclude() {
return include != null && !(include instanceof SdkAutoConstructList);
}
/**
*
* Indicates whether external clusters are included in the returned list. Use 'all' to return https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.htmlconnected clusters, or blank to return
* only Amazon EKS clusters. 'all' must be in lowercase otherwise an error occurs.
*
*
* 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 #hasInclude} method.
*
*
* @return Indicates whether external clusters are included in the returned list. Use 'all' to return
* https://docs.aws.amazon.com/
* eks/latest/userguide/eks-connector.htmlconnected clusters, or blank to return only Amazon EKS
* clusters. 'all' must be in lowercase otherwise an error occurs.
*/
public final List include() {
return include;
}
@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(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(hasInclude() ? include() : null);
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 ListClustersRequest)) {
return false;
}
ListClustersRequest other = (ListClustersRequest) obj;
return Objects.equals(maxResults(), other.maxResults()) && Objects.equals(nextToken(), other.nextToken())
&& hasInclude() == other.hasInclude() && Objects.equals(include(), other.include());
}
/**
* 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("ListClustersRequest").add("MaxResults", maxResults()).add("NextToken", nextToken())
.add("Include", hasInclude() ? include() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "include":
return Optional.ofNullable(clazz.cast(include()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((ListClustersRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EksRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The maximum number of results, returned in paginated output. You receive maxResults in a single
* page, along with a nextToken response element. You can see the remaining results of the initial
* request by sending another request with the returned nextToken value. This value can be between
* 1 and 100. If you don't use this parameter, 100 results and a nextToken value, if applicable,
* are returned.
*
*
* @param maxResults
* The maximum number of results, returned in paginated output. You receive maxResults in a
* single page, along with a nextToken response element. You can see the remaining results
* of the initial request by sending another request with the returned nextToken value. This
* value can be between 1 and 100. If you don't use this parameter, 100 results and a
* nextToken value, if applicable, are returned.
* @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 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 used only to retrieve the next items in a list
* and not for other programmatic purposes.
*
*
*
* @param nextToken
* The nextToken value returned from a previous paginated 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 used only 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);
/**
*
* Indicates whether external clusters are included in the returned list. Use 'all' to return https://docs.aws.amazon.com/eks/
* latest/userguide/eks-connector.htmlconnected clusters, or blank to return only Amazon EKS clusters. '
* all' must be in lowercase otherwise an error occurs.
*
*
* @param include
* Indicates whether external clusters are included in the returned list. Use 'all' to
* return https://docs.aws.amazon
* .com/eks/latest/userguide/eks-connector.htmlconnected clusters, or blank to return only Amazon EKS
* clusters. 'all' must be in lowercase otherwise an error occurs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder include(Collection include);
/**
*
* Indicates whether external clusters are included in the returned list. Use 'all' to return https://docs.aws.amazon.com/eks/
* latest/userguide/eks-connector.htmlconnected clusters, or blank to return only Amazon EKS clusters. '
* all' must be in lowercase otherwise an error occurs.
*
*
* @param include
* Indicates whether external clusters are included in the returned list. Use 'all' to
* return https://docs.aws.amazon
* .com/eks/latest/userguide/eks-connector.htmlconnected clusters, or blank to return only Amazon EKS
* clusters. 'all' must be in lowercase otherwise an error occurs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder include(String... include);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EksRequest.BuilderImpl implements Builder {
private Integer maxResults;
private String nextToken;
private List include = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ListClustersRequest model) {
super(model);
maxResults(model.maxResults);
nextToken(model.nextToken);
include(model.include);
}
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;
}
public final Collection getInclude() {
if (include instanceof SdkAutoConstructList) {
return null;
}
return include;
}
public final void setInclude(Collection include) {
this.include = IncludeClustersListCopier.copy(include);
}
@Override
public final Builder include(Collection include) {
this.include = IncludeClustersListCopier.copy(include);
return this;
}
@Override
@SafeVarargs
public final Builder include(String... include) {
include(Arrays.asList(include));
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 ListClustersRequest build() {
return new ListClustersRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}