software.amazon.awssdk.services.docdb.model

Class DBClusterSnapshotAttribute

java.lang.Object

software.amazon.awssdk.services.docdb.model.DBClusterSnapshotAttribute

All Implemented Interfaces:

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

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

Contains the name and values of a manual cluster snapshot attribute.

Manual cluster snapshot attributes are used to authorize other accounts to restore a manual cluster snapshot.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DBClusterSnapshotAttribute.Builder

Method Summary

Modifier and Type	Method and Description
String	attributeName() The name of the manual cluster snapshot attribute.
List<String>	attributeValues() The values for the manual cluster snapshot attribute.
static DBClusterSnapshotAttribute.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributeValues() For responses, this returns true if the service returned a value for the AttributeValues property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DBClusterSnapshotAttribute.Builder>	serializableBuilderClass()
DBClusterSnapshotAttribute.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

attributeName

public final String attributeName()

The name of the manual cluster snapshot attribute.

The attribute named restore refers to the list of accounts that have permission to copy or restore the manual cluster snapshot.

Returns:

The name of the manual cluster snapshot attribute.

The attribute named restore refers to the list of accounts that have permission to copy or restore the manual cluster snapshot.

hasAttributeValues

public final boolean hasAttributeValues()

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

attributeValues

public final List<String> attributeValues()

The values for the manual cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any account to copy or restore.

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

Returns:

The values for the manual cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any account to copy or restore.

toBuilder

public DBClusterSnapshotAttribute.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DBClusterSnapshotAttribute.Builder,DBClusterSnapshotAttribute>

builder

public static DBClusterSnapshotAttribute.Builder builder()

serializableBuilderClass

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