software.amazon.awssdk.services.rds.model.DBSecurityGroup 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.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;
/**
*
* Contains the details for an Amazon RDS DB security group.
*
*
* This data type is used as a response element in the DescribeDBSecurityGroups action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DBSecurityGroup implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField OWNER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OwnerId").getter(getter(DBSecurityGroup::ownerId)).setter(setter(Builder::ownerId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OwnerId").build()).build();
private static final SdkField DB_SECURITY_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBSecurityGroupName").getter(getter(DBSecurityGroup::dbSecurityGroupName))
.setter(setter(Builder::dbSecurityGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBSecurityGroupName").build())
.build();
private static final SdkField DB_SECURITY_GROUP_DESCRIPTION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("DBSecurityGroupDescription")
.getter(getter(DBSecurityGroup::dbSecurityGroupDescription))
.setter(setter(Builder::dbSecurityGroupDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBSecurityGroupDescription").build())
.build();
private static final SdkField VPC_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("VpcId")
.getter(getter(DBSecurityGroup::vpcId)).setter(setter(Builder::vpcId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpcId").build()).build();
private static final SdkField> EC2_SECURITY_GROUPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("EC2SecurityGroups")
.getter(getter(DBSecurityGroup::ec2SecurityGroups))
.setter(setter(Builder::ec2SecurityGroups))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EC2SecurityGroups").build(),
ListTrait
.builder()
.memberLocationName("EC2SecurityGroup")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(EC2SecurityGroup::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("EC2SecurityGroup").build()).build()).build()).build();
private static final SdkField> IP_RANGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("IPRanges")
.getter(getter(DBSecurityGroup::ipRanges))
.setter(setter(Builder::ipRanges))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IPRanges").build(),
ListTrait
.builder()
.memberLocationName("IPRange")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(IPRange::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("IPRange").build()).build()).build()).build();
private static final SdkField DB_SECURITY_GROUP_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBSecurityGroupArn").getter(getter(DBSecurityGroup::dbSecurityGroupArn))
.setter(setter(Builder::dbSecurityGroupArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBSecurityGroupArn").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OWNER_ID_FIELD,
DB_SECURITY_GROUP_NAME_FIELD, DB_SECURITY_GROUP_DESCRIPTION_FIELD, VPC_ID_FIELD, EC2_SECURITY_GROUPS_FIELD,
IP_RANGES_FIELD, DB_SECURITY_GROUP_ARN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String ownerId;
private final String dbSecurityGroupName;
private final String dbSecurityGroupDescription;
private final String vpcId;
private final List ec2SecurityGroups;
private final List ipRanges;
private final String dbSecurityGroupArn;
private DBSecurityGroup(BuilderImpl builder) {
this.ownerId = builder.ownerId;
this.dbSecurityGroupName = builder.dbSecurityGroupName;
this.dbSecurityGroupDescription = builder.dbSecurityGroupDescription;
this.vpcId = builder.vpcId;
this.ec2SecurityGroups = builder.ec2SecurityGroups;
this.ipRanges = builder.ipRanges;
this.dbSecurityGroupArn = builder.dbSecurityGroupArn;
}
/**
*
* Provides the Amazon Web Services ID of the owner of a specific DB security group.
*
*
* @return Provides the Amazon Web Services ID of the owner of a specific DB security group.
*/
public final String ownerId() {
return ownerId;
}
/**
*
* Specifies the name of the DB security group.
*
*
* @return Specifies the name of the DB security group.
*/
public final String dbSecurityGroupName() {
return dbSecurityGroupName;
}
/**
*
* Provides the description of the DB security group.
*
*
* @return Provides the description of the DB security group.
*/
public final String dbSecurityGroupDescription() {
return dbSecurityGroupDescription;
}
/**
*
* Provides the VpcId of the DB security group.
*
*
* @return Provides the VpcId of the DB security group.
*/
public final String vpcId() {
return vpcId;
}
/**
* For responses, this returns true if the service returned a value for the EC2SecurityGroups 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 hasEc2SecurityGroups() {
return ec2SecurityGroups != null && !(ec2SecurityGroups instanceof SdkAutoConstructList);
}
/**
*
* Contains a list of EC2SecurityGroup 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 #hasEc2SecurityGroups} method.
*
*
* @return Contains a list of EC2SecurityGroup elements.
*/
public final List ec2SecurityGroups() {
return ec2SecurityGroups;
}
/**
* For responses, this returns true if the service returned a value for the IPRanges 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 hasIpRanges() {
return ipRanges != null && !(ipRanges instanceof SdkAutoConstructList);
}
/**
*
* Contains a list of IPRange 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 #hasIpRanges} method.
*
*
* @return Contains a list of IPRange elements.
*/
public final List ipRanges() {
return ipRanges;
}
/**
*
* The Amazon Resource Name (ARN) for the DB security group.
*
*
* @return The Amazon Resource Name (ARN) for the DB security group.
*/
public final String dbSecurityGroupArn() {
return dbSecurityGroupArn;
}
@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(ownerId());
hashCode = 31 * hashCode + Objects.hashCode(dbSecurityGroupName());
hashCode = 31 * hashCode + Objects.hashCode(dbSecurityGroupDescription());
hashCode = 31 * hashCode + Objects.hashCode(vpcId());
hashCode = 31 * hashCode + Objects.hashCode(hasEc2SecurityGroups() ? ec2SecurityGroups() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasIpRanges() ? ipRanges() : null);
hashCode = 31 * hashCode + Objects.hashCode(dbSecurityGroupArn());
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 DBSecurityGroup)) {
return false;
}
DBSecurityGroup other = (DBSecurityGroup) obj;
return Objects.equals(ownerId(), other.ownerId()) && Objects.equals(dbSecurityGroupName(), other.dbSecurityGroupName())
&& Objects.equals(dbSecurityGroupDescription(), other.dbSecurityGroupDescription())
&& Objects.equals(vpcId(), other.vpcId()) && hasEc2SecurityGroups() == other.hasEc2SecurityGroups()
&& Objects.equals(ec2SecurityGroups(), other.ec2SecurityGroups()) && hasIpRanges() == other.hasIpRanges()
&& Objects.equals(ipRanges(), other.ipRanges())
&& Objects.equals(dbSecurityGroupArn(), other.dbSecurityGroupArn());
}
/**
* 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("DBSecurityGroup").add("OwnerId", ownerId()).add("DBSecurityGroupName", dbSecurityGroupName())
.add("DBSecurityGroupDescription", dbSecurityGroupDescription()).add("VpcId", vpcId())
.add("EC2SecurityGroups", hasEc2SecurityGroups() ? ec2SecurityGroups() : null)
.add("IPRanges", hasIpRanges() ? ipRanges() : null).add("DBSecurityGroupArn", dbSecurityGroupArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "OwnerId":
return Optional.ofNullable(clazz.cast(ownerId()));
case "DBSecurityGroupName":
return Optional.ofNullable(clazz.cast(dbSecurityGroupName()));
case "DBSecurityGroupDescription":
return Optional.ofNullable(clazz.cast(dbSecurityGroupDescription()));
case "VpcId":
return Optional.ofNullable(clazz.cast(vpcId()));
case "EC2SecurityGroups":
return Optional.ofNullable(clazz.cast(ec2SecurityGroups()));
case "IPRanges":
return Optional.ofNullable(clazz.cast(ipRanges()));
case "DBSecurityGroupArn":
return Optional.ofNullable(clazz.cast(dbSecurityGroupArn()));
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("OwnerId", OWNER_ID_FIELD);
map.put("DBSecurityGroupName", DB_SECURITY_GROUP_NAME_FIELD);
map.put("DBSecurityGroupDescription", DB_SECURITY_GROUP_DESCRIPTION_FIELD);
map.put("VpcId", VPC_ID_FIELD);
map.put("EC2SecurityGroups", EC2_SECURITY_GROUPS_FIELD);
map.put("IPRanges", IP_RANGES_FIELD);
map.put("DBSecurityGroupArn", DB_SECURITY_GROUP_ARN_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((DBSecurityGroup) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Provides the Amazon Web Services ID of the owner of a specific DB security group.
*
*
* @param ownerId
* Provides the Amazon Web Services ID of the owner of a specific DB security group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ownerId(String ownerId);
/**
*
* Specifies the name of the DB security group.
*
*
* @param dbSecurityGroupName
* Specifies the name of the DB security group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSecurityGroupName(String dbSecurityGroupName);
/**
*
* Provides the description of the DB security group.
*
*
* @param dbSecurityGroupDescription
* Provides the description of the DB security group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSecurityGroupDescription(String dbSecurityGroupDescription);
/**
*
* Provides the VpcId of the DB security group.
*
*
* @param vpcId
* Provides the VpcId of the DB security group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcId(String vpcId);
/**
*
* Contains a list of EC2SecurityGroup elements.
*
*
* @param ec2SecurityGroups
* Contains a list of EC2SecurityGroup elements.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ec2SecurityGroups(Collection ec2SecurityGroups);
/**
*
* Contains a list of EC2SecurityGroup elements.
*
*
* @param ec2SecurityGroups
* Contains a list of EC2SecurityGroup elements.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ec2SecurityGroups(EC2SecurityGroup... ec2SecurityGroups);
/**
*
* Contains a list of EC2SecurityGroup elements.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.EC2SecurityGroup.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.rds.model.EC2SecurityGroup#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.rds.model.EC2SecurityGroup.Builder#build()} is called immediately and
* its result is passed to {@link #ec2SecurityGroups(List)}.
*
* @param ec2SecurityGroups
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.rds.model.EC2SecurityGroup.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #ec2SecurityGroups(java.util.Collection)
*/
Builder ec2SecurityGroups(Consumer... ec2SecurityGroups);
/**
*
* Contains a list of IPRange elements.
*
*
* @param ipRanges
* Contains a list of IPRange elements.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ipRanges(Collection ipRanges);
/**
*
* Contains a list of IPRange elements.
*
*
* @param ipRanges
* Contains a list of IPRange elements.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ipRanges(IPRange... ipRanges);
/**
*
* Contains a list of IPRange elements.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.IPRange.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.rds.model.IPRange#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.rds.model.IPRange.Builder#build()} is called immediately and its
* result is passed to {@link #ipRanges(List)}.
*
* @param ipRanges
* a consumer that will call methods on {@link software.amazon.awssdk.services.rds.model.IPRange.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #ipRanges(java.util.Collection)
*/
Builder ipRanges(Consumer... ipRanges);
/**
*
* The Amazon Resource Name (ARN) for the DB security group.
*
*
* @param dbSecurityGroupArn
* The Amazon Resource Name (ARN) for the DB security group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSecurityGroupArn(String dbSecurityGroupArn);
}
static final class BuilderImpl implements Builder {
private String ownerId;
private String dbSecurityGroupName;
private String dbSecurityGroupDescription;
private String vpcId;
private List ec2SecurityGroups = DefaultSdkAutoConstructList.getInstance();
private List ipRanges = DefaultSdkAutoConstructList.getInstance();
private String dbSecurityGroupArn;
private BuilderImpl() {
}
private BuilderImpl(DBSecurityGroup model) {
ownerId(model.ownerId);
dbSecurityGroupName(model.dbSecurityGroupName);
dbSecurityGroupDescription(model.dbSecurityGroupDescription);
vpcId(model.vpcId);
ec2SecurityGroups(model.ec2SecurityGroups);
ipRanges(model.ipRanges);
dbSecurityGroupArn(model.dbSecurityGroupArn);
}
public final String getOwnerId() {
return ownerId;
}
public final void setOwnerId(String ownerId) {
this.ownerId = ownerId;
}
@Override
public final Builder ownerId(String ownerId) {
this.ownerId = ownerId;
return this;
}
public final String getDbSecurityGroupName() {
return dbSecurityGroupName;
}
public final void setDbSecurityGroupName(String dbSecurityGroupName) {
this.dbSecurityGroupName = dbSecurityGroupName;
}
@Override
public final Builder dbSecurityGroupName(String dbSecurityGroupName) {
this.dbSecurityGroupName = dbSecurityGroupName;
return this;
}
public final String getDbSecurityGroupDescription() {
return dbSecurityGroupDescription;
}
public final void setDbSecurityGroupDescription(String dbSecurityGroupDescription) {
this.dbSecurityGroupDescription = dbSecurityGroupDescription;
}
@Override
public final Builder dbSecurityGroupDescription(String dbSecurityGroupDescription) {
this.dbSecurityGroupDescription = dbSecurityGroupDescription;
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 getEc2SecurityGroups() {
List result = EC2SecurityGroupListCopier.copyToBuilder(this.ec2SecurityGroups);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setEc2SecurityGroups(Collection ec2SecurityGroups) {
this.ec2SecurityGroups = EC2SecurityGroupListCopier.copyFromBuilder(ec2SecurityGroups);
}
@Override
public final Builder ec2SecurityGroups(Collection ec2SecurityGroups) {
this.ec2SecurityGroups = EC2SecurityGroupListCopier.copy(ec2SecurityGroups);
return this;
}
@Override
@SafeVarargs
public final Builder ec2SecurityGroups(EC2SecurityGroup... ec2SecurityGroups) {
ec2SecurityGroups(Arrays.asList(ec2SecurityGroups));
return this;
}
@Override
@SafeVarargs
public final Builder ec2SecurityGroups(Consumer... ec2SecurityGroups) {
ec2SecurityGroups(Stream.of(ec2SecurityGroups).map(c -> EC2SecurityGroup.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getIpRanges() {
List result = IPRangeListCopier.copyToBuilder(this.ipRanges);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setIpRanges(Collection ipRanges) {
this.ipRanges = IPRangeListCopier.copyFromBuilder(ipRanges);
}
@Override
public final Builder ipRanges(Collection ipRanges) {
this.ipRanges = IPRangeListCopier.copy(ipRanges);
return this;
}
@Override
@SafeVarargs
public final Builder ipRanges(IPRange... ipRanges) {
ipRanges(Arrays.asList(ipRanges));
return this;
}
@Override
@SafeVarargs
public final Builder ipRanges(Consumer... ipRanges) {
ipRanges(Stream.of(ipRanges).map(c -> IPRange.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getDbSecurityGroupArn() {
return dbSecurityGroupArn;
}
public final void setDbSecurityGroupArn(String dbSecurityGroupArn) {
this.dbSecurityGroupArn = dbSecurityGroupArn;
}
@Override
public final Builder dbSecurityGroupArn(String dbSecurityGroupArn) {
this.dbSecurityGroupArn = dbSecurityGroupArn;
return this;
}
@Override
public DBSecurityGroup build() {
return new DBSecurityGroup(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}