software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse Maven / Gradle / Ivy
Show all versions of elasticache 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.elasticache.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 java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
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;
/**
*
* Represents the output of a DescribeCacheParameters operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeCacheParametersResponse extends ElastiCacheResponse implements
ToCopyableBuilder {
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeCacheParametersResponse::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField> PARAMETERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Parameters")
.getter(getter(DescribeCacheParametersResponse::parameters))
.setter(setter(Builder::parameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Parameters").build(),
ListTrait
.builder()
.memberLocationName("Parameter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Parameter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Parameter").build()).build()).build()).build();
private static final SdkField> CACHE_NODE_TYPE_SPECIFIC_PARAMETERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CacheNodeTypeSpecificParameters")
.getter(getter(DescribeCacheParametersResponse::cacheNodeTypeSpecificParameters))
.setter(setter(Builder::cacheNodeTypeSpecificParameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CacheNodeTypeSpecificParameters")
.build(),
ListTrait
.builder()
.memberLocationName("CacheNodeTypeSpecificParameter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CacheNodeTypeSpecificParameter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("CacheNodeTypeSpecificParameter").build()).build()).build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MARKER_FIELD,
PARAMETERS_FIELD, CACHE_NODE_TYPE_SPECIFIC_PARAMETERS_FIELD));
private final String marker;
private final List parameters;
private final List cacheNodeTypeSpecificParameters;
private DescribeCacheParametersResponse(BuilderImpl builder) {
super(builder);
this.marker = builder.marker;
this.parameters = builder.parameters;
this.cacheNodeTypeSpecificParameters = builder.cacheNodeTypeSpecificParameters;
}
/**
*
* Provides an identifier to allow retrieval of paginated results.
*
*
* @return Provides an identifier to allow retrieval of paginated results.
*/
public final String marker() {
return marker;
}
/**
* For responses, this returns true if the service returned a value for the Parameters 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 hasParameters() {
return parameters != null && !(parameters instanceof SdkAutoConstructList);
}
/**
*
* A list of Parameter instances.
*
*
* 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 #hasParameters} method.
*
*
* @return A list of Parameter instances.
*/
public final List parameters() {
return parameters;
}
/**
* For responses, this returns true if the service returned a value for the CacheNodeTypeSpecificParameters
* 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 hasCacheNodeTypeSpecificParameters() {
return cacheNodeTypeSpecificParameters != null && !(cacheNodeTypeSpecificParameters instanceof SdkAutoConstructList);
}
/**
*
* A list of parameters specific to a particular cache node type. Each element in the list contains detailed
* information about one parameter.
*
*
* 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 #hasCacheNodeTypeSpecificParameters}
* method.
*
*
* @return A list of parameters specific to a particular cache node type. Each element in the list contains detailed
* information about one parameter.
*/
public final List cacheNodeTypeSpecificParameters() {
return cacheNodeTypeSpecificParameters;
}
@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(marker());
hashCode = 31 * hashCode + Objects.hashCode(hasParameters() ? parameters() : null);
hashCode = 31 * hashCode
+ Objects.hashCode(hasCacheNodeTypeSpecificParameters() ? cacheNodeTypeSpecificParameters() : 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 DescribeCacheParametersResponse)) {
return false;
}
DescribeCacheParametersResponse other = (DescribeCacheParametersResponse) obj;
return Objects.equals(marker(), other.marker()) && hasParameters() == other.hasParameters()
&& Objects.equals(parameters(), other.parameters())
&& hasCacheNodeTypeSpecificParameters() == other.hasCacheNodeTypeSpecificParameters()
&& Objects.equals(cacheNodeTypeSpecificParameters(), other.cacheNodeTypeSpecificParameters());
}
/**
* 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("DescribeCacheParametersResponse")
.add("Marker", marker())
.add("Parameters", hasParameters() ? parameters() : null)
.add("CacheNodeTypeSpecificParameters",
hasCacheNodeTypeSpecificParameters() ? cacheNodeTypeSpecificParameters() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "Parameters":
return Optional.ofNullable(clazz.cast(parameters()));
case "CacheNodeTypeSpecificParameters":
return Optional.ofNullable(clazz.cast(cacheNodeTypeSpecificParameters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeCacheParametersResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ElastiCacheResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* Provides an identifier to allow retrieval of paginated results.
*
*
* @param marker
* Provides an identifier to allow retrieval of paginated results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
/**
*
* A list of Parameter instances.
*
*
* @param parameters
* A list of Parameter instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameters(Collection parameters);
/**
*
* A list of Parameter instances.
*
*
* @param parameters
* A list of Parameter instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameters(Parameter... parameters);
/**
*
* A list of Parameter instances.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.elasticache.model.Parameter.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.elasticache.model.Parameter#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.elasticache.model.Parameter.Builder#build()} is called immediately and
* its result is passed to {@link #parameters(List)}.
*
* @param parameters
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.elasticache.model.Parameter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #parameters(java.util.Collection)
*/
Builder parameters(Consumer... parameters);
/**
*
* A list of parameters specific to a particular cache node type. Each element in the list contains detailed
* information about one parameter.
*
*
* @param cacheNodeTypeSpecificParameters
* A list of parameters specific to a particular cache node type. Each element in the list contains
* detailed information about one parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cacheNodeTypeSpecificParameters(Collection cacheNodeTypeSpecificParameters);
/**
*
* A list of parameters specific to a particular cache node type. Each element in the list contains detailed
* information about one parameter.
*
*
* @param cacheNodeTypeSpecificParameters
* A list of parameters specific to a particular cache node type. Each element in the list contains
* detailed information about one parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cacheNodeTypeSpecificParameters(CacheNodeTypeSpecificParameter... cacheNodeTypeSpecificParameters);
/**
*
* A list of parameters specific to a particular cache node type. Each element in the list contains detailed
* information about one parameter.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.elasticache.model.CacheNodeTypeSpecificParameter.Builder} avoiding the
* need to create one manually via
* {@link software.amazon.awssdk.services.elasticache.model.CacheNodeTypeSpecificParameter#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.elasticache.model.CacheNodeTypeSpecificParameter.Builder#build()} is
* called immediately and its result is passed to {@link
* #cacheNodeTypeSpecificParameters(List)}.
*
* @param cacheNodeTypeSpecificParameters
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.elasticache.model.CacheNodeTypeSpecificParameter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #cacheNodeTypeSpecificParameters(java.util.Collection)
*/
Builder cacheNodeTypeSpecificParameters(
Consumer... cacheNodeTypeSpecificParameters);
}
static final class BuilderImpl extends ElastiCacheResponse.BuilderImpl implements Builder {
private String marker;
private List parameters = DefaultSdkAutoConstructList.getInstance();
private List cacheNodeTypeSpecificParameters = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeCacheParametersResponse model) {
super(model);
marker(model.marker);
parameters(model.parameters);
cacheNodeTypeSpecificParameters(model.cacheNodeTypeSpecificParameters);
}
public final String getMarker() {
return marker;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
public final List getParameters() {
List result = ParametersListCopier.copyToBuilder(this.parameters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setParameters(Collection parameters) {
this.parameters = ParametersListCopier.copyFromBuilder(parameters);
}
@Override
public final Builder parameters(Collection parameters) {
this.parameters = ParametersListCopier.copy(parameters);
return this;
}
@Override
@SafeVarargs
public final Builder parameters(Parameter... parameters) {
parameters(Arrays.asList(parameters));
return this;
}
@Override
@SafeVarargs
public final Builder parameters(Consumer... parameters) {
parameters(Stream.of(parameters).map(c -> Parameter.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getCacheNodeTypeSpecificParameters() {
List result = CacheNodeTypeSpecificParametersListCopier
.copyToBuilder(this.cacheNodeTypeSpecificParameters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setCacheNodeTypeSpecificParameters(
Collection cacheNodeTypeSpecificParameters) {
this.cacheNodeTypeSpecificParameters = CacheNodeTypeSpecificParametersListCopier
.copyFromBuilder(cacheNodeTypeSpecificParameters);
}
@Override
public final Builder cacheNodeTypeSpecificParameters(
Collection cacheNodeTypeSpecificParameters) {
this.cacheNodeTypeSpecificParameters = CacheNodeTypeSpecificParametersListCopier
.copy(cacheNodeTypeSpecificParameters);
return this;
}
@Override
@SafeVarargs
public final Builder cacheNodeTypeSpecificParameters(CacheNodeTypeSpecificParameter... cacheNodeTypeSpecificParameters) {
cacheNodeTypeSpecificParameters(Arrays.asList(cacheNodeTypeSpecificParameters));
return this;
}
@Override
@SafeVarargs
public final Builder cacheNodeTypeSpecificParameters(
Consumer... cacheNodeTypeSpecificParameters) {
cacheNodeTypeSpecificParameters(Stream.of(cacheNodeTypeSpecificParameters)
.map(c -> CacheNodeTypeSpecificParameter.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public DescribeCacheParametersResponse build() {
return new DescribeCacheParametersResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}