OpenZFSCreateRootVolumeConfiguration (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The configuration of an Amazon FSx for OpenZFS root volume.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OpenZFSCreateRootVolumeConfiguration()

Constructors
Constructor and Description
`OpenZFSCreateRootVolumeConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OpenZFSCreateRootVolumeConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCopyTagsToSnapshots()` A Boolean value indicating whether tags for the volume should be copied to snapshots.
`String`	`getDataCompressionType()` Specifies the method used to compress the data on the volume.
`List<OpenZFSNfsExport>`	`getNfsExports()` The configuration object for mounting a file system.
`Boolean`	`getReadOnly()` A Boolean value indicating whether the volume is read-only.
`List<OpenZFSUserOrGroupQuota>`	`getUserAndGroupQuotas()` An object specifying how much storage users or groups can use on the 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)` Specifies the method used to compress the data on the volume.
`void`	`setNfsExports(Collection<OpenZFSNfsExport> nfsExports)` The configuration object for mounting a file system.
`void`	`setReadOnly(Boolean readOnly)` A Boolean value indicating whether the volume is read-only.
`void`	`setUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)` An object specifying how much storage users or groups can use on the volume.
`String`	`toString()` Returns a string representation of this object.
`OpenZFSCreateRootVolumeConfiguration`	`withCopyTagsToSnapshots(Boolean copyTagsToSnapshots)` A Boolean value indicating whether tags for the volume should be copied to snapshots.
`OpenZFSCreateRootVolumeConfiguration`	`withDataCompressionType(OpenZFSDataCompressionType dataCompressionType)` Specifies the method used to compress the data on the volume.
`OpenZFSCreateRootVolumeConfiguration`	`withDataCompressionType(String dataCompressionType)` Specifies the method used to compress the data on the volume.
`OpenZFSCreateRootVolumeConfiguration`	`withNfsExports(Collection<OpenZFSNfsExport> nfsExports)` The configuration object for mounting a file system.
`OpenZFSCreateRootVolumeConfiguration`	`withNfsExports(OpenZFSNfsExport... nfsExports)` The configuration object for mounting a file system.
`OpenZFSCreateRootVolumeConfiguration`	`withReadOnly(Boolean readOnly)` A Boolean value indicating whether the volume is read-only.
`OpenZFSCreateRootVolumeConfiguration`	`withUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)` An object specifying how much storage users or groups can use on the volume.
`OpenZFSCreateRootVolumeConfiguration`	`withUserAndGroupQuotas(OpenZFSUserOrGroupQuota... userAndGroupQuotas)` An object specifying how much storage users or groups can use on the volume.

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

- Constructor Detail
  - OpenZFSCreateRootVolumeConfiguration
```
public OpenZFSCreateRootVolumeConfiguration()
```
- Method Detail
  - setDataCompressionType
```
public void setDataCompressionType(String dataCompressionType)
```
    Specifies the method used to compress the data on the volume. Unless the 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 - Specifies the method used to compress the data on the volume. Unless the 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()
```
    Specifies the method used to compress the data on the volume. Unless the 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:
    Specifies the method used to compress the data on the volume. Unless the 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 OpenZFSCreateRootVolumeConfiguration withDataCompressionType(String dataCompressionType)
```
    Specifies the method used to compress the data on the volume. Unless the 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 - Specifies the method used to compress the data on the volume. Unless the 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 OpenZFSCreateRootVolumeConfiguration withDataCompressionType(OpenZFSDataCompressionType dataCompressionType)
```
    Specifies the method used to compress the data on the volume. Unless the 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 - Specifies the method used to compress the data on the volume. Unless the 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
  - getNfsExports
```
public List<OpenZFSNfsExport> getNfsExports()
```
    The configuration object for mounting a file system.
    
    Returns:
    
    The configuration object for mounting a file system.
  - setNfsExports
```
public void setNfsExports(Collection<OpenZFSNfsExport> nfsExports)
```
    The configuration object for mounting a file system.
    
    Parameters:
    
    nfsExports - The configuration object for mounting a file system.
  - withNfsExports
```
public OpenZFSCreateRootVolumeConfiguration withNfsExports(OpenZFSNfsExport... nfsExports)
```
    The configuration object for mounting a 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 file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNfsExports
```
public OpenZFSCreateRootVolumeConfiguration withNfsExports(Collection<OpenZFSNfsExport> nfsExports)
```
    The configuration object for mounting a file system.
    
    Parameters:
    
    nfsExports - The configuration object for mounting a 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 OpenZFSCreateRootVolumeConfiguration 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 OpenZFSCreateRootVolumeConfiguration 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.
  - 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 OpenZFSCreateRootVolumeConfiguration 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.
  - setReadOnly
```
public void setReadOnly(Boolean readOnly)
```
    A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
    
    Parameters:
    
    readOnly - A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
  - getReadOnly
```
public Boolean getReadOnly()
```
    A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
    
    Returns:
    
    A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
  - withReadOnly
```
public OpenZFSCreateRootVolumeConfiguration withReadOnly(Boolean readOnly)
```
    A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
    
    Parameters:
    
    readOnly - A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
    
    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. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
    
    Returns:
    
    A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
  - 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 OpenZFSCreateRootVolumeConfiguration 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 OpenZFSCreateRootVolumeConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OpenZFSCreateRootVolumeConfiguration

Method Detail

setDataCompressionType

getDataCompressionType

withDataCompressionType

withDataCompressionType

getNfsExports

setNfsExports

withNfsExports

withNfsExports

getUserAndGroupQuotas

setUserAndGroupQuotas

withUserAndGroupQuotas

withUserAndGroupQuotas

setCopyTagsToSnapshots

getCopyTagsToSnapshots

withCopyTagsToSnapshots

isCopyTagsToSnapshots

setReadOnly

getReadOnly

withReadOnly

isReadOnly

toString

equals

hashCode

clone

marshall