software.amazon.awssdk.services.rds.model.DBSubnetGroup Maven / Gradle / Ivy
Show all versions of rds 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.rds.model;
import java.io.Serializable;
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;
/**
*
* Contains the details of an Amazon RDS DB subnet group.
*
*
* This data type is used as a response element in the DescribeDBSubnetGroups action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DBSubnetGroup implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField DB_SUBNET_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBSubnetGroupName").getter(getter(DBSubnetGroup::dbSubnetGroupName))
.setter(setter(Builder::dbSubnetGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBSubnetGroupName").build()).build();
private static final SdkField DB_SUBNET_GROUP_DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBSubnetGroupDescription").getter(getter(DBSubnetGroup::dbSubnetGroupDescription))
.setter(setter(Builder::dbSubnetGroupDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBSubnetGroupDescription").build())
.build();
private static final SdkField VPC_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("VpcId")
.getter(getter(DBSubnetGroup::vpcId)).setter(setter(Builder::vpcId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpcId").build()).build();
private static final SdkField SUBNET_GROUP_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SubnetGroupStatus").getter(getter(DBSubnetGroup::subnetGroupStatus))
.setter(setter(Builder::subnetGroupStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SubnetGroupStatus").build()).build();
private static final SdkField> SUBNETS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Subnets")
.getter(getter(DBSubnetGroup::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 DB_SUBNET_GROUP_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBSubnetGroupArn").getter(getter(DBSubnetGroup::dbSubnetGroupArn))
.setter(setter(Builder::dbSubnetGroupArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBSubnetGroupArn").build()).build();
private static final SdkField> SUPPORTED_NETWORK_TYPES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SupportedNetworkTypes")
.getter(getter(DBSubnetGroup::supportedNetworkTypes))
.setter(setter(Builder::supportedNetworkTypes))
.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(DB_SUBNET_GROUP_NAME_FIELD,
DB_SUBNET_GROUP_DESCRIPTION_FIELD, VPC_ID_FIELD, SUBNET_GROUP_STATUS_FIELD, SUBNETS_FIELD, DB_SUBNET_GROUP_ARN_FIELD,
SUPPORTED_NETWORK_TYPES_FIELD));
private static final long serialVersionUID = 1L;
private final String dbSubnetGroupName;
private final String dbSubnetGroupDescription;
private final String vpcId;
private final String subnetGroupStatus;
private final List subnets;
private final String dbSubnetGroupArn;
private final List supportedNetworkTypes;
private DBSubnetGroup(BuilderImpl builder) {
this.dbSubnetGroupName = builder.dbSubnetGroupName;
this.dbSubnetGroupDescription = builder.dbSubnetGroupDescription;
this.vpcId = builder.vpcId;
this.subnetGroupStatus = builder.subnetGroupStatus;
this.subnets = builder.subnets;
this.dbSubnetGroupArn = builder.dbSubnetGroupArn;
this.supportedNetworkTypes = builder.supportedNetworkTypes;
}
/**
*
* The name of the DB subnet group.
*
*
* @return The name of the DB subnet group.
*/
public final String dbSubnetGroupName() {
return dbSubnetGroupName;
}
/**
*
* Provides the description of the DB subnet group.
*
*
* @return Provides the description of the DB subnet group.
*/
public final String dbSubnetGroupDescription() {
return dbSubnetGroupDescription;
}
/**
*
* Provides the VpcId of the DB subnet group.
*
*
* @return Provides the VpcId of the DB subnet group.
*/
public final String vpcId() {
return vpcId;
}
/**
*
* Provides the status of the DB subnet group.
*
*
* @return Provides the status of the DB subnet group.
*/
public final String subnetGroupStatus() {
return subnetGroupStatus;
}
/**
* 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);
}
/**
*
* Contains a list of Subnet elements.
*
*
* 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 Contains a list of Subnet elements.
*/
public final List subnets() {
return subnets;
}
/**
*
* The Amazon Resource Name (ARN) for the DB subnet group.
*
*
* @return The Amazon Resource Name (ARN) for the DB subnet group.
*/
public final String dbSubnetGroupArn() {
return dbSubnetGroupArn;
}
/**
* 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);
}
/**
*
* The network type of the DB subnet group.
*
*
* Valid values:
*
*
* -
*
* IPV4
*
*
* -
*
* DUAL
*
*
*
*
* A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
* DUAL).
*
*
* For more information, see Working
* with a DB instance in a VPC in the Amazon RDS User Guide.
*
*
* 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 The network type of the DB subnet group.
*
* Valid values:
*
*
* -
*
* IPV4
*
*
* -
*
* DUAL
*
*
*
*
* A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
* DUAL).
*
*
* For more information, see
* Working with a DB instance in a VPC in the Amazon RDS User Guide.
*/
public final List supportedNetworkTypes() {
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(dbSubnetGroupName());
hashCode = 31 * hashCode + Objects.hashCode(dbSubnetGroupDescription());
hashCode = 31 * hashCode + Objects.hashCode(vpcId());
hashCode = 31 * hashCode + Objects.hashCode(subnetGroupStatus());
hashCode = 31 * hashCode + Objects.hashCode(hasSubnets() ? subnets() : null);
hashCode = 31 * hashCode + Objects.hashCode(dbSubnetGroupArn());
hashCode = 31 * hashCode + Objects.hashCode(hasSupportedNetworkTypes() ? supportedNetworkTypes() : 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 DBSubnetGroup)) {
return false;
}
DBSubnetGroup other = (DBSubnetGroup) obj;
return Objects.equals(dbSubnetGroupName(), other.dbSubnetGroupName())
&& Objects.equals(dbSubnetGroupDescription(), other.dbSubnetGroupDescription())
&& Objects.equals(vpcId(), other.vpcId()) && Objects.equals(subnetGroupStatus(), other.subnetGroupStatus())
&& hasSubnets() == other.hasSubnets() && Objects.equals(subnets(), other.subnets())
&& Objects.equals(dbSubnetGroupArn(), other.dbSubnetGroupArn())
&& hasSupportedNetworkTypes() == other.hasSupportedNetworkTypes()
&& Objects.equals(supportedNetworkTypes(), other.supportedNetworkTypes());
}
/**
* 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("DBSubnetGroup").add("DBSubnetGroupName", dbSubnetGroupName())
.add("DBSubnetGroupDescription", dbSubnetGroupDescription()).add("VpcId", vpcId())
.add("SubnetGroupStatus", subnetGroupStatus()).add("Subnets", hasSubnets() ? subnets() : null)
.add("DBSubnetGroupArn", dbSubnetGroupArn())
.add("SupportedNetworkTypes", hasSupportedNetworkTypes() ? supportedNetworkTypes() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBSubnetGroupName":
return Optional.ofNullable(clazz.cast(dbSubnetGroupName()));
case "DBSubnetGroupDescription":
return Optional.ofNullable(clazz.cast(dbSubnetGroupDescription()));
case "VpcId":
return Optional.ofNullable(clazz.cast(vpcId()));
case "SubnetGroupStatus":
return Optional.ofNullable(clazz.cast(subnetGroupStatus()));
case "Subnets":
return Optional.ofNullable(clazz.cast(subnets()));
case "DBSubnetGroupArn":
return Optional.ofNullable(clazz.cast(dbSubnetGroupArn()));
case "SupportedNetworkTypes":
return Optional.ofNullable(clazz.cast(supportedNetworkTypes()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DBSubnetGroup) 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 DB subnet group.
*
*
* @param dbSubnetGroupName
* The name of the DB subnet group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSubnetGroupName(String dbSubnetGroupName);
/**
*
* Provides the description of the DB subnet group.
*
*
* @param dbSubnetGroupDescription
* Provides the description of the DB subnet group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSubnetGroupDescription(String dbSubnetGroupDescription);
/**
*
* Provides the VpcId of the DB subnet group.
*
*
* @param vpcId
* Provides the VpcId of the DB subnet group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcId(String vpcId);
/**
*
* Provides the status of the DB subnet group.
*
*
* @param subnetGroupStatus
* Provides the status of the DB subnet group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnetGroupStatus(String subnetGroupStatus);
/**
*
* Contains a list of Subnet elements.
*
*
* @param subnets
* Contains a list of Subnet elements.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnets(Collection subnets);
/**
*
* Contains a list of Subnet elements.
*
*
* @param subnets
* Contains a list of Subnet elements.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnets(Subnet... subnets);
/**
*
* Contains a list of Subnet elements.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.Subnet.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.rds.model.Subnet#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.rds.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.rds.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 Amazon Resource Name (ARN) for the DB subnet group.
*
*
* @param dbSubnetGroupArn
* The Amazon Resource Name (ARN) for the DB subnet group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSubnetGroupArn(String dbSubnetGroupArn);
/**
*
* The network type of the DB subnet group.
*
*
* Valid values:
*
*
* -
*
* IPV4
*
*
* -
*
* DUAL
*
*
*
*
* A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
* DUAL).
*
*
* For more information, see
* Working with a DB instance in a VPC in the Amazon RDS User Guide.
*
*
* @param supportedNetworkTypes
* The network type of the DB subnet group.
*
* Valid values:
*
*
* -
*
* IPV4
*
*
* -
*
* DUAL
*
*
*
*
* A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
* DUAL).
*
*
* For more information, see
* Working with a DB instance in a VPC in the Amazon RDS User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder supportedNetworkTypes(Collection supportedNetworkTypes);
/**
*
* The network type of the DB subnet group.
*
*
* Valid values:
*
*
* -
*
* IPV4
*
*
* -
*
* DUAL
*
*
*
*
* A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
* DUAL).
*
*
* For more information, see
* Working with a DB instance in a VPC in the Amazon RDS User Guide.
*
*
* @param supportedNetworkTypes
* The network type of the DB subnet group.
*
* Valid values:
*
*
* -
*
* IPV4
*
*
* -
*
* DUAL
*
*
*
*
* A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
* DUAL).
*
*
* For more information, see
* Working with a DB instance in a VPC in the Amazon RDS User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder supportedNetworkTypes(String... supportedNetworkTypes);
}
static final class BuilderImpl implements Builder {
private String dbSubnetGroupName;
private String dbSubnetGroupDescription;
private String vpcId;
private String subnetGroupStatus;
private List subnets = DefaultSdkAutoConstructList.getInstance();
private String dbSubnetGroupArn;
private List supportedNetworkTypes = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DBSubnetGroup model) {
dbSubnetGroupName(model.dbSubnetGroupName);
dbSubnetGroupDescription(model.dbSubnetGroupDescription);
vpcId(model.vpcId);
subnetGroupStatus(model.subnetGroupStatus);
subnets(model.subnets);
dbSubnetGroupArn(model.dbSubnetGroupArn);
supportedNetworkTypes(model.supportedNetworkTypes);
}
public final String getDbSubnetGroupName() {
return dbSubnetGroupName;
}
public final void setDbSubnetGroupName(String dbSubnetGroupName) {
this.dbSubnetGroupName = dbSubnetGroupName;
}
@Override
public final Builder dbSubnetGroupName(String dbSubnetGroupName) {
this.dbSubnetGroupName = dbSubnetGroupName;
return this;
}
public final String getDbSubnetGroupDescription() {
return dbSubnetGroupDescription;
}
public final void setDbSubnetGroupDescription(String dbSubnetGroupDescription) {
this.dbSubnetGroupDescription = dbSubnetGroupDescription;
}
@Override
public final Builder dbSubnetGroupDescription(String dbSubnetGroupDescription) {
this.dbSubnetGroupDescription = dbSubnetGroupDescription;
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 String getSubnetGroupStatus() {
return subnetGroupStatus;
}
public final void setSubnetGroupStatus(String subnetGroupStatus) {
this.subnetGroupStatus = subnetGroupStatus;
}
@Override
public final Builder subnetGroupStatus(String subnetGroupStatus) {
this.subnetGroupStatus = subnetGroupStatus;
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 getDbSubnetGroupArn() {
return dbSubnetGroupArn;
}
public final void setDbSubnetGroupArn(String dbSubnetGroupArn) {
this.dbSubnetGroupArn = dbSubnetGroupArn;
}
@Override
public final Builder dbSubnetGroupArn(String dbSubnetGroupArn) {
this.dbSubnetGroupArn = dbSubnetGroupArn;
return this;
}
public final Collection getSupportedNetworkTypes() {
if (supportedNetworkTypes instanceof SdkAutoConstructList) {
return null;
}
return supportedNetworkTypes;
}
public final void setSupportedNetworkTypes(Collection supportedNetworkTypes) {
this.supportedNetworkTypes = StringListCopier.copy(supportedNetworkTypes);
}
@Override
public final Builder supportedNetworkTypes(Collection supportedNetworkTypes) {
this.supportedNetworkTypes = StringListCopier.copy(supportedNetworkTypes);
return this;
}
@Override
@SafeVarargs
public final Builder supportedNetworkTypes(String... supportedNetworkTypes) {
supportedNetworkTypes(Arrays.asList(supportedNetworkTypes));
return this;
}
@Override
public DBSubnetGroup build() {
return new DBSubnetGroup(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}