Package 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("software.amazon.awssdk:codegen") public final class ModifyDbClusterSnapshotAttributeRequest extends DocDbRequest implements ToCopyableBuilder<ModifyDbClusterSnapshotAttributeRequest.Builder,ModifyDbClusterSnapshotAttributeRequest>

Represents the input to ModifyDBClusterSnapshotAttribute.

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ModifyDbClusterSnapshotAttributeRequest.Builder,ModifyDbClusterSnapshotAttributeRequest>
      Specified by:
      toBuilder in class DocDbRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.