Package software.amazon.awssdk.services.opensearch.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EBSOptions.Builder

Method Summary

Modifier and Type	Method	Description
static EBSOptions.Builder	builder()
Boolean	ebsEnabled()	Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	iops()	Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes.
List<SdkField<?>>	sdkFields()
static Class<? extends EBSOptions.Builder>	serializableBuilderClass()
Integer	throughput()	Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes.
EBSOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	volumeSize()	Specifies the size (in GiB) of EBS volumes attached to data nodes.
VolumeType	volumeType()	Specifies the type of EBS volumes attached to data nodes.
String	volumeTypeAsString()	Specifies the type of EBS volumes attached to data nodes.

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

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:

VolumeType

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:

VolumeType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<EBSOptions.Builder,EBSOptions>

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)

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