Class EBSOptions

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

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

See Also:

  • Method Details

    • ebsEnabled

      public final Boolean ebsEnabled()

      Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

      Returns:
      Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

    • volumeType

      public final VolumeType volumeType()

      Specifies the type of EBS volumes attached to data nodes.

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

      Returns:
      Specifies the type of EBS volumes attached to data nodes.
      See Also:

    • volumeTypeAsString

      public final String volumeTypeAsString()

      Specifies the type of EBS volumes attached to data nodes.

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

      Returns:
      Specifies the type of EBS volumes attached to data nodes.
      See Also:

    • volumeSize

      public final Integer volumeSize()

      Specifies the size (in GiB) of EBS volumes attached to data nodes.

      Returns:
      Specifies the size (in GiB) of EBS volumes attached to data nodes.

    • iops

      public final Integer iops()

      Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

      Returns:
      Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

    • throughput

      public final Integer throughput()

      Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

      Returns:
      Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

    • toBuilder

      public EBSOptions.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<EBSOptions.Builder,EBSOptions>
      Returns:
      a builder for type T

    • builder

      public static EBSOptions.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EBSOptions.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.