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

Class DeleteVolumeOntapConfiguration

java.lang.Object

software.amazon.awssdk.services.fsx.model.DeleteVolumeOntapConfiguration

All Implemented Interfaces:

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

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

Use to specify skipping a final backup, adding tags to a final backup, or bypassing the retention period of an FSx for ONTAP SnapLock Enterprise volume when deleting an FSx for ONTAP volume.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteVolumeOntapConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static DeleteVolumeOntapConfiguration.Builder	builder()
Boolean	bypassSnaplockEnterpriseRetention()	Setting this to true allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume with unexpired write once, read many (WORM) files.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Tag>	finalBackupTags()	Returns the value of the FinalBackupTags property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFinalBackupTags()	For responses, this returns true if the service returned a value for the FinalBackupTags property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteVolumeOntapConfiguration.Builder>	serializableBuilderClass()
Boolean	skipFinalBackup()	Set to true if you want to skip taking a final backup of the volume you are deleting.
DeleteVolumeOntapConfiguration.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

skipFinalBackup

public final Boolean skipFinalBackup()

Set to true if you want to skip taking a final backup of the volume you are deleting.

Returns:

Set to true if you want to skip taking a final backup of the volume you are deleting.

hasFinalBackupTags

public final boolean hasFinalBackupTags()

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

finalBackupTags

public final List<Tag> finalBackupTags()

Returns the value of the FinalBackupTags property for this object.

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

Returns:

The value of the FinalBackupTags property for this object.

bypassSnaplockEnterpriseRetention

public final Boolean bypassSnaplockEnterpriseRetention()

Setting this to true allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume with unexpired write once, read many (WORM) files. The IAM permission fsx:BypassSnaplockEnterpriseRetention is also required to delete SnapLock Enterprise volumes with unexpired WORM files. The default value is false.

For more information, see Deleting a SnapLock volume.

Returns:

Setting this to true allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume with unexpired write once, read many (WORM) files. The IAM permission fsx:BypassSnaplockEnterpriseRetention is also required to delete SnapLock Enterprise volumes with unexpired WORM files. The default value is false.

For more information, see Deleting a SnapLock volume.

toBuilder

public DeleteVolumeOntapConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteVolumeOntapConfiguration.Builder,DeleteVolumeOntapConfiguration>

builder

public static DeleteVolumeOntapConfiguration.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo