Class EBSOptions
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EBSOptions.Builder,
EBSOptions>
Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EBSOptions.Builder
builder()
final Boolean
Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
iops()
Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes.static Class
<? extends EBSOptions.Builder> final Integer
Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
Specifies the size (in GiB) of EBS volumes attached to data nodes.final VolumeType
Specifies the type of EBS volumes attached to data nodes.final String
Specifies the type of EBS volumes attached to data nodes.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeTypeAsString()
.- Returns:
- Specifies the type of EBS volumes attached to data nodes.
- See Also:
-
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 returnVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeTypeAsString()
.- Returns:
- Specifies the type of EBS volumes attached to data nodes.
- See Also:
-
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
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
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
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 interfaceToCopyableBuilder<EBSOptions.Builder,
EBSOptions> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-