software.amazon.awssdk.services.elasticache.model.CacheSubnetGroup 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.io.Serializable;
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 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 one of the following operations:
*
*
* -
*
* CreateCacheSubnetGroup
*
*
* -
*
* ModifyCacheSubnetGroup
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CacheSubnetGroup implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField CACHE_SUBNET_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CacheSubnetGroupName").getter(getter(CacheSubnetGroup::cacheSubnetGroupName))
.setter(setter(Builder::cacheSubnetGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CacheSubnetGroupName").build())
.build();
private static final SdkField CACHE_SUBNET_GROUP_DESCRIPTION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("CacheSubnetGroupDescription")
.getter(getter(CacheSubnetGroup::cacheSubnetGroupDescription))
.setter(setter(Builder::cacheSubnetGroupDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CacheSubnetGroupDescription")
.build()).build();
private static final SdkField VPC_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("VpcId")
.getter(getter(CacheSubnetGroup::vpcId)).setter(setter(Builder::vpcId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpcId").build()).build();
private static final SdkField> SUBNETS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Subnets")
.getter(getter(CacheSubnetGroup::subnets))
.setter(setter(Builder::subnets))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Subnets").build(),
ListTrait
.builder()
.memberLocationName("Subnet")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Subnet::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Subnet").build()).build()).build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("ARN")
.getter(getter(CacheSubnetGroup::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ARN").build()).build();
private static final SdkField> SUPPORTED_NETWORK_TYPES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SupportedNetworkTypes")
.getter(getter(CacheSubnetGroup::supportedNetworkTypesAsStrings))
.setter(setter(Builder::supportedNetworkTypesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SupportedNetworkTypes").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(CACHE_SUBNET_GROUP_NAME_FIELD,
CACHE_SUBNET_GROUP_DESCRIPTION_FIELD, VPC_ID_FIELD, SUBNETS_FIELD, ARN_FIELD, SUPPORTED_NETWORK_TYPES_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String cacheSubnetGroupName;
private final String cacheSubnetGroupDescription;
private final String vpcId;
private final List subnets;
private final String arn;
private final List supportedNetworkTypes;
private CacheSubnetGroup(BuilderImpl builder) {
this.cacheSubnetGroupName = builder.cacheSubnetGroupName;
this.cacheSubnetGroupDescription = builder.cacheSubnetGroupDescription;
this.vpcId = builder.vpcId;
this.subnets = builder.subnets;
this.arn = builder.arn;
this.supportedNetworkTypes = builder.supportedNetworkTypes;
}
/**
*
* The name of the cache subnet group.
*
*
* @return The name of the cache subnet group.
*/
public final String cacheSubnetGroupName() {
return cacheSubnetGroupName;
}
/**
*
* The description of the cache subnet group.
*
*
* @return The description of the cache subnet group.
*/
public final String cacheSubnetGroupDescription() {
return cacheSubnetGroupDescription;
}
/**
*
* The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
*
*
* @return The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
*/
public final String vpcId() {
return vpcId;
}
/**
* For responses, this returns true if the service returned a value for the Subnets 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 hasSubnets() {
return subnets != null && !(subnets instanceof SdkAutoConstructList);
}
/**
*
* A list of subnets associated with the cache subnet group.
*
*
* 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 #hasSubnets} method.
*
*
* @return A list of subnets associated with the cache subnet group.
*/
public final List subnets() {
return subnets;
}
/**
*
* The ARN (Amazon Resource Name) of the cache subnet group.
*
*
* @return The ARN (Amazon Resource Name) of the cache subnet group.
*/
public final String arn() {
return arn;
}
/**
*
* Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using
* Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all
* instances built on the Nitro system.
*
*
* 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 #hasSupportedNetworkTypes} method.
*
*
* @return Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads
* using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and
* above on all instances built on the Nitro system.
*/
public final List supportedNetworkTypes() {
return NetworkTypeListCopier.copyStringToEnum(supportedNetworkTypes);
}
/**
* For responses, this returns true if the service returned a value for the SupportedNetworkTypes 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 hasSupportedNetworkTypes() {
return supportedNetworkTypes != null && !(supportedNetworkTypes instanceof SdkAutoConstructList);
}
/**
*
* Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using
* Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all
* instances built on the Nitro system.
*
*
* 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 #hasSupportedNetworkTypes} method.
*
*
* @return Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads
* using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and
* above on all instances built on the Nitro system.
*/
public final List supportedNetworkTypesAsStrings() {
return supportedNetworkTypes;
}
@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 + Objects.hashCode(cacheSubnetGroupName());
hashCode = 31 * hashCode + Objects.hashCode(cacheSubnetGroupDescription());
hashCode = 31 * hashCode + Objects.hashCode(vpcId());
hashCode = 31 * hashCode + Objects.hashCode(hasSubnets() ? subnets() : null);
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(hasSupportedNetworkTypes() ? supportedNetworkTypesAsStrings() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CacheSubnetGroup)) {
return false;
}
CacheSubnetGroup other = (CacheSubnetGroup) obj;
return Objects.equals(cacheSubnetGroupName(), other.cacheSubnetGroupName())
&& Objects.equals(cacheSubnetGroupDescription(), other.cacheSubnetGroupDescription())
&& Objects.equals(vpcId(), other.vpcId()) && hasSubnets() == other.hasSubnets()
&& Objects.equals(subnets(), other.subnets()) && Objects.equals(arn(), other.arn())
&& hasSupportedNetworkTypes() == other.hasSupportedNetworkTypes()
&& Objects.equals(supportedNetworkTypesAsStrings(), other.supportedNetworkTypesAsStrings());
}
/**
* 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("CacheSubnetGroup").add("CacheSubnetGroupName", cacheSubnetGroupName())
.add("CacheSubnetGroupDescription", cacheSubnetGroupDescription()).add("VpcId", vpcId())
.add("Subnets", hasSubnets() ? subnets() : null).add("ARN", arn())
.add("SupportedNetworkTypes", hasSupportedNetworkTypes() ? supportedNetworkTypesAsStrings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CacheSubnetGroupName":
return Optional.ofNullable(clazz.cast(cacheSubnetGroupName()));
case "CacheSubnetGroupDescription":
return Optional.ofNullable(clazz.cast(cacheSubnetGroupDescription()));
case "VpcId":
return Optional.ofNullable(clazz.cast(vpcId()));
case "Subnets":
return Optional.ofNullable(clazz.cast(subnets()));
case "ARN":
return Optional.ofNullable(clazz.cast(arn()));
case "SupportedNetworkTypes":
return Optional.ofNullable(clazz.cast(supportedNetworkTypesAsStrings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("CacheSubnetGroupName", CACHE_SUBNET_GROUP_NAME_FIELD);
map.put("CacheSubnetGroupDescription", CACHE_SUBNET_GROUP_DESCRIPTION_FIELD);
map.put("VpcId", VPC_ID_FIELD);
map.put("Subnets", SUBNETS_FIELD);
map.put("ARN", ARN_FIELD);
map.put("SupportedNetworkTypes", SUPPORTED_NETWORK_TYPES_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((CacheSubnetGroup) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the cache subnet group.
*
*
* @param cacheSubnetGroupName
* The name of the cache subnet group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cacheSubnetGroupName(String cacheSubnetGroupName);
/**
*
* The description of the cache subnet group.
*
*
* @param cacheSubnetGroupDescription
* The description of the cache subnet group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cacheSubnetGroupDescription(String cacheSubnetGroupDescription);
/**
*
* The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
*
*
* @param vpcId
* The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcId(String vpcId);
/**
*
* A list of subnets associated with the cache subnet group.
*
*
* @param subnets
* A list of subnets associated with the cache subnet group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnets(Collection subnets);
/**
*
* A list of subnets associated with the cache subnet group.
*
*
* @param subnets
* A list of subnets associated with the cache subnet group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnets(Subnet... subnets);
/**
*
* A list of subnets associated with the cache subnet group.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.elasticache.model.Subnet.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.elasticache.model.Subnet#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.elasticache.model.Subnet.Builder#build()} is called immediately and
* its result is passed to {@link #subnets(List)}.
*
* @param subnets
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.elasticache.model.Subnet.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #subnets(java.util.Collection)
*/
Builder subnets(Consumer... subnets);
/**
*
* The ARN (Amazon Resource Name) of the cache subnet group.
*
*
* @param arn
* The ARN (Amazon Resource Name) of the cache subnet group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using
* Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on
* all instances built on the Nitro system.
*
*
* @param supportedNetworkTypes
* Either ipv4 | ipv6 | dual_stack. IPv6 is supported for
* workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine
* version 1.6.6 and above on all instances built on the Nitro
* system.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder supportedNetworkTypesWithStrings(Collection supportedNetworkTypes);
/**
*
* Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using
* Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on
* all instances built on the Nitro system.
*
*
* @param supportedNetworkTypes
* Either ipv4 | ipv6 | dual_stack. IPv6 is supported for
* workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine
* version 1.6.6 and above on all instances built on the Nitro
* system.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder supportedNetworkTypesWithStrings(String... supportedNetworkTypes);
/**
*
* Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using
* Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on
* all instances built on the Nitro system.
*
*
* @param supportedNetworkTypes
* Either ipv4 | ipv6 | dual_stack. IPv6 is supported for
* workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine
* version 1.6.6 and above on all instances built on the Nitro
* system.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder supportedNetworkTypes(Collection supportedNetworkTypes);
/**
*
* Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using
* Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on
* all instances built on the Nitro system.
*
*
* @param supportedNetworkTypes
* Either ipv4 | ipv6 | dual_stack. IPv6 is supported for
* workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine
* version 1.6.6 and above on all instances built on the Nitro
* system.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder supportedNetworkTypes(NetworkType... supportedNetworkTypes);
}
static final class BuilderImpl implements Builder {
private String cacheSubnetGroupName;
private String cacheSubnetGroupDescription;
private String vpcId;
private List subnets = DefaultSdkAutoConstructList.getInstance();
private String arn;
private List supportedNetworkTypes = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CacheSubnetGroup model) {
cacheSubnetGroupName(model.cacheSubnetGroupName);
cacheSubnetGroupDescription(model.cacheSubnetGroupDescription);
vpcId(model.vpcId);
subnets(model.subnets);
arn(model.arn);
supportedNetworkTypesWithStrings(model.supportedNetworkTypes);
}
public final String getCacheSubnetGroupName() {
return cacheSubnetGroupName;
}
public final void setCacheSubnetGroupName(String cacheSubnetGroupName) {
this.cacheSubnetGroupName = cacheSubnetGroupName;
}
@Override
public final Builder cacheSubnetGroupName(String cacheSubnetGroupName) {
this.cacheSubnetGroupName = cacheSubnetGroupName;
return this;
}
public final String getCacheSubnetGroupDescription() {
return cacheSubnetGroupDescription;
}
public final void setCacheSubnetGroupDescription(String cacheSubnetGroupDescription) {
this.cacheSubnetGroupDescription = cacheSubnetGroupDescription;
}
@Override
public final Builder cacheSubnetGroupDescription(String cacheSubnetGroupDescription) {
this.cacheSubnetGroupDescription = cacheSubnetGroupDescription;
return this;
}
public final String getVpcId() {
return vpcId;
}
public final void setVpcId(String vpcId) {
this.vpcId = vpcId;
}
@Override
public final Builder vpcId(String vpcId) {
this.vpcId = vpcId;
return this;
}
public final List getSubnets() {
List result = SubnetListCopier.copyToBuilder(this.subnets);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSubnets(Collection subnets) {
this.subnets = SubnetListCopier.copyFromBuilder(subnets);
}
@Override
public final Builder subnets(Collection subnets) {
this.subnets = SubnetListCopier.copy(subnets);
return this;
}
@Override
@SafeVarargs
public final Builder subnets(Subnet... subnets) {
subnets(Arrays.asList(subnets));
return this;
}
@Override
@SafeVarargs
public final Builder subnets(Consumer... subnets) {
subnets(Stream.of(subnets).map(c -> Subnet.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final Collection getSupportedNetworkTypes() {
if (supportedNetworkTypes instanceof SdkAutoConstructList) {
return null;
}
return supportedNetworkTypes;
}
public final void setSupportedNetworkTypes(Collection supportedNetworkTypes) {
this.supportedNetworkTypes = NetworkTypeListCopier.copy(supportedNetworkTypes);
}
@Override
public final Builder supportedNetworkTypesWithStrings(Collection supportedNetworkTypes) {
this.supportedNetworkTypes = NetworkTypeListCopier.copy(supportedNetworkTypes);
return this;
}
@Override
@SafeVarargs
public final Builder supportedNetworkTypesWithStrings(String... supportedNetworkTypes) {
supportedNetworkTypesWithStrings(Arrays.asList(supportedNetworkTypes));
return this;
}
@Override
public final Builder supportedNetworkTypes(Collection supportedNetworkTypes) {
this.supportedNetworkTypes = NetworkTypeListCopier.copyEnumToString(supportedNetworkTypes);
return this;
}
@Override
@SafeVarargs
public final Builder supportedNetworkTypes(NetworkType... supportedNetworkTypes) {
supportedNetworkTypes(Arrays.asList(supportedNetworkTypes));
return this;
}
@Override
public CacheSubnetGroup build() {
return new CacheSubnetGroup(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}