Class OpenZFSReadCacheConfiguration

java.lang.Object
software.amazon.awssdk.services.fsx.model.OpenZFSReadCacheConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OpenZFSReadCacheConfiguration.Builder,OpenZFSReadCacheConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class OpenZFSReadCacheConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OpenZFSReadCacheConfiguration.Builder,OpenZFSReadCacheConfiguration>

The configuration for the optional provisioned SSD read cache on Amazon FSx for OpenZFS file systems that use the Intelligent-Tiering storage class.

See Also:

  • Method Details

    • sizingMode

      public final OpenZFSReadCacheSizingMode sizingMode()

      Specifies how the provisioned SSD read cache is sized, as follows:

      • Set to NO_CACHE if you do not want to use an SSD read cache with your Intelligent-Tiering file system.

      • Set to USER_PROVISIONED to specify the exact size of your SSD read cache.

      • Set to PROPORTIONAL_TO_THROUGHPUT_CAPACITY to have your SSD read cache automatically sized based on your throughput capacity.

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

      Returns:
      Specifies how the provisioned SSD read cache is sized, as follows:

      • Set to NO_CACHE if you do not want to use an SSD read cache with your Intelligent-Tiering file system.

      • Set to USER_PROVISIONED to specify the exact size of your SSD read cache.

      • Set to PROPORTIONAL_TO_THROUGHPUT_CAPACITY to have your SSD read cache automatically sized based on your throughput capacity.

      See Also:

    • sizingModeAsString

      public final String sizingModeAsString()

      Specifies how the provisioned SSD read cache is sized, as follows:

      • Set to NO_CACHE if you do not want to use an SSD read cache with your Intelligent-Tiering file system.

      • Set to USER_PROVISIONED to specify the exact size of your SSD read cache.

      • Set to PROPORTIONAL_TO_THROUGHPUT_CAPACITY to have your SSD read cache automatically sized based on your throughput capacity.

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

      Returns:
      Specifies how the provisioned SSD read cache is sized, as follows:

      • Set to NO_CACHE if you do not want to use an SSD read cache with your Intelligent-Tiering file system.

      • Set to USER_PROVISIONED to specify the exact size of your SSD read cache.

      • Set to PROPORTIONAL_TO_THROUGHPUT_CAPACITY to have your SSD read cache automatically sized based on your throughput capacity.

      See Also:

    • sizeGiB

      public final Integer sizeGiB()

      Required if SizingMode is set to USER_PROVISIONED. Specifies the size of the file system's SSD read cache, in gibibytes (GiB).

      Returns:
      Required if SizingMode is set to USER_PROVISIONED. Specifies the size of the file system's SSD read cache, in gibibytes (GiB).

    • toBuilder

      public OpenZFSReadCacheConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<OpenZFSReadCacheConfiguration.Builder,OpenZFSReadCacheConfiguration>
      Returns:
      a builder for type T

    • builder

      public static OpenZFSReadCacheConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OpenZFSReadCacheConfiguration.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.