UpdateOntapVolumeConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.fsx.model.UpdateOntapVolumeConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateOntapVolumeConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Used to specify changes to the ONTAP configuration for the volume you are updating.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpdateOntapVolumeConfiguration()

Constructors
Constructor and Description
`UpdateOntapVolumeConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateOntapVolumeConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCopyTagsToBackups()` A boolean flag indicating whether tags for the volume should be copied to backups.
`String`	`getJunctionPath()` Specifies the location in the SVM's namespace where the volume is mounted.
`String`	`getSecurityStyle()` The security style for the volume, which can be `UNIX`, `NTFS`, or `MIXED`.
`Long`	`getSizeInBytes()` The configured size of the volume, in bytes.
`Integer`	`getSizeInMegabytes()` Specifies the size of the volume in megabytes.
`UpdateSnaplockConfiguration`	`getSnaplockConfiguration()` The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
`String`	`getSnapshotPolicy()` Specifies the snapshot policy for the volume.
`Boolean`	`getStorageEfficiencyEnabled()` Default is `false`.
`TieringPolicy`	`getTieringPolicy()` Update the volume's data tiering policy.
`int`	`hashCode()`
`Boolean`	`isCopyTagsToBackups()` A boolean flag indicating whether tags for the volume should be copied to backups.
`Boolean`	`isStorageEfficiencyEnabled()` Default is `false`.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCopyTagsToBackups(Boolean copyTagsToBackups)` A boolean flag indicating whether tags for the volume should be copied to backups.
`void`	`setJunctionPath(String junctionPath)` Specifies the location in the SVM's namespace where the volume is mounted.
`void`	`setSecurityStyle(String securityStyle)` The security style for the volume, which can be `UNIX`, `NTFS`, or `MIXED`.
`void`	`setSizeInBytes(Long sizeInBytes)` The configured size of the volume, in bytes.
`void`	`setSizeInMegabytes(Integer sizeInMegabytes)` Specifies the size of the volume in megabytes.
`void`	`setSnaplockConfiguration(UpdateSnaplockConfiguration snaplockConfiguration)` The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
`void`	`setSnapshotPolicy(String snapshotPolicy)` Specifies the snapshot policy for the volume.
`void`	`setStorageEfficiencyEnabled(Boolean storageEfficiencyEnabled)` Default is `false`.
`void`	`setTieringPolicy(TieringPolicy tieringPolicy)` Update the volume's data tiering policy.
`String`	`toString()` Returns a string representation of this object.
`UpdateOntapVolumeConfiguration`	`withCopyTagsToBackups(Boolean copyTagsToBackups)` A boolean flag indicating whether tags for the volume should be copied to backups.
`UpdateOntapVolumeConfiguration`	`withJunctionPath(String junctionPath)` Specifies the location in the SVM's namespace where the volume is mounted.
`UpdateOntapVolumeConfiguration`	`withSecurityStyle(SecurityStyle securityStyle)` The security style for the volume, which can be `UNIX`, `NTFS`, or `MIXED`.
`UpdateOntapVolumeConfiguration`	`withSecurityStyle(String securityStyle)` The security style for the volume, which can be `UNIX`, `NTFS`, or `MIXED`.
`UpdateOntapVolumeConfiguration`	`withSizeInBytes(Long sizeInBytes)` The configured size of the volume, in bytes.
`UpdateOntapVolumeConfiguration`	`withSizeInMegabytes(Integer sizeInMegabytes)` Specifies the size of the volume in megabytes.
`UpdateOntapVolumeConfiguration`	`withSnaplockConfiguration(UpdateSnaplockConfiguration snaplockConfiguration)` The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
`UpdateOntapVolumeConfiguration`	`withSnapshotPolicy(String snapshotPolicy)` Specifies the snapshot policy for the volume.
`UpdateOntapVolumeConfiguration`	`withStorageEfficiencyEnabled(Boolean storageEfficiencyEnabled)` Default is `false`.
`UpdateOntapVolumeConfiguration`	`withTieringPolicy(TieringPolicy tieringPolicy)` Update the volume's data tiering policy.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateOntapVolumeConfiguration
```
public UpdateOntapVolumeConfiguration()
```
- Method Detail
  - setJunctionPath
```
public void setJunctionPath(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.
    
    Parameters:
    
    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.
  - getJunctionPath
```
public String getJunctionPath()
```
    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.
  - withJunctionPath
```
public UpdateOntapVolumeConfiguration withJunctionPath(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecurityStyle
```
public void setSecurityStyle(String securityStyle)
```
    The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
    Parameters:
    
    securityStyle - The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
    See Also:
    
    SecurityStyle
  - getSecurityStyle
```
public String getSecurityStyle()
```
    The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
    Returns:
    
    The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
    See Also:
    
    SecurityStyle
  - withSecurityStyle
```
public UpdateOntapVolumeConfiguration withSecurityStyle(String securityStyle)
```
    The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
    Parameters:
    
    securityStyle - The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityStyle
  - withSecurityStyle
```
public UpdateOntapVolumeConfiguration withSecurityStyle(SecurityStyle securityStyle)
```
    The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
    Parameters:
    
    securityStyle - The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityStyle
  - setSizeInMegabytes
```
public void setSizeInMegabytes(Integer sizeInMegabytes)
```
    Specifies the size of the volume in megabytes.
    
    Parameters:
    
    sizeInMegabytes - Specifies the size of the volume in megabytes.
  - getSizeInMegabytes
```
public Integer getSizeInMegabytes()
```
    Specifies the size of the volume in megabytes.
    
    Returns:
    
    Specifies the size of the volume in megabytes.
  - withSizeInMegabytes
```
public UpdateOntapVolumeConfiguration withSizeInMegabytes(Integer sizeInMegabytes)
```
    Specifies the size of the volume in megabytes.
    
    Parameters:
    
    sizeInMegabytes - Specifies the size of the volume in megabytes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageEfficiencyEnabled
```
public void setStorageEfficiencyEnabled(Boolean storageEfficiencyEnabled)
```
    Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
    
    Parameters:
    
    storageEfficiencyEnabled - Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
  - getStorageEfficiencyEnabled
```
public Boolean getStorageEfficiencyEnabled()
```
    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.
  - withStorageEfficiencyEnabled
```
public UpdateOntapVolumeConfiguration withStorageEfficiencyEnabled(Boolean storageEfficiencyEnabled)
```
    Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
    
    Parameters:
    
    storageEfficiencyEnabled - Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isStorageEfficiencyEnabled
```
public Boolean isStorageEfficiencyEnabled()
```
    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.
  - setTieringPolicy
```
public void setTieringPolicy(TieringPolicy tieringPolicy)
```
    Update the volume's data tiering policy.
    
    Parameters:
    
    tieringPolicy - Update the volume's data tiering policy.
  - getTieringPolicy
```
public TieringPolicy getTieringPolicy()
```
    Update the volume's data tiering policy.
    
    Returns:
    
    Update the volume's data tiering policy.
  - withTieringPolicy
```
public UpdateOntapVolumeConfiguration withTieringPolicy(TieringPolicy tieringPolicy)
```
    Update the volume's data tiering policy.
    
    Parameters:
    
    tieringPolicy - Update the volume's data tiering policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnapshotPolicy
```
public void setSnapshotPolicy(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.
    Parameters:
    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.
  - getSnapshotPolicy
```
public String getSnapshotPolicy()
```
    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.
  - withSnapshotPolicy
```
public UpdateOntapVolumeConfiguration withSnapshotPolicy(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCopyTagsToBackups
```
public void setCopyTagsToBackups(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.
    
    Parameters:
    
    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.
  - getCopyTagsToBackups
```
public Boolean getCopyTagsToBackups()
```
    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.
  - withCopyTagsToBackups
```
public UpdateOntapVolumeConfiguration withCopyTagsToBackups(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCopyTagsToBackups
```
public Boolean isCopyTagsToBackups()
```
    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.
  - setSnaplockConfiguration
```
public void setSnaplockConfiguration(UpdateSnaplockConfiguration snaplockConfiguration)
```
    The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
    
    Parameters:
    
    snaplockConfiguration - The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
  - getSnaplockConfiguration
```
public UpdateSnaplockConfiguration getSnaplockConfiguration()
```
    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.
  - withSnaplockConfiguration
```
public UpdateOntapVolumeConfiguration withSnaplockConfiguration(UpdateSnaplockConfiguration snaplockConfiguration)
```
    The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
    
    Parameters:
    
    snaplockConfiguration - The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSizeInBytes
```
public void setSizeInBytes(Long sizeInBytes)
```
    The configured size of the volume, in bytes.
    
    Parameters:
    
    sizeInBytes - The configured size of the volume, in bytes.
  - getSizeInBytes
```
public Long getSizeInBytes()
```
    The configured size of the volume, in bytes.
    
    Returns:
    
    The configured size of the volume, in bytes.
  - withSizeInBytes
```
public UpdateOntapVolumeConfiguration withSizeInBytes(Long sizeInBytes)
```
    The configured size of the volume, in bytes.
    
    Parameters:
    
    sizeInBytes - The configured size of the volume, in bytes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UpdateOntapVolumeConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class UpdateOntapVolumeConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UpdateOntapVolumeConfiguration

Method Detail

setJunctionPath

getJunctionPath

withJunctionPath

setSecurityStyle

getSecurityStyle

withSecurityStyle

withSecurityStyle

setSizeInMegabytes

getSizeInMegabytes

withSizeInMegabytes

setStorageEfficiencyEnabled

getStorageEfficiencyEnabled

withStorageEfficiencyEnabled

isStorageEfficiencyEnabled

setTieringPolicy

getTieringPolicy

withTieringPolicy

setSnapshotPolicy

getSnapshotPolicy

withSnapshotPolicy

setCopyTagsToBackups

getCopyTagsToBackups

withCopyTagsToBackups

isCopyTagsToBackups

setSnaplockConfiguration

getSnaplockConfiguration

withSnaplockConfiguration

setSizeInBytes

getSizeInBytes

withSizeInBytes

toString

equals

hashCode

clone

marshall