software.amazon.awssdk.services.fsx.model

Class UpdateOpenZFSVolumeConfiguration

java.lang.Object

software.amazon.awssdk.services.fsx.model.UpdateOpenZFSVolumeConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UpdateOpenZFSVolumeConfiguration.Builder,UpdateOpenZFSVolumeConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateOpenZFSVolumeConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UpdateOpenZFSVolumeConfiguration.Builder,UpdateOpenZFSVolumeConfiguration>

Used to specify changes to the OpenZFS configuration for the volume that you are updating.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateOpenZFSVolumeConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateOpenZFSVolumeConfiguration.Builder	builder()
OpenZFSDataCompressionType	dataCompressionType() Specifies the method used to compress the data on the volume.
String	dataCompressionTypeAsString() Specifies the method used to compress the data on the volume.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNfsExports() For responses, this returns true if the service returned a value for the NfsExports property.
boolean	hasUserAndGroupQuotas() For responses, this returns true if the service returned a value for the UserAndGroupQuotas property.
List<OpenZFSNfsExport>	nfsExports() The configuration object for mounting a Network File System (NFS) file system.
Boolean	readOnly() A Boolean value indicating whether the volume is read-only.
Integer	recordSizeKiB() Specifies the record size of an OpenZFS volume, in kibibytes (KiB).
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateOpenZFSVolumeConfiguration.Builder>	serializableBuilderClass()
Integer	storageCapacityQuotaGiB() The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
Integer	storageCapacityReservationGiB() The amount of storage in gibibytes (GiB) to reserve from the parent volume.
UpdateOpenZFSVolumeConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<OpenZFSUserOrGroupQuota>	userAndGroupQuotas() An object specifying how much storage users or groups can use on the volume.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

storageCapacityReservationGiB

public final 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. You can specify a value of -1 to unset a volume's storage capacity reservation.

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. You can specify a value of -1 to unset a volume's storage capacity reservation.

storageCapacityQuotaGiB

public final Integer storageCapacityQuotaGiB()

The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of -1 to unset a volume's storage capacity quota.

Returns:

The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of -1 to unset a volume's storage capacity quota.

recordSizeKiB

public final Integer recordSizeKiB()

Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.

Returns:

Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.

dataCompressionType

public final OpenZFSDataCompressionType dataCompressionType()

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

• NONE - Doesn't compress the data on the volume. NONE is the default.

• ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

• LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

If the service returns an enum value that is not available in the current SDK version, dataCompressionType will return OpenZFSDataCompressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataCompressionTypeAsString().

Returns:

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

• NONE - Doesn't compress the data on the volume. NONE is the default.

• ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

• LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

See Also:

OpenZFSDataCompressionType

dataCompressionTypeAsString

public final String dataCompressionTypeAsString()

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

• NONE - Doesn't compress the data on the volume. NONE is the default.

• ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

• LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

If the service returns an enum value that is not available in the current SDK version, dataCompressionType will return OpenZFSDataCompressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataCompressionTypeAsString().

Returns:

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

• NONE - Doesn't compress the data on the volume. NONE is the default.

• ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

• LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

See Also:

OpenZFSDataCompressionType

hasNfsExports

public final boolean hasNfsExports()

For responses, this returns true if the service returned a value for the NfsExports property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

nfsExports

public final List<OpenZFSNfsExport> nfsExports()

The configuration object for mounting a Network File System (NFS) file system.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNfsExports() method.

Returns:

The configuration object for mounting a Network File System (NFS) file system.

hasUserAndGroupQuotas

public final boolean hasUserAndGroupQuotas()

For responses, this returns true if the service returned a value for the UserAndGroupQuotas property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

userAndGroupQuotas

public final List<OpenZFSUserOrGroupQuota> userAndGroupQuotas()

An object specifying how much storage users or groups can use on the volume.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserAndGroupQuotas() method.

Returns:

An object specifying how much storage users or groups can use on the volume.

readOnly

public final Boolean readOnly()

A Boolean value indicating whether the volume is read-only.

Returns:

A Boolean value indicating whether the volume is read-only.

toBuilder

public UpdateOpenZFSVolumeConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateOpenZFSVolumeConfiguration.Builder,UpdateOpenZFSVolumeConfiguration>

builder

public static UpdateOpenZFSVolumeConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateOpenZFSVolumeConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo