Package software.amazon.awssdk.services.fsx.model

Class RestoreVolumeFromSnapshotRequest

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.RestoreVolumeFromSnapshotRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RestoreVolumeFromSnapshotRequest.Builder,RestoreVolumeFromSnapshotRequest>

@Generated("software.amazon.awssdk:codegen")
public final class RestoreVolumeFromSnapshotRequest
extends FSxRequest
implements ToCopyableBuilder<RestoreVolumeFromSnapshotRequest.Builder,RestoreVolumeFromSnapshotRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RestoreVolumeFromSnapshotRequest.Builder

Method Summary

Modifier and Type	Method	Description
static RestoreVolumeFromSnapshotRequest.Builder	builder()
String	clientRequestToken()	Returns the value of the ClientRequestToken property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOptions()	For responses, this returns true if the service returned a value for the Options property.
List<RestoreOpenZFSVolumeOption>	options()	The settings used when restoring the specified volume from snapshot.
List<String>	optionsAsStrings()	The settings used when restoring the specified volume from snapshot.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RestoreVolumeFromSnapshotRequest.Builder>	serializableBuilderClass()
String	snapshotId()	The ID of the source snapshot.
RestoreVolumeFromSnapshotRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	volumeId()	The ID of the volume that you are restoring.

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

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()

The ID of the volume that you are restoring.

Returns:

The ID of the volume that you are restoring.

snapshotId

public final String snapshotId()

The ID of the source snapshot. Specifies the snapshot that you are restoring from.

Returns:

The ID of the source snapshot. Specifies the snapshot that you are restoring from.

options

public final List<RestoreOpenZFSVolumeOption> options()

The settings used when restoring the specified volume from snapshot.

• DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot fails.

• DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.

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:

The settings used when restoring the specified volume from snapshot.

• DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot fails.

• DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.

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()

The settings used when restoring the specified volume from snapshot.

• DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot fails.

• DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.

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:

The settings used when restoring the specified volume from snapshot.

• DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot fails.

• DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.

toBuilder

public RestoreVolumeFromSnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RestoreVolumeFromSnapshotRequest.Builder,RestoreVolumeFromSnapshotRequest>

Specified by:

toBuilder in class FSxRequest

builder

public static RestoreVolumeFromSnapshotRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo