software.amazon.awssdk.services.docdb.model

Class ModifyDbClusterSnapshotAttributeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.docdb.model.DocDbRequest

software.amazon.awssdk.services.docdb.model.ModifyDbClusterSnapshotAttributeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyDbClusterSnapshotAttributeRequest.Builder,ModifyDbClusterSnapshotAttributeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModifyDbClusterSnapshotAttributeRequest
extends DocDbRequest
implements ToCopyableBuilder<ModifyDbClusterSnapshotAttributeRequest.Builder,ModifyDbClusterSnapshotAttributeRequest>

Represents the input to ModifyDBClusterSnapshotAttribute.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyDbClusterSnapshotAttributeRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	attributeName() The name of the cluster snapshot attribute to modify.
static ModifyDbClusterSnapshotAttributeRequest.Builder	builder()
String	dbClusterSnapshotIdentifier() The identifier for the cluster snapshot to modify the attributes for.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValuesToAdd() For responses, this returns true if the service returned a value for the ValuesToAdd property.
boolean	hasValuesToRemove() For responses, this returns true if the service returned a value for the ValuesToRemove property.
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyDbClusterSnapshotAttributeRequest.Builder>	serializableBuilderClass()
ModifyDbClusterSnapshotAttributeRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	valuesToAdd() A list of cluster snapshot attributes to add to the attribute specified by AttributeName.
List<String>	valuesToRemove() A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

dbClusterSnapshotIdentifier

public final String dbClusterSnapshotIdentifier()

The identifier for the cluster snapshot to modify the attributes for.

Returns:

The identifier for the cluster snapshot to modify the attributes for.

attributeName

public final String attributeName()

The name of the cluster snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to restore.

Returns:

The name of the cluster snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to restore.

hasValuesToAdd

public final boolean hasValuesToAdd()

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

valuesToAdd

public final List<String> valuesToAdd()

A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all Amazon Web Services accounts.

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

Returns:

A list of cluster snapshot attributes to add to the attribute specified by AttributeName .

To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all Amazon Web Services accounts.

hasValuesToRemove

public final boolean hasValuesToRemove()

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

valuesToRemove

public final List<String> valuesToRemove()

A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual 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 hasValuesToRemove() method.

Returns:

A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.

toBuilder

public ModifyDbClusterSnapshotAttributeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyDbClusterSnapshotAttributeRequest.Builder,ModifyDbClusterSnapshotAttributeRequest>

Specified by:

toBuilder in class DocDbRequest

builder

public static ModifyDbClusterSnapshotAttributeRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo