software.amazon.awssdk.services.dax.model.DescribeParameterGroupsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dax Show documentation
Show all versions of dax Show documentation
The AWS Java SDK for Amazon DynamoDB Accelerator (DAX) module holds the client classes that are used
for
communicating with Amazon DynamoDB Accelerator (DAX).
/*
* 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.dax.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeParameterGroupsRequest extends DaxRequest implements
ToCopyableBuilder {
private static final SdkField> PARAMETER_GROUP_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ParameterGroupNames")
.getter(getter(DescribeParameterGroupsRequest::parameterGroupNames))
.setter(setter(Builder::parameterGroupNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParameterGroupNames").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(DescribeParameterGroupsRequest::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(DescribeParameterGroupsRequest::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(PARAMETER_GROUP_NAMES_FIELD,
MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD));
private final List parameterGroupNames;
private final Integer maxResults;
private final String nextToken;
private DescribeParameterGroupsRequest(BuilderImpl builder) {
super(builder);
this.parameterGroupNames = builder.parameterGroupNames;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
}
/**
* For responses, this returns true if the service returned a value for the ParameterGroupNames 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 hasParameterGroupNames() {
return parameterGroupNames != null && !(parameterGroupNames instanceof SdkAutoConstructList);
}
/**
*
* The names of the parameter groups.
*
*
* 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 #hasParameterGroupNames} method.
*
*
* @return The names of the parameter groups.
*/
public final List parameterGroupNames() {
return parameterGroupNames;
}
/**
*
* The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can be
* retrieved.
*
*
* The value for MaxResults must be between 20 and 100.
*
*
* @return The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can be
* retrieved.
*
* The value for MaxResults must be between 20 and 100.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* An optional token returned from a prior request. Use this token for pagination of results from this action. If
* this parameter is specified, the response includes only results beyond the token, up to the value specified by
* MaxResults.
*
*
* @return An optional token returned from a prior request. Use this token for pagination of results from this
* action. If this parameter is specified, the response includes only results beyond the token, up to the
* value specified by MaxResults.
*/
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(hasParameterGroupNames() ? parameterGroupNames() : 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 DescribeParameterGroupsRequest)) {
return false;
}
DescribeParameterGroupsRequest other = (DescribeParameterGroupsRequest) obj;
return hasParameterGroupNames() == other.hasParameterGroupNames()
&& Objects.equals(parameterGroupNames(), other.parameterGroupNames())
&& 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("DescribeParameterGroupsRequest")
.add("ParameterGroupNames", hasParameterGroupNames() ? parameterGroupNames() : null)
.add("MaxResults", maxResults()).add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ParameterGroupNames":
return Optional.ofNullable(clazz.cast(parameterGroupNames()));
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((DescribeParameterGroupsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DaxRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The names of the parameter groups.
*
*
* @param parameterGroupNames
* The names of the parameter groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameterGroupNames(Collection parameterGroupNames);
/**
*
* The names of the parameter groups.
*
*
* @param parameterGroupNames
* The names of the parameter groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameterGroupNames(String... parameterGroupNames);
/**
*
* The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can be
* retrieved.
*
*
* The value for MaxResults must be between 20 and 100.
*
*
* @param maxResults
* The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can
* be retrieved.
*
* The value for MaxResults must be between 20 and 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* An optional token returned from a prior request. Use this token for pagination of results from this action.
* If this parameter is specified, the response includes only results beyond the token, up to the value
* specified by MaxResults.
*
*
* @param nextToken
* An optional token returned from a prior request. Use this token for pagination of results from this
* action. If this parameter is specified, the response includes only results beyond the token, up to the
* value specified by MaxResults.
* @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 DaxRequest.BuilderImpl implements Builder {
private List parameterGroupNames = DefaultSdkAutoConstructList.getInstance();
private Integer maxResults;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeParameterGroupsRequest model) {
super(model);
parameterGroupNames(model.parameterGroupNames);
maxResults(model.maxResults);
nextToken(model.nextToken);
}
public final Collection getParameterGroupNames() {
if (parameterGroupNames instanceof SdkAutoConstructList) {
return null;
}
return parameterGroupNames;
}
public final void setParameterGroupNames(Collection parameterGroupNames) {
this.parameterGroupNames = ParameterGroupNameListCopier.copy(parameterGroupNames);
}
@Override
public final Builder parameterGroupNames(Collection parameterGroupNames) {
this.parameterGroupNames = ParameterGroupNameListCopier.copy(parameterGroupNames);
return this;
}
@Override
@SafeVarargs
public final Builder parameterGroupNames(String... parameterGroupNames) {
parameterGroupNames(Arrays.asList(parameterGroupNames));
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 DescribeParameterGroupsRequest build() {
return new DescribeParameterGroupsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy