software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticache Show documentation
Show all versions of elasticache Show documentation
The AWS Java SDK for Amazon ElastiCache module holds the client classes that are used for communicating
with Amazon ElastiCache Service
/*
* 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 DescribeCacheClusters operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeCacheClustersRequest extends ElastiCacheRequest implements
ToCopyableBuilder {
private static final SdkField CACHE_CLUSTER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeCacheClustersRequest::cacheClusterId)).setter(setter(Builder::cacheClusterId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CacheClusterId").build()).build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(DescribeCacheClustersRequest::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(DescribeCacheClustersRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField SHOW_CACHE_NODE_INFO_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.getter(getter(DescribeCacheClustersRequest::showCacheNodeInfo)).setter(setter(Builder::showCacheNodeInfo))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ShowCacheNodeInfo").build()).build();
private static final SdkField SHOW_CACHE_CLUSTERS_NOT_IN_REPLICATION_GROUPS_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.getter(getter(DescribeCacheClustersRequest::showCacheClustersNotInReplicationGroups))
.setter(setter(Builder::showCacheClustersNotInReplicationGroups))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("ShowCacheClustersNotInReplicationGroups").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CACHE_CLUSTER_ID_FIELD,
MAX_RECORDS_FIELD, MARKER_FIELD, SHOW_CACHE_NODE_INFO_FIELD, SHOW_CACHE_CLUSTERS_NOT_IN_REPLICATION_GROUPS_FIELD));
private final String cacheClusterId;
private final Integer maxRecords;
private final String marker;
private final Boolean showCacheNodeInfo;
private final Boolean showCacheClustersNotInReplicationGroups;
private DescribeCacheClustersRequest(BuilderImpl builder) {
super(builder);
this.cacheClusterId = builder.cacheClusterId;
this.maxRecords = builder.maxRecords;
this.marker = builder.marker;
this.showCacheNodeInfo = builder.showCacheNodeInfo;
this.showCacheClustersNotInReplicationGroups = builder.showCacheClustersNotInReplicationGroups;
}
/**
*
* The user-supplied cluster identifier. If this parameter is specified, only information about that specific
* cluster is returned. This parameter isn't case sensitive.
*
*
* @return The user-supplied cluster identifier. If this parameter is specified, only information about that
* specific cluster is returned. This parameter isn't case sensitive.
*/
public String cacheClusterId() {
return cacheClusterId;
}
/**
*
* 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;
}
/**
*
* An optional flag that can be included in the DescribeCacheCluster request to retrieve information
* about the individual cache nodes.
*
*
* @return An optional flag that can be included in the DescribeCacheCluster request to retrieve
* information about the individual cache nodes.
*/
public Boolean showCacheNodeInfo() {
return showCacheNodeInfo;
}
/**
*
* An optional flag that can be included in the DescribeCacheCluster request to show only nodes
* (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node
* Redis clusters.
*
*
* @return An optional flag that can be included in the DescribeCacheCluster request to show only nodes
* (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and
* single node Redis clusters.
*/
public Boolean showCacheClustersNotInReplicationGroups() {
return showCacheClustersNotInReplicationGroups;
}
@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(cacheClusterId());
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(showCacheNodeInfo());
hashCode = 31 * hashCode + Objects.hashCode(showCacheClustersNotInReplicationGroups());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeCacheClustersRequest)) {
return false;
}
DescribeCacheClustersRequest other = (DescribeCacheClustersRequest) obj;
return Objects.equals(cacheClusterId(), other.cacheClusterId()) && Objects.equals(maxRecords(), other.maxRecords())
&& Objects.equals(marker(), other.marker()) && Objects.equals(showCacheNodeInfo(), other.showCacheNodeInfo())
&& Objects.equals(showCacheClustersNotInReplicationGroups(), other.showCacheClustersNotInReplicationGroups());
}
/**
* 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("DescribeCacheClustersRequest").add("CacheClusterId", cacheClusterId())
.add("MaxRecords", maxRecords()).add("Marker", marker()).add("ShowCacheNodeInfo", showCacheNodeInfo())
.add("ShowCacheClustersNotInReplicationGroups", showCacheClustersNotInReplicationGroups()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CacheClusterId":
return Optional.ofNullable(clazz.cast(cacheClusterId()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "ShowCacheNodeInfo":
return Optional.ofNullable(clazz.cast(showCacheNodeInfo()));
case "ShowCacheClustersNotInReplicationGroups":
return Optional.ofNullable(clazz.cast(showCacheClustersNotInReplicationGroups()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeCacheClustersRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ElastiCacheRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The user-supplied cluster identifier. If this parameter is specified, only information about that specific
* cluster is returned. This parameter isn't case sensitive.
*
*
* @param cacheClusterId
* The user-supplied cluster identifier. If this parameter is specified, only information about that
* specific cluster is returned. This parameter isn't case sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cacheClusterId(String cacheClusterId);
/**
*
* 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);
/**
*
* An optional flag that can be included in the DescribeCacheCluster request to retrieve
* information about the individual cache nodes.
*
*
* @param showCacheNodeInfo
* An optional flag that can be included in the DescribeCacheCluster request to retrieve
* information about the individual cache nodes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder showCacheNodeInfo(Boolean showCacheNodeInfo);
/**
*
* An optional flag that can be included in the DescribeCacheCluster request to show only nodes
* (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single
* node Redis clusters.
*
*
* @param showCacheClustersNotInReplicationGroups
* An optional flag that can be included in the DescribeCacheCluster request to show only
* nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean
* Memcached and single node Redis clusters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder showCacheClustersNotInReplicationGroups(Boolean showCacheClustersNotInReplicationGroups);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ElastiCacheRequest.BuilderImpl implements Builder {
private String cacheClusterId;
private Integer maxRecords;
private String marker;
private Boolean showCacheNodeInfo;
private Boolean showCacheClustersNotInReplicationGroups;
private BuilderImpl() {
}
private BuilderImpl(DescribeCacheClustersRequest model) {
super(model);
cacheClusterId(model.cacheClusterId);
maxRecords(model.maxRecords);
marker(model.marker);
showCacheNodeInfo(model.showCacheNodeInfo);
showCacheClustersNotInReplicationGroups(model.showCacheClustersNotInReplicationGroups);
}
public final String getCacheClusterId() {
return cacheClusterId;
}
@Override
public final Builder cacheClusterId(String cacheClusterId) {
this.cacheClusterId = cacheClusterId;
return this;
}
public final void setCacheClusterId(String cacheClusterId) {
this.cacheClusterId = cacheClusterId;
}
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 getShowCacheNodeInfo() {
return showCacheNodeInfo;
}
@Override
public final Builder showCacheNodeInfo(Boolean showCacheNodeInfo) {
this.showCacheNodeInfo = showCacheNodeInfo;
return this;
}
public final void setShowCacheNodeInfo(Boolean showCacheNodeInfo) {
this.showCacheNodeInfo = showCacheNodeInfo;
}
public final Boolean getShowCacheClustersNotInReplicationGroups() {
return showCacheClustersNotInReplicationGroups;
}
@Override
public final Builder showCacheClustersNotInReplicationGroups(Boolean showCacheClustersNotInReplicationGroups) {
this.showCacheClustersNotInReplicationGroups = showCacheClustersNotInReplicationGroups;
return this;
}
public final void setShowCacheClustersNotInReplicationGroups(Boolean showCacheClustersNotInReplicationGroups) {
this.showCacheClustersNotInReplicationGroups = showCacheClustersNotInReplicationGroups;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeCacheClustersRequest build() {
return new DescribeCacheClustersRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy