Package software.amazon.awssdk.services.docdb.model

Class DBSubnetGroup

java.lang.Object

software.amazon.awssdk.services.docdb.model.DBSubnetGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DBSubnetGroup.Builder,DBSubnetGroup>

@Generated("software.amazon.awssdk:codegen")
public final class DBSubnetGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DBSubnetGroup.Builder,DBSubnetGroup>

Detailed information about a subnet group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DBSubnetGroup.Builder

Method Summary

Modifier and Type	Method	Description
static DBSubnetGroup.Builder	builder()
String	dbSubnetGroupArn()	The Amazon Resource Name (ARN) for the DB subnet group.
String	dbSubnetGroupDescription()	Provides the description of the subnet group.
String	dbSubnetGroupName()	The name of the subnet group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubnets()	For responses, this returns true if the service returned a value for the Subnets property.
List<SdkField<?>>	sdkFields()
static Class<? extends DBSubnetGroup.Builder>	serializableBuilderClass()
String	subnetGroupStatus()	Provides the status of the subnet group.
List<Subnet>	subnets()	Detailed information about one or more subnets within a subnet group.
DBSubnetGroup.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	vpcId()	Provides the virtual private cloud (VPC) ID of the subnet group.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

dbSubnetGroupName

public final String dbSubnetGroupName()

The name of the subnet group.

Returns:

The name of the subnet group.

dbSubnetGroupDescription

public final String dbSubnetGroupDescription()

Provides the description of the subnet group.

Returns:

Provides the description of the subnet group.

vpcId

public final String vpcId()

Provides the virtual private cloud (VPC) ID of the subnet group.

Returns:

Provides the virtual private cloud (VPC) ID of the subnet group.

subnetGroupStatus

public final String subnetGroupStatus()

Provides the status of the subnet group.

Returns:

Provides the status of the subnet group.

hasSubnets

public final boolean hasSubnets()

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 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.

subnets

public final List<Subnet> subnets()

Detailed information about one or more subnets within a 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 hasSubnets() method.

Returns:

Detailed information about one or more subnets within a subnet group.

dbSubnetGroupArn

public final String dbSubnetGroupArn()

The Amazon Resource Name (ARN) for the DB subnet group.

Returns:

The Amazon Resource Name (ARN) for the DB subnet group.

toBuilder

public DBSubnetGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DBSubnetGroup.Builder,DBSubnetGroup>

builder

public static DBSubnetGroup.Builder builder()

serializableBuilderClass

public static Class<? extends DBSubnetGroup.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo