OpenZFSVolumeConfiguration (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OpenZFSVolumeConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

The configuration of an Amazon FSx for OpenZFS volume.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OpenZFSVolumeConfiguration()

Constructors
Constructor and Description
`OpenZFSVolumeConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OpenZFSVolumeConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCopyTagsToSnapshots()` A Boolean value indicating whether tags for the volume should be copied to snapshots.
`String`	`getDataCompressionType()` The method used to compress the data on the volume.
`List<OpenZFSNfsExport>`	`getNfsExports()` The configuration object for mounting a Network File System (NFS) file system.
`OpenZFSOriginSnapshotConfiguration`	`getOriginSnapshot()` The configuration object that specifies the snapshot to use as the origin of the data for the volume.
`String`	`getParentVolumeId()` The ID of the parent volume.
`Boolean`	`getReadOnly()` A Boolean value indicating whether the volume is read-only.
`Integer`	`getStorageCapacityQuotaGiB()` The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent.
`Integer`	`getStorageCapacityReservationGiB()` The amount of storage in gibibytes (GiB) to reserve from the parent volume.
`List<OpenZFSUserOrGroupQuota>`	`getUserAndGroupQuotas()` An object specifying how much storage users or groups can use on the volume.
`String`	`getVolumePath()` The path to the volume from the root volume.
`int`	`hashCode()`
`Boolean`	`isCopyTagsToSnapshots()` A Boolean value indicating whether tags for the volume should be copied to snapshots.
`Boolean`	`isReadOnly()` A Boolean value indicating whether the volume is read-only.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCopyTagsToSnapshots(Boolean copyTagsToSnapshots)` A Boolean value indicating whether tags for the volume should be copied to snapshots.
`void`	`setDataCompressionType(String dataCompressionType)` The method used to compress the data on the volume.
`void`	`setNfsExports(Collection<OpenZFSNfsExport> nfsExports)` The configuration object for mounting a Network File System (NFS) file system.
`void`	`setOriginSnapshot(OpenZFSOriginSnapshotConfiguration originSnapshot)` The configuration object that specifies the snapshot to use as the origin of the data for the volume.
`void`	`setParentVolumeId(String parentVolumeId)` The ID of the parent volume.
`void`	`setReadOnly(Boolean readOnly)` A Boolean value indicating whether the volume is read-only.
`void`	`setStorageCapacityQuotaGiB(Integer storageCapacityQuotaGiB)` The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent.
`void`	`setStorageCapacityReservationGiB(Integer storageCapacityReservationGiB)` The amount of storage in gibibytes (GiB) to reserve from the parent volume.
`void`	`setUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)` An object specifying how much storage users or groups can use on the volume.
`void`	`setVolumePath(String volumePath)` The path to the volume from the root volume.
`String`	`toString()` Returns a string representation of this object.
`OpenZFSVolumeConfiguration`	`withCopyTagsToSnapshots(Boolean copyTagsToSnapshots)` A Boolean value indicating whether tags for the volume should be copied to snapshots.
`OpenZFSVolumeConfiguration`	`withDataCompressionType(OpenZFSDataCompressionType dataCompressionType)` The method used to compress the data on the volume.
`OpenZFSVolumeConfiguration`	`withDataCompressionType(String dataCompressionType)` The method used to compress the data on the volume.
`OpenZFSVolumeConfiguration`	`withNfsExports(Collection<OpenZFSNfsExport> nfsExports)` The configuration object for mounting a Network File System (NFS) file system.
`OpenZFSVolumeConfiguration`	`withNfsExports(OpenZFSNfsExport... nfsExports)` The configuration object for mounting a Network File System (NFS) file system.
`OpenZFSVolumeConfiguration`	`withOriginSnapshot(OpenZFSOriginSnapshotConfiguration originSnapshot)` The configuration object that specifies the snapshot to use as the origin of the data for the volume.
`OpenZFSVolumeConfiguration`	`withParentVolumeId(String parentVolumeId)` The ID of the parent volume.
`OpenZFSVolumeConfiguration`	`withReadOnly(Boolean readOnly)` A Boolean value indicating whether the volume is read-only.
`OpenZFSVolumeConfiguration`	`withStorageCapacityQuotaGiB(Integer storageCapacityQuotaGiB)` The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent.
`OpenZFSVolumeConfiguration`	`withStorageCapacityReservationGiB(Integer storageCapacityReservationGiB)` The amount of storage in gibibytes (GiB) to reserve from the parent volume.
`OpenZFSVolumeConfiguration`	`withUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)` An object specifying how much storage users or groups can use on the volume.
`OpenZFSVolumeConfiguration`	`withUserAndGroupQuotas(OpenZFSUserOrGroupQuota... userAndGroupQuotas)` An object specifying how much storage users or groups can use on the volume.
`OpenZFSVolumeConfiguration`	`withVolumePath(String volumePath)` The path to the volume from the root volume.

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

- Constructor Detail
  - OpenZFSVolumeConfiguration
```
public OpenZFSVolumeConfiguration()
```
- Method Detail
  - setParentVolumeId
```
public void setParentVolumeId(String parentVolumeId)
```
    The ID of the parent volume.
    
    Parameters:
    
    parentVolumeId - The ID of the parent volume.
  - getParentVolumeId
```
public String getParentVolumeId()
```
    The ID of the parent volume.
    
    Returns:
    
    The ID of the parent volume.
  - withParentVolumeId
```
public OpenZFSVolumeConfiguration withParentVolumeId(String parentVolumeId)
```
    The ID of the parent volume.
    
    Parameters:
    
    parentVolumeId - The ID of the parent volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumePath
```
public void setVolumePath(String volumePath)
```
    The path to the volume from the root volume. For example, fsx/parentVolume/volume1.
    
    Parameters:
    
    volumePath - The path to the volume from the root volume. For example, fsx/parentVolume/volume1.
  - getVolumePath
```
public String getVolumePath()
```
    The path to the volume from the root volume. For example, fsx/parentVolume/volume1.
    
    Returns:
    
    The path to the volume from the root volume. For example, fsx/parentVolume/volume1.
  - withVolumePath
```
public OpenZFSVolumeConfiguration withVolumePath(String volumePath)
```
    The path to the volume from the root volume. For example, fsx/parentVolume/volume1.
    
    Parameters:
    
    volumePath - The path to the volume from the root volume. For example, fsx/parentVolume/volume1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageCapacityReservationGiB
```
public void setStorageCapacityReservationGiB(Integer storageCapacityReservationGiB)
```
    The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
    
    Parameters:
    
    storageCapacityReservationGiB - The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
  - getStorageCapacityReservationGiB
```
public Integer getStorageCapacityReservationGiB()
```
    The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
    
    Returns:
    
    The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
  - withStorageCapacityReservationGiB
```
public OpenZFSVolumeConfiguration withStorageCapacityReservationGiB(Integer storageCapacityReservationGiB)
```
    The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
    
    Parameters:
    
    storageCapacityReservationGiB - The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageCapacityQuotaGiB
```
public void setStorageCapacityQuotaGiB(Integer storageCapacityQuotaGiB)
```
    The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
    
    Parameters:
    
    storageCapacityQuotaGiB - The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
  - getStorageCapacityQuotaGiB
```
public Integer getStorageCapacityQuotaGiB()
```
    The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
    
    Returns:
    
    The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
  - withStorageCapacityQuotaGiB
```
public OpenZFSVolumeConfiguration withStorageCapacityQuotaGiB(Integer storageCapacityQuotaGiB)
```
    The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
    
    Parameters:
    
    storageCapacityQuotaGiB - The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataCompressionType
```
public void setDataCompressionType(String dataCompressionType)
```
    The method used to compress the data on the volume. Unless a compression type is specified, volumes inherit the DataCompressionType value of their parent volume.
    - NONE - Doesn't compress the data on the volume.
    - ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.
    Parameters:
    dataCompressionType - The method used to compress the data on the volume. Unless a compression type is specified, volumes inherit the DataCompressionType value of their parent volume.
    
    NONE - Doesn't compress the data on the volume.
    
    ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.
    See Also:
    
    OpenZFSDataCompressionType
  - getDataCompressionType
```
public String getDataCompressionType()
```
    The method used to compress the data on the volume. Unless a compression type is specified, volumes inherit the DataCompressionType value of their parent volume.
    - NONE - Doesn't compress the data on the volume.
    - ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.
    Returns:
    The method used to compress the data on the volume. Unless a compression type is specified, volumes inherit the DataCompressionType value of their parent volume.
    
    NONE - Doesn't compress the data on the volume.
    
    ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.
    See Also:
    
    OpenZFSDataCompressionType
  - withDataCompressionType
```
public OpenZFSVolumeConfiguration withDataCompressionType(String dataCompressionType)
```
    The method used to compress the data on the volume. Unless a compression type is specified, volumes inherit the DataCompressionType value of their parent volume.
    - NONE - Doesn't compress the data on the volume.
    - ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.
    Parameters:
    dataCompressionType - The method used to compress the data on the volume. Unless a compression type is specified, volumes inherit the DataCompressionType value of their parent volume.
    
    NONE - Doesn't compress the data on the volume.
    
    ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OpenZFSDataCompressionType
  - withDataCompressionType
```
public OpenZFSVolumeConfiguration withDataCompressionType(OpenZFSDataCompressionType dataCompressionType)
```
    The method used to compress the data on the volume. Unless a compression type is specified, volumes inherit the DataCompressionType value of their parent volume.
    - NONE - Doesn't compress the data on the volume.
    - ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.
    Parameters:
    dataCompressionType - The method used to compress the data on the volume. Unless a compression type is specified, volumes inherit the DataCompressionType value of their parent volume.
    
    NONE - Doesn't compress the data on the volume.
    
    ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OpenZFSDataCompressionType
  - setCopyTagsToSnapshots
```
public void setCopyTagsToSnapshots(Boolean copyTagsToSnapshots)
```
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
    
    Parameters:
    
    copyTagsToSnapshots - A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
  - getCopyTagsToSnapshots
```
public Boolean getCopyTagsToSnapshots()
```
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
    
    Returns:
    
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
  - withCopyTagsToSnapshots
```
public OpenZFSVolumeConfiguration withCopyTagsToSnapshots(Boolean copyTagsToSnapshots)
```
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
    
    Parameters:
    
    copyTagsToSnapshots - A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, 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.
  - isCopyTagsToSnapshots
```
public Boolean isCopyTagsToSnapshots()
```
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
    
    Returns:
    
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
  - setOriginSnapshot
```
public void setOriginSnapshot(OpenZFSOriginSnapshotConfiguration originSnapshot)
```
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    
    Parameters:
    
    originSnapshot - The configuration object that specifies the snapshot to use as the origin of the data for the volume.
  - getOriginSnapshot
```
public OpenZFSOriginSnapshotConfiguration getOriginSnapshot()
```
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    
    Returns:
    
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
  - withOriginSnapshot
```
public OpenZFSVolumeConfiguration withOriginSnapshot(OpenZFSOriginSnapshotConfiguration originSnapshot)
```
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    
    Parameters:
    
    originSnapshot - The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReadOnly
```
public void setReadOnly(Boolean readOnly)
```
    A Boolean value indicating whether the volume is read-only.
    
    Parameters:
    
    readOnly - A Boolean value indicating whether the volume is read-only.
  - getReadOnly
```
public Boolean getReadOnly()
```
    A Boolean value indicating whether the volume is read-only.
    
    Returns:
    
    A Boolean value indicating whether the volume is read-only.
  - withReadOnly
```
public OpenZFSVolumeConfiguration withReadOnly(Boolean readOnly)
```
    A Boolean value indicating whether the volume is read-only.
    
    Parameters:
    
    readOnly - A Boolean value indicating whether the volume is read-only.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReadOnly
```
public Boolean isReadOnly()
```
    A Boolean value indicating whether the volume is read-only.
    
    Returns:
    
    A Boolean value indicating whether the volume is read-only.
  - getNfsExports
```
public List<OpenZFSNfsExport> getNfsExports()
```
    The configuration object for mounting a Network File System (NFS) file system.
    
    Returns:
    
    The configuration object for mounting a Network File System (NFS) file system.
  - setNfsExports
```
public void setNfsExports(Collection<OpenZFSNfsExport> nfsExports)
```
    The configuration object for mounting a Network File System (NFS) file system.
    
    Parameters:
    
    nfsExports - The configuration object for mounting a Network File System (NFS) file system.
  - withNfsExports
```
public OpenZFSVolumeConfiguration withNfsExports(OpenZFSNfsExport... nfsExports)
```
    The configuration object for mounting a Network File System (NFS) file system.
    
    NOTE: This method appends the values to the existing list (if any). Use setNfsExports(java.util.Collection) or withNfsExports(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    nfsExports - The configuration object for mounting a Network File System (NFS) file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNfsExports
```
public OpenZFSVolumeConfiguration withNfsExports(Collection<OpenZFSNfsExport> nfsExports)
```
    The configuration object for mounting a Network File System (NFS) file system.
    
    Parameters:
    
    nfsExports - The configuration object for mounting a Network File System (NFS) file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserAndGroupQuotas
```
public List<OpenZFSUserOrGroupQuota> getUserAndGroupQuotas()
```
    An object specifying how much storage users or groups can use on the volume.
    
    Returns:
    
    An object specifying how much storage users or groups can use on the volume.
  - setUserAndGroupQuotas
```
public void setUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)
```
    An object specifying how much storage users or groups can use on the volume.
    
    Parameters:
    
    userAndGroupQuotas - An object specifying how much storage users or groups can use on the volume.
  - withUserAndGroupQuotas
```
public OpenZFSVolumeConfiguration withUserAndGroupQuotas(OpenZFSUserOrGroupQuota... userAndGroupQuotas)
```
    An object specifying how much storage users or groups can use on the volume.
    
    NOTE: This method appends the values to the existing list (if any). Use setUserAndGroupQuotas(java.util.Collection) or withUserAndGroupQuotas(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    userAndGroupQuotas - An object specifying how much storage users or groups can use on the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUserAndGroupQuotas
```
public OpenZFSVolumeConfiguration withUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)
```
    An object specifying how much storage users or groups can use on the volume.
    
    Parameters:
    
    userAndGroupQuotas - An object specifying how much storage users or groups can use on the volume.
    
    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 OpenZFSVolumeConfiguration 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.

Did this page help you?

Class OpenZFSVolumeConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OpenZFSVolumeConfiguration

Method Detail

setParentVolumeId

getParentVolumeId

withParentVolumeId

setVolumePath

getVolumePath

withVolumePath

setStorageCapacityReservationGiB

getStorageCapacityReservationGiB

withStorageCapacityReservationGiB

setStorageCapacityQuotaGiB

getStorageCapacityQuotaGiB

withStorageCapacityQuotaGiB

setDataCompressionType

getDataCompressionType

withDataCompressionType

withDataCompressionType

setCopyTagsToSnapshots

getCopyTagsToSnapshots

withCopyTagsToSnapshots

isCopyTagsToSnapshots

setOriginSnapshot

getOriginSnapshot

withOriginSnapshot

setReadOnly

getReadOnly

withReadOnly

isReadOnly

getNfsExports

setNfsExports

withNfsExports

withNfsExports

getUserAndGroupQuotas

setUserAndGroupQuotas

withUserAndGroupQuotas

withUserAndGroupQuotas

toString

equals

hashCode

clone

marshall