java.lang.Object
- software.amazon.awssdk.services.fsx.model.UpdateOntapVolumeConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UpdateOntapVolumeConfiguration.Builder,UpdateOntapVolumeConfiguration>
```
@Generated("software.amazon.awssdk:codegen")
public final class UpdateOntapVolumeConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UpdateOntapVolumeConfiguration.Builder,UpdateOntapVolumeConfiguration>
```
Used to specify changes to the ONTAP configuration for the volume you are updating.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateOntapVolumeConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static UpdateOntapVolumeConfiguration.Builder`	`builder()`
`Boolean`	`copyTagsToBackups()`	A boolean flag indicating whether tags for the volume should be copied to backups.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`junctionPath()`	Specifies the location in the SVM's namespace where the volume is mounted.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`SecurityStyle`	`securityStyle()`	The security style for the volume, which can be `UNIX`, `NTFS`, or `MIXED`.
`String`	`securityStyleAsString()`	The security style for the volume, which can be `UNIX`, `NTFS`, or `MIXED`.
`static Class<? extends UpdateOntapVolumeConfiguration.Builder>`	`serializableBuilderClass()`
`Long`	`sizeInBytes()`	The configured size of the volume, in bytes.
`Integer`	`sizeInMegabytes()`	Specifies the size of the volume in megabytes.
`UpdateSnaplockConfiguration`	`snaplockConfiguration()`	The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
`String`	`snapshotPolicy()`	Specifies the snapshot policy for the volume.
`Boolean`	`storageEfficiencyEnabled()`	Default is `false`.
`TieringPolicy`	`tieringPolicy()`	Update the volume's data tiering policy.
`UpdateOntapVolumeConfiguration.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
  - junctionPath
```
public final String junctionPath()
```
    Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.
    
    Returns:
    
    Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.
  - securityStyle
```
public final SecurityStyle securityStyle()
```
    The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
    If the service returns an enum value that is not available in the current SDK version, securityStyle will return SecurityStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityStyleAsString().
    
    Returns:
    
    The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
    See Also:
    
    SecurityStyle
  - securityStyleAsString
```
public final String securityStyleAsString()
```
    The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
    If the service returns an enum value that is not available in the current SDK version, securityStyle will return SecurityStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityStyleAsString().
    
    Returns:
    
    The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
    See Also:
    
    SecurityStyle
  - sizeInMegabytes
```
public final Integer sizeInMegabytes()
```
    Specifies the size of the volume in megabytes.
    
    Returns:
    
    Specifies the size of the volume in megabytes.
  - storageEfficiencyEnabled
```
public final Boolean storageEfficiencyEnabled()
```
    Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
    
    Returns:
    
    Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
  - tieringPolicy
```
public final TieringPolicy tieringPolicy()
```
    Update the volume's data tiering policy.
    
    Returns:
    
    Update the volume's data tiering policy.
  - snapshotPolicy
```
public final String snapshotPolicy()
```
    Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
    
    default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
    
    default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
    
    none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
    
    You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
    
    For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
    Returns:
    
    Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
    
    default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
    
    default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
    
    none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
    
    You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
    
    For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
  - copyTagsToBackups
```
public final Boolean copyTagsToBackups()
```
    A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
    
    Returns:
    
    A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
  - snaplockConfiguration
```
public final UpdateSnaplockConfiguration snaplockConfiguration()
```
    The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
    
    Returns:
    
    The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
  - sizeInBytes
```
public final Long sizeInBytes()
```
    The configured size of the volume, in bytes.
    
    Returns:
    
    The configured size of the volume, in bytes.
  - toBuilder
```
public UpdateOntapVolumeConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateOntapVolumeConfiguration.Builder,UpdateOntapVolumeConfiguration>
  - builder
```
public static UpdateOntapVolumeConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateOntapVolumeConfiguration.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

Class UpdateOntapVolumeConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

junctionPath

securityStyle

securityStyleAsString

sizeInMegabytes

storageEfficiencyEnabled

tieringPolicy

snapshotPolicy

copyTagsToBackups

snaplockConfiguration

sizeInBytes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField