software.amazon.awssdk.services.docdbelastic.model

Class ClusterSnapshot

java.lang.Object

software.amazon.awssdk.services.docdbelastic.model.ClusterSnapshot

All Implemented Interfaces:

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

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

Returns information about a specific Elastic DocumentDB snapshot.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClusterSnapshot.Builder

Method Summary

Modifier and Type	Method and Description
String	adminUserName() The name of the Elastic DocumentDB cluster administrator.
static ClusterSnapshot.Builder	builder()
String	clusterArn() The arn of the Elastic DocumentDB cluster.
String	clusterCreationTime() The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubnetIds() For responses, this returns true if the service returned a value for the SubnetIds property.
boolean	hasVpcSecurityGroupIds() For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
String	kmsKeyId() The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends ClusterSnapshot.Builder>	serializableBuilderClass()
String	snapshotArn() The arn of the Elastic DocumentDB snapshot
String	snapshotCreationTime() The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
String	snapshotName() The name of the Elastic DocumentDB snapshot.
Status	status() The status of the Elastic DocumentDB snapshot.
String	statusAsString() The status of the Elastic DocumentDB snapshot.
List<String>	subnetIds() A list of the IDs of subnets associated with the DB cluster snapshot.
ClusterSnapshot.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	vpcSecurityGroupIds() A list of the IDs of the VPC security groups associated with the cluster snapshot.

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

adminUserName

public final String adminUserName()

The name of the Elastic DocumentDB cluster administrator.

Returns:

The name of the Elastic DocumentDB cluster administrator.

clusterArn

public final String clusterArn()

The arn of the Elastic DocumentDB cluster.

Returns:

The arn of the Elastic DocumentDB cluster.

clusterCreationTime

public final String clusterCreationTime()

The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

Returns:

The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

kmsKeyId

public final String kmsKeyId()

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

Returns:

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

snapshotArn

public final String snapshotArn()

The arn of the Elastic DocumentDB snapshot

Returns:

The arn of the Elastic DocumentDB snapshot

snapshotCreationTime

public final String snapshotCreationTime()

The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).

Returns:

The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).

snapshotName

public final String snapshotName()

The name of the Elastic DocumentDB snapshot.

Returns:

The name of the Elastic DocumentDB snapshot.

status

public final Status status()

The status of the Elastic DocumentDB snapshot.

If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the Elastic DocumentDB snapshot.

See Also:

Status

statusAsString

public final String statusAsString()

The status of the Elastic DocumentDB snapshot.

If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the Elastic DocumentDB snapshot.

See Also:

Status

hasSubnetIds

public final boolean hasSubnetIds()

For responses, this returns true if the service returned a value for the SubnetIds 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.

subnetIds

public final List<String> subnetIds()

A list of the IDs of subnets associated with the DB cluster snapshot.

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 hasSubnetIds() method.

Returns:

A list of the IDs of subnets associated with the DB cluster snapshot.

hasVpcSecurityGroupIds

public final boolean hasVpcSecurityGroupIds()

For responses, this returns true if the service returned a value for the VpcSecurityGroupIds 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.

vpcSecurityGroupIds

public final List<String> vpcSecurityGroupIds()

A list of the IDs of the VPC security groups associated with the cluster snapshot.

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 hasVpcSecurityGroupIds() method.

Returns:

A list of the IDs of the VPC security groups associated with the cluster snapshot.

toBuilder

public ClusterSnapshot.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClusterSnapshot.Builder,ClusterSnapshot>

builder

public static ClusterSnapshot.Builder builder()

serializableBuilderClass

public static Class<? extends ClusterSnapshot.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