OntapVolumeConfiguration (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OntapVolumeConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The configuration of an Amazon FSx for NetApp ONTAP volume.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OntapVolumeConfiguration()

Constructors
Constructor and Description
`OntapVolumeConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OntapVolumeConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`AggregateConfiguration`	`getAggregateConfiguration()` This structure specifies configuration options for a volume’s storage aggregate or aggregates.
`Boolean`	`getCopyTagsToBackups()` A boolean flag indicating whether tags for the volume should be copied to backups.
`String`	`getFlexCacheEndpointType()` Specifies the FlexCache endpoint type of the volume.
`String`	`getJunctionPath()` Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address.
`String`	`getOntapVolumeType()` Specifies the type of volume.
`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()` The configured size of the volume, in megabytes (MBs).
`SnaplockConfiguration`	`getSnaplockConfiguration()` The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
`String`	`getSnapshotPolicy()` Specifies the snapshot policy for the volume.
`Boolean`	`getStorageEfficiencyEnabled()` The volume's storage efficiency setting.
`String`	`getStorageVirtualMachineId()` The ID of the volume's storage virtual machine.
`Boolean`	`getStorageVirtualMachineRoot()` A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM).
`TieringPolicy`	`getTieringPolicy()` The volume's `TieringPolicy` setting.
`String`	`getUUID()` The volume's universally unique identifier (UUID).
`String`	`getVolumeStyle()` Use to specify the style of an ONTAP volume.
`int`	`hashCode()`
`Boolean`	`isCopyTagsToBackups()` A boolean flag indicating whether tags for the volume should be copied to backups.
`Boolean`	`isStorageEfficiencyEnabled()` The volume's storage efficiency setting.
`Boolean`	`isStorageVirtualMachineRoot()` A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM).
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAggregateConfiguration(AggregateConfiguration aggregateConfiguration)` This structure specifies configuration options for a volume’s storage aggregate or aggregates.
`void`	`setCopyTagsToBackups(Boolean copyTagsToBackups)` A boolean flag indicating whether tags for the volume should be copied to backups.
`void`	`setFlexCacheEndpointType(String flexCacheEndpointType)` Specifies the FlexCache endpoint type of the volume.
`void`	`setJunctionPath(String junctionPath)` Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address.
`void`	`setOntapVolumeType(String ontapVolumeType)` Specifies the type of volume.
`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)` The configured size of the volume, in megabytes (MBs).
`void`	`setSnaplockConfiguration(SnaplockConfiguration snaplockConfiguration)` The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
`void`	`setSnapshotPolicy(String snapshotPolicy)` Specifies the snapshot policy for the volume.
`void`	`setStorageEfficiencyEnabled(Boolean storageEfficiencyEnabled)` The volume's storage efficiency setting.
`void`	`setStorageVirtualMachineId(String storageVirtualMachineId)` The ID of the volume's storage virtual machine.
`void`	`setStorageVirtualMachineRoot(Boolean storageVirtualMachineRoot)` A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM).
`void`	`setTieringPolicy(TieringPolicy tieringPolicy)` The volume's `TieringPolicy` setting.
`void`	`setUUID(String uUID)` The volume's universally unique identifier (UUID).
`void`	`setVolumeStyle(String volumeStyle)` Use to specify the style of an ONTAP volume.
`String`	`toString()` Returns a string representation of this object.
`OntapVolumeConfiguration`	`withAggregateConfiguration(AggregateConfiguration aggregateConfiguration)` This structure specifies configuration options for a volume’s storage aggregate or aggregates.
`OntapVolumeConfiguration`	`withCopyTagsToBackups(Boolean copyTagsToBackups)` A boolean flag indicating whether tags for the volume should be copied to backups.
`OntapVolumeConfiguration`	`withFlexCacheEndpointType(FlexCacheEndpointType flexCacheEndpointType)` Specifies the FlexCache endpoint type of the volume.
`OntapVolumeConfiguration`	`withFlexCacheEndpointType(String flexCacheEndpointType)` Specifies the FlexCache endpoint type of the volume.
`OntapVolumeConfiguration`	`withJunctionPath(String junctionPath)` Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address.
`OntapVolumeConfiguration`	`withOntapVolumeType(OntapVolumeType ontapVolumeType)` Specifies the type of volume.
`OntapVolumeConfiguration`	`withOntapVolumeType(String ontapVolumeType)` Specifies the type of volume.
`OntapVolumeConfiguration`	`withSecurityStyle(SecurityStyle securityStyle)` The security style for the volume, which can be `UNIX`, `NTFS`, or `MIXED`.
`OntapVolumeConfiguration`	`withSecurityStyle(String securityStyle)` The security style for the volume, which can be `UNIX`, `NTFS`, or `MIXED`.
`OntapVolumeConfiguration`	`withSizeInBytes(Long sizeInBytes)` The configured size of the volume, in bytes.
`OntapVolumeConfiguration`	`withSizeInMegabytes(Integer sizeInMegabytes)` The configured size of the volume, in megabytes (MBs).
`OntapVolumeConfiguration`	`withSnaplockConfiguration(SnaplockConfiguration snaplockConfiguration)` The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
`OntapVolumeConfiguration`	`withSnapshotPolicy(String snapshotPolicy)` Specifies the snapshot policy for the volume.
`OntapVolumeConfiguration`	`withStorageEfficiencyEnabled(Boolean storageEfficiencyEnabled)` The volume's storage efficiency setting.
`OntapVolumeConfiguration`	`withStorageVirtualMachineId(String storageVirtualMachineId)` The ID of the volume's storage virtual machine.
`OntapVolumeConfiguration`	`withStorageVirtualMachineRoot(Boolean storageVirtualMachineRoot)` A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM).
`OntapVolumeConfiguration`	`withTieringPolicy(TieringPolicy tieringPolicy)` The volume's `TieringPolicy` setting.
`OntapVolumeConfiguration`	`withUUID(String uUID)` The volume's universally unique identifier (UUID).
`OntapVolumeConfiguration`	`withVolumeStyle(String volumeStyle)` Use to specify the style of an ONTAP volume.
`OntapVolumeConfiguration`	`withVolumeStyle(VolumeStyle volumeStyle)` Use to specify the style of an ONTAP volume.

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

- Constructor Detail
  - OntapVolumeConfiguration
```
public OntapVolumeConfiguration()
```
- Method Detail
  - setFlexCacheEndpointType
```
public void setFlexCacheEndpointType(String flexCacheEndpointType)
```
    Specifies the FlexCache endpoint type of the volume. Valid values are the following:
    - NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
    - ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
    - CACHE specifies that the volume is a FlexCache volume.
    Parameters:
    flexCacheEndpointType - Specifies the FlexCache endpoint type of the volume. Valid values are the following:
    
    NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
    
    ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
    
    CACHE specifies that the volume is a FlexCache volume.
    See Also:
    
    FlexCacheEndpointType
  - getFlexCacheEndpointType
```
public String getFlexCacheEndpointType()
```
    Specifies the FlexCache endpoint type of the volume. Valid values are the following:
    - NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
    - ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
    - CACHE specifies that the volume is a FlexCache volume.
    Returns:
    Specifies the FlexCache endpoint type of the volume. Valid values are the following:
    
    NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
    
    ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
    
    CACHE specifies that the volume is a FlexCache volume.
    See Also:
    
    FlexCacheEndpointType
  - withFlexCacheEndpointType
```
public OntapVolumeConfiguration withFlexCacheEndpointType(String flexCacheEndpointType)
```
    Specifies the FlexCache endpoint type of the volume. Valid values are the following:
    - NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
    - ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
    - CACHE specifies that the volume is a FlexCache volume.
    Parameters:
    flexCacheEndpointType - Specifies the FlexCache endpoint type of the volume. Valid values are the following:
    
    NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
    
    ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
    
    CACHE specifies that the volume is a FlexCache volume.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FlexCacheEndpointType
  - withFlexCacheEndpointType
```
public OntapVolumeConfiguration withFlexCacheEndpointType(FlexCacheEndpointType flexCacheEndpointType)
```
    Specifies the FlexCache endpoint type of the volume. Valid values are the following:
    - NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
    - ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
    - CACHE specifies that the volume is a FlexCache volume.
    Parameters:
    flexCacheEndpointType - Specifies the FlexCache endpoint type of the volume. Valid values are the following:
    
    NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
    
    ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
    
    CACHE specifies that the volume is a FlexCache volume.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FlexCacheEndpointType
  - setJunctionPath
```
public void setJunctionPath(String junctionPath)
```
    Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.
    
    Parameters:
    
    junctionPath - Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.
  - getJunctionPath
```
public String getJunctionPath()
```
    Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.
    
    Returns:
    
    Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.
  - withJunctionPath
```
public OntapVolumeConfiguration withJunctionPath(String junctionPath)
```
    Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.
    
    Parameters:
    
    junctionPath - Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/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 OntapVolumeConfiguration 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 OntapVolumeConfiguration 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)
```
    The configured size of the volume, in megabytes (MBs).
    
    Parameters:
    
    sizeInMegabytes - The configured size of the volume, in megabytes (MBs).
  - getSizeInMegabytes
```
public Integer getSizeInMegabytes()
```
    The configured size of the volume, in megabytes (MBs).
    
    Returns:
    
    The configured size of the volume, in megabytes (MBs).
  - withSizeInMegabytes
```
public OntapVolumeConfiguration withSizeInMegabytes(Integer sizeInMegabytes)
```
    The configured size of the volume, in megabytes (MBs).
    
    Parameters:
    
    sizeInMegabytes - The configured size of the volume, in megabytes (MBs).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageEfficiencyEnabled
```
public void setStorageEfficiencyEnabled(Boolean storageEfficiencyEnabled)
```
    The volume's storage efficiency setting.
    
    Parameters:
    
    storageEfficiencyEnabled - The volume's storage efficiency setting.
  - getStorageEfficiencyEnabled
```
public Boolean getStorageEfficiencyEnabled()
```
    The volume's storage efficiency setting.
    
    Returns:
    
    The volume's storage efficiency setting.
  - withStorageEfficiencyEnabled
```
public OntapVolumeConfiguration withStorageEfficiencyEnabled(Boolean storageEfficiencyEnabled)
```
    The volume's storage efficiency setting.
    
    Parameters:
    
    storageEfficiencyEnabled - The volume's storage efficiency setting.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isStorageEfficiencyEnabled
```
public Boolean isStorageEfficiencyEnabled()
```
    The volume's storage efficiency setting.
    
    Returns:
    
    The volume's storage efficiency setting.
  - setStorageVirtualMachineId
```
public void setStorageVirtualMachineId(String storageVirtualMachineId)
```
    The ID of the volume's storage virtual machine.
    
    Parameters:
    
    storageVirtualMachineId - The ID of the volume's storage virtual machine.
  - getStorageVirtualMachineId
```
public String getStorageVirtualMachineId()
```
    The ID of the volume's storage virtual machine.
    
    Returns:
    
    The ID of the volume's storage virtual machine.
  - withStorageVirtualMachineId
```
public OntapVolumeConfiguration withStorageVirtualMachineId(String storageVirtualMachineId)
```
    The ID of the volume's storage virtual machine.
    
    Parameters:
    
    storageVirtualMachineId - The ID of the volume's storage virtual machine.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageVirtualMachineRoot
```
public void setStorageVirtualMachineRoot(Boolean storageVirtualMachineRoot)
```
    A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
    
    This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
    
    Parameters:
    
    storageVirtualMachineRoot - A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
    
    This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
  - getStorageVirtualMachineRoot
```
public Boolean getStorageVirtualMachineRoot()
```
    A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
    
    This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
    
    Returns:
    
    A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
    
    This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
  - withStorageVirtualMachineRoot
```
public OntapVolumeConfiguration withStorageVirtualMachineRoot(Boolean storageVirtualMachineRoot)
```
    A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
    
    This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
    
    Parameters:
    
    storageVirtualMachineRoot - A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
    
    This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isStorageVirtualMachineRoot
```
public Boolean isStorageVirtualMachineRoot()
```
    A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
    
    This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
    
    Returns:
    
    A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
    
    This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
  - setTieringPolicy
```
public void setTieringPolicy(TieringPolicy tieringPolicy)
```
    The volume's TieringPolicy setting.
    
    Parameters:
    
    tieringPolicy - The volume's TieringPolicy setting.
  - getTieringPolicy
```
public TieringPolicy getTieringPolicy()
```
    The volume's TieringPolicy setting.
    
    Returns:
    
    The volume's TieringPolicy setting.
  - withTieringPolicy
```
public OntapVolumeConfiguration withTieringPolicy(TieringPolicy tieringPolicy)
```
    The volume's TieringPolicy setting.
    
    Parameters:
    
    tieringPolicy - The volume's TieringPolicy setting.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUUID
```
public void setUUID(String uUID)
```
    The volume's universally unique identifier (UUID).
    
    Parameters:
    
    uUID - The volume's universally unique identifier (UUID).
  - getUUID
```
public String getUUID()
```
    The volume's universally unique identifier (UUID).
    
    Returns:
    
    The volume's universally unique identifier (UUID).
  - withUUID
```
public OntapVolumeConfiguration withUUID(String uUID)
```
    The volume's universally unique identifier (UUID).
    
    Parameters:
    
    uUID - The volume's universally unique identifier (UUID).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOntapVolumeType
```
public void setOntapVolumeType(String ontapVolumeType)
```
    Specifies the type of volume. Valid values are the following:
    - RW specifies a read/write volume. RW is the default.
    - DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
    - LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
    Parameters:
    ontapVolumeType - Specifies the type of volume. Valid values are the following:
    
    RW specifies a read/write volume. RW is the default.
    
    DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
    
    LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
    See Also:
    
    OntapVolumeType
  - getOntapVolumeType
```
public String getOntapVolumeType()
```
    Specifies the type of volume. Valid values are the following:
    - RW specifies a read/write volume. RW is the default.
    - DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
    - LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
    Returns:
    Specifies the type of volume. Valid values are the following:
    
    RW specifies a read/write volume. RW is the default.
    
    DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
    
    LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
    See Also:
    
    OntapVolumeType
  - withOntapVolumeType
```
public OntapVolumeConfiguration withOntapVolumeType(String ontapVolumeType)
```
    Specifies the type of volume. Valid values are the following:
    - RW specifies a read/write volume. RW is the default.
    - DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
    - LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
    Parameters:
    ontapVolumeType - Specifies the type of volume. Valid values are the following:
    
    RW specifies a read/write volume. RW is the default.
    
    DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
    
    LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OntapVolumeType
  - withOntapVolumeType
```
public OntapVolumeConfiguration withOntapVolumeType(OntapVolumeType ontapVolumeType)
```
    Specifies the type of volume. Valid values are the following:
    - RW specifies a read/write volume. RW is the default.
    - DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
    - LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
    Parameters:
    ontapVolumeType - Specifies the type of volume. Valid values are the following:
    
    RW specifies a read/write volume. RW is the default.
    
    DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
    
    LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OntapVolumeType
  - 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 OntapVolumeConfiguration 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 OntapVolumeConfiguration 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(SnaplockConfiguration snaplockConfiguration)
```
    The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
    
    Parameters:
    
    snaplockConfiguration - The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
  - getSnaplockConfiguration
```
public SnaplockConfiguration getSnaplockConfiguration()
```
    The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
    
    Returns:
    
    The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
  - withSnaplockConfiguration
```
public OntapVolumeConfiguration withSnaplockConfiguration(SnaplockConfiguration snaplockConfiguration)
```
    The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
    
    Parameters:
    
    snaplockConfiguration - The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeStyle
```
public void setVolumeStyle(String volumeStyle)
```
    Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
    
    Parameters:
    
    volumeStyle - Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
    
    See Also:
    
    VolumeStyle
  - getVolumeStyle
```
public String getVolumeStyle()
```
    Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
    
    Returns:
    
    Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
    
    See Also:
    
    VolumeStyle
  - withVolumeStyle
```
public OntapVolumeConfiguration withVolumeStyle(String volumeStyle)
```
    Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
    
    Parameters:
    
    volumeStyle - Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeStyle
  - withVolumeStyle
```
public OntapVolumeConfiguration withVolumeStyle(VolumeStyle volumeStyle)
```
    Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
    
    Parameters:
    
    volumeStyle - Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeStyle
  - setAggregateConfiguration
```
public void setAggregateConfiguration(AggregateConfiguration aggregateConfiguration)
```
    This structure specifies configuration options for a volume’s storage aggregate or aggregates.
    
    Parameters:
    
    aggregateConfiguration - This structure specifies configuration options for a volume’s storage aggregate or aggregates.
  - getAggregateConfiguration
```
public AggregateConfiguration getAggregateConfiguration()
```
    This structure specifies configuration options for a volume’s storage aggregate or aggregates.
    
    Returns:
    
    This structure specifies configuration options for a volume’s storage aggregate or aggregates.
  - withAggregateConfiguration
```
public OntapVolumeConfiguration withAggregateConfiguration(AggregateConfiguration aggregateConfiguration)
```
    This structure specifies configuration options for a volume’s storage aggregate or aggregates.
    
    Parameters:
    
    aggregateConfiguration - This structure specifies configuration options for a volume’s storage aggregate or aggregates.
    
    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 OntapVolumeConfiguration 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 OntapVolumeConfiguration 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.773

Class OntapVolumeConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OntapVolumeConfiguration

Method Detail

setFlexCacheEndpointType

getFlexCacheEndpointType

withFlexCacheEndpointType

withFlexCacheEndpointType

setJunctionPath

getJunctionPath

withJunctionPath

setSecurityStyle

getSecurityStyle

withSecurityStyle

withSecurityStyle

setSizeInMegabytes

getSizeInMegabytes

withSizeInMegabytes

setStorageEfficiencyEnabled

getStorageEfficiencyEnabled

withStorageEfficiencyEnabled

isStorageEfficiencyEnabled

setStorageVirtualMachineId

getStorageVirtualMachineId

withStorageVirtualMachineId

setStorageVirtualMachineRoot

getStorageVirtualMachineRoot

withStorageVirtualMachineRoot

isStorageVirtualMachineRoot

setTieringPolicy

getTieringPolicy

withTieringPolicy

setUUID

getUUID

withUUID

setOntapVolumeType

getOntapVolumeType

withOntapVolumeType

withOntapVolumeType

setSnapshotPolicy

getSnapshotPolicy

withSnapshotPolicy

setCopyTagsToBackups

getCopyTagsToBackups

withCopyTagsToBackups

isCopyTagsToBackups

setSnaplockConfiguration

getSnaplockConfiguration

withSnaplockConfiguration

setVolumeStyle

getVolumeStyle

withVolumeStyle

withVolumeStyle

setAggregateConfiguration

getAggregateConfiguration

withAggregateConfiguration

setSizeInBytes

getSizeInBytes

withSizeInBytes

toString

equals

hashCode

clone

marshall