software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest Maven / Gradle / Ivy
Show all versions of elasticache Show documentation
/*
* Copyright 2014-2019 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.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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents the input of a DescribeCacheEngineVersions operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeCacheEngineVersionsRequest extends ElastiCacheRequest implements
ToCopyableBuilder {
private static final SdkField ENGINE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeCacheEngineVersionsRequest::engine)).setter(setter(Builder::engine))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Engine").build()).build();
private static final SdkField ENGINE_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeCacheEngineVersionsRequest::engineVersion)).setter(setter(Builder::engineVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EngineVersion").build()).build();
private static final SdkField CACHE_PARAMETER_GROUP_FAMILY_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeCacheEngineVersionsRequest::cacheParameterGroupFamily))
.setter(setter(Builder::cacheParameterGroupFamily))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CacheParameterGroupFamily").build())
.build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(DescribeCacheEngineVersionsRequest::maxRecords)).setter(setter(Builder::maxRecords))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxRecords").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeCacheEngineVersionsRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField DEFAULT_ONLY_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.getter(getter(DescribeCacheEngineVersionsRequest::defaultOnly)).setter(setter(Builder::defaultOnly))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultOnly").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ENGINE_FIELD,
ENGINE_VERSION_FIELD, CACHE_PARAMETER_GROUP_FAMILY_FIELD, MAX_RECORDS_FIELD, MARKER_FIELD, DEFAULT_ONLY_FIELD));
private final String engine;
private final String engineVersion;
private final String cacheParameterGroupFamily;
private final Integer maxRecords;
private final String marker;
private final Boolean defaultOnly;
private DescribeCacheEngineVersionsRequest(BuilderImpl builder) {
super(builder);
this.engine = builder.engine;
this.engineVersion = builder.engineVersion;
this.cacheParameterGroupFamily = builder.cacheParameterGroupFamily;
this.maxRecords = builder.maxRecords;
this.marker = builder.marker;
this.defaultOnly = builder.defaultOnly;
}
/**
*
* The cache engine to return. Valid values: memcached | redis
*
*
* @return The cache engine to return. Valid values: memcached | redis
*/
public String engine() {
return engine;
}
/**
*
* The cache engine version to return.
*
*
* Example: 1.4.14
*
*
* @return The cache engine version to return.
*
* Example: 1.4.14
*/
public String engineVersion() {
return engineVersion;
}
/**
*
* The name of a specific cache parameter group family to return details for.
*
*
* Valid values are: memcached1.4 | redis2.6 | redis2.8 |
* redis3.2 | redis4.0
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 alphanumeric characters
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @return The name of a specific cache parameter group family to return details for.
*
* Valid values are: memcached1.4 | redis2.6 | redis2.8 |
* redis3.2 | redis4.0
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 alphanumeric characters
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*/
public String cacheParameterGroupFamily() {
return cacheParameterGroupFamily;
}
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a marker is included in the response so that the remaining results can be
* retrieved.
*
*
* Default: 100
*
*
* Constraints: minimum 20; maximum 100.
*
*
* @return The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a marker is included in the response so that the remaining results can be
* retrieved.
*
* Default: 100
*
*
* Constraints: minimum 20; maximum 100.
*/
public Integer maxRecords() {
return maxRecords;
}
/**
*
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation.
* If this parameter is specified, the response includes only records beyond the marker, up to the value specified
* by MaxRecords.
*
*
* @return An optional marker returned from a prior request. Use this marker for pagination of results from this
* operation. If this parameter is specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*/
public String marker() {
return marker;
}
/**
*
* If true, specifies that only the default version of the specified engine or engine and major version
* combination is to be returned.
*
*
* @return If true, specifies that only the default version of the specified engine or engine and major
* version combination is to be returned.
*/
public Boolean defaultOnly() {
return defaultOnly;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(engine());
hashCode = 31 * hashCode + Objects.hashCode(engineVersion());
hashCode = 31 * hashCode + Objects.hashCode(cacheParameterGroupFamily());
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(defaultOnly());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeCacheEngineVersionsRequest)) {
return false;
}
DescribeCacheEngineVersionsRequest other = (DescribeCacheEngineVersionsRequest) obj;
return Objects.equals(engine(), other.engine()) && Objects.equals(engineVersion(), other.engineVersion())
&& Objects.equals(cacheParameterGroupFamily(), other.cacheParameterGroupFamily())
&& Objects.equals(maxRecords(), other.maxRecords()) && Objects.equals(marker(), other.marker())
&& Objects.equals(defaultOnly(), other.defaultOnly());
}
/**
* 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 String toString() {
return ToString.builder("DescribeCacheEngineVersionsRequest").add("Engine", engine())
.add("EngineVersion", engineVersion()).add("CacheParameterGroupFamily", cacheParameterGroupFamily())
.add("MaxRecords", maxRecords()).add("Marker", marker()).add("DefaultOnly", defaultOnly()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Engine":
return Optional.ofNullable(clazz.cast(engine()));
case "EngineVersion":
return Optional.ofNullable(clazz.cast(engineVersion()));
case "CacheParameterGroupFamily":
return Optional.ofNullable(clazz.cast(cacheParameterGroupFamily()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "DefaultOnly":
return Optional.ofNullable(clazz.cast(defaultOnly()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeCacheEngineVersionsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ElastiCacheRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The cache engine to return. Valid values: memcached | redis
*
*
* @param engine
* The cache engine to return. Valid values: memcached | redis
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder engine(String engine);
/**
*
* The cache engine version to return.
*
*
* Example: 1.4.14
*
*
* @param engineVersion
* The cache engine version to return.
*
* Example: 1.4.14
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder engineVersion(String engineVersion);
/**
*
* The name of a specific cache parameter group family to return details for.
*
*
* Valid values are: memcached1.4 | redis2.6 | redis2.8 |
* redis3.2 | redis4.0
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 alphanumeric characters
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @param cacheParameterGroupFamily
* The name of a specific cache parameter group family to return details for.
*
* Valid values are: memcached1.4 | redis2.6 | redis2.8 |
* redis3.2 | redis4.0
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 alphanumeric characters
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cacheParameterGroupFamily(String cacheParameterGroupFamily);
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a marker is included in the response so that the remaining results can be
* retrieved.
*
*
* Default: 100
*
*
* Constraints: minimum 20; maximum 100.
*
*
* @param maxRecords
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a marker is included in the response so that the remaining results can
* be retrieved.
*
* Default: 100
*
*
* Constraints: minimum 20; maximum 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxRecords(Integer maxRecords);
/**
*
* An optional marker returned from a prior request. Use this marker for pagination of results from this
* operation. If this parameter is specified, the response includes only records beyond the marker, up to the
* value specified by MaxRecords.
*
*
* @param marker
* An optional marker returned from a prior request. Use this marker for pagination of results from this
* operation. If this parameter is specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
/**
*
* If true, specifies that only the default version of the specified engine or engine and major
* version combination is to be returned.
*
*
* @param defaultOnly
* If true, specifies that only the default version of the specified engine or engine and
* major version combination is to be returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultOnly(Boolean defaultOnly);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ElastiCacheRequest.BuilderImpl implements Builder {
private String engine;
private String engineVersion;
private String cacheParameterGroupFamily;
private Integer maxRecords;
private String marker;
private Boolean defaultOnly;
private BuilderImpl() {
}
private BuilderImpl(DescribeCacheEngineVersionsRequest model) {
super(model);
engine(model.engine);
engineVersion(model.engineVersion);
cacheParameterGroupFamily(model.cacheParameterGroupFamily);
maxRecords(model.maxRecords);
marker(model.marker);
defaultOnly(model.defaultOnly);
}
public final String getEngine() {
return engine;
}
@Override
public final Builder engine(String engine) {
this.engine = engine;
return this;
}
public final void setEngine(String engine) {
this.engine = engine;
}
public final String getEngineVersion() {
return engineVersion;
}
@Override
public final Builder engineVersion(String engineVersion) {
this.engineVersion = engineVersion;
return this;
}
public final void setEngineVersion(String engineVersion) {
this.engineVersion = engineVersion;
}
public final String getCacheParameterGroupFamily() {
return cacheParameterGroupFamily;
}
@Override
public final Builder cacheParameterGroupFamily(String cacheParameterGroupFamily) {
this.cacheParameterGroupFamily = cacheParameterGroupFamily;
return this;
}
public final void setCacheParameterGroupFamily(String cacheParameterGroupFamily) {
this.cacheParameterGroupFamily = cacheParameterGroupFamily;
}
public final Integer getMaxRecords() {
return maxRecords;
}
@Override
public final Builder maxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
public final void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
public final String getMarker() {
return marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
public final void setMarker(String marker) {
this.marker = marker;
}
public final Boolean getDefaultOnly() {
return defaultOnly;
}
@Override
public final Builder defaultOnly(Boolean defaultOnly) {
this.defaultOnly = defaultOnly;
return this;
}
public final void setDefaultOnly(Boolean defaultOnly) {
this.defaultOnly = defaultOnly;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeCacheEngineVersionsRequest build() {
return new DescribeCacheEngineVersionsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}