Class CopySnapshotAndUpdateVolumeRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.fsx.model.FSxRequest
software.amazon.awssdk.services.fsx.model.CopySnapshotAndUpdateVolumeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CopySnapshotAndUpdateVolumeRequest.Builder,CopySnapshotAndUpdateVolumeRequest>
@Generated("software.amazon.awssdk:codegen") public final class CopySnapshotAndUpdateVolumeRequest extends FSxRequest implements ToCopyableBuilder<CopySnapshotAndUpdateVolumeRequest.Builder,CopySnapshotAndUpdateVolumeRequest>

  • Method Details

    • clientRequestToken

      public final String clientRequestToken()
      Returns the value of the ClientRequestToken property for this object.
      Returns:
      The value of the ClientRequestToken property for this object.

    • volumeId

      public final String volumeId()

      Specifies the ID of the volume that you are copying the snapshot to.

      Returns:
      Specifies the ID of the volume that you are copying the snapshot to.

    • sourceSnapshotARN

      public final String sourceSnapshotARN()
      Returns the value of the SourceSnapshotARN property for this object.
      Returns:
      The value of the SourceSnapshotARN property for this object.

    • copyStrategy

      public final OpenZFSCopyStrategy copyStrategy()

      Specifies the strategy to use when copying data from a snapshot to the volume.

      • FULL_COPY - Copies all data from the snapshot to the volume.

      • INCREMENTAL_COPY - Copies only the snapshot data that's changed since the previous replication.

      CLONE isn't a valid copy strategy option for the CopySnapshotAndUpdateVolume operation.

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

      Returns:
      Specifies the strategy to use when copying data from a snapshot to the volume.

      • FULL_COPY - Copies all data from the snapshot to the volume.

      • INCREMENTAL_COPY - Copies only the snapshot data that's changed since the previous replication.

      CLONE isn't a valid copy strategy option for the CopySnapshotAndUpdateVolume operation.

      See Also:

    • copyStrategyAsString

      public final String copyStrategyAsString()

      Specifies the strategy to use when copying data from a snapshot to the volume.

      • FULL_COPY - Copies all data from the snapshot to the volume.

      • INCREMENTAL_COPY - Copies only the snapshot data that's changed since the previous replication.

      CLONE isn't a valid copy strategy option for the CopySnapshotAndUpdateVolume operation.

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

      Returns:
      Specifies the strategy to use when copying data from a snapshot to the volume.

      • FULL_COPY - Copies all data from the snapshot to the volume.

      • INCREMENTAL_COPY - Copies only the snapshot data that's changed since the previous replication.

      CLONE isn't a valid copy strategy option for the CopySnapshotAndUpdateVolume operation.

      See Also:

    • options

      public final List<UpdateOpenZFSVolumeOption> options()

      Confirms that you want to delete data on the destination volume that wasn’t there during the previous snapshot replication.

      Your replication will fail if you don’t include an option for a specific type of data and that data is on your destination. For example, if you don’t include DELETE_INTERMEDIATE_SNAPSHOTS and there are intermediate snapshots on the destination, you can’t copy the snapshot.

      • DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots on the destination volume that aren’t on the source volume.

      • DELETE_CLONED_VOLUMES - Deletes snapshot clones on the destination volume that aren't on the source volume.

      • DELETE_INTERMEDIATE_DATA - Overwrites snapshots on the destination volume that don’t match the source snapshot that you’re copying.

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

      Returns:
      Confirms that you want to delete data on the destination volume that wasn’t there during the previous snapshot replication.

      Your replication will fail if you don’t include an option for a specific type of data and that data is on your destination. For example, if you don’t include DELETE_INTERMEDIATE_SNAPSHOTS and there are intermediate snapshots on the destination, you can’t copy the snapshot.

      • DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots on the destination volume that aren’t on the source volume.

      • DELETE_CLONED_VOLUMES - Deletes snapshot clones on the destination volume that aren't on the source volume.

      • DELETE_INTERMEDIATE_DATA - Overwrites snapshots on the destination volume that don’t match the source snapshot that you’re copying.

    • hasOptions

      public final boolean hasOptions()
      For responses, this returns true if the service returned a value for the Options 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.

    • optionsAsStrings

      public final List<String> optionsAsStrings()

      Confirms that you want to delete data on the destination volume that wasn’t there during the previous snapshot replication.

      Your replication will fail if you don’t include an option for a specific type of data and that data is on your destination. For example, if you don’t include DELETE_INTERMEDIATE_SNAPSHOTS and there are intermediate snapshots on the destination, you can’t copy the snapshot.

      • DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots on the destination volume that aren’t on the source volume.

      • DELETE_CLONED_VOLUMES - Deletes snapshot clones on the destination volume that aren't on the source volume.

      • DELETE_INTERMEDIATE_DATA - Overwrites snapshots on the destination volume that don’t match the source snapshot that you’re copying.

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

      Returns:
      Confirms that you want to delete data on the destination volume that wasn’t there during the previous snapshot replication.

      Your replication will fail if you don’t include an option for a specific type of data and that data is on your destination. For example, if you don’t include DELETE_INTERMEDIATE_SNAPSHOTS and there are intermediate snapshots on the destination, you can’t copy the snapshot.

      • DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots on the destination volume that aren’t on the source volume.

      • DELETE_CLONED_VOLUMES - Deletes snapshot clones on the destination volume that aren't on the source volume.

      • DELETE_INTERMEDIATE_DATA - Overwrites snapshots on the destination volume that don’t match the source snapshot that you’re copying.

    • toBuilder

      public CopySnapshotAndUpdateVolumeRequest.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<CopySnapshotAndUpdateVolumeRequest.Builder,CopySnapshotAndUpdateVolumeRequest>
      Specified by:
      toBuilder in class FSxRequest
      Returns:
      a builder for type T

    • builder

      public static CopySnapshotAndUpdateVolumeRequest.Builder builder()

    • serializableBuilderClass

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