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

Class DomainNodesStatus

java.lang.Object

software.amazon.awssdk.services.opensearch.model.DomainNodesStatus

All Implemented Interfaces:

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

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

Container for information about nodes on the domain.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DomainNodesStatus.Builder

Method Summary

Modifier and Type	Method	Description
String	availabilityZone()	The Availability Zone of the node.
static DomainNodesStatus.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
OpenSearchPartitionInstanceType	instanceType()	The instance type information of the node.
String	instanceTypeAsString()	The instance type information of the node.
String	nodeId()	The ID of the node.
NodeStatus	nodeStatus()	Indicates if the node is active or in standby.
String	nodeStatusAsString()	Indicates if the node is active or in standby.
NodeType	nodeType()	Indicates whether the nodes is a data, master, or UltraWarm node.
String	nodeTypeAsString()	Indicates whether the nodes is a data, master, or UltraWarm node.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DomainNodesStatus.Builder>	serializableBuilderClass()
String	storageSize()	The storage size of the node, in GiB.
String	storageType()	Indicates if the node has EBS or instance storage.
VolumeType	storageVolumeType()	If the nodes has EBS storage, indicates if the volume type is gp2 or gp3.
String	storageVolumeTypeAsString()	If the nodes has EBS storage, indicates if the volume type is gp2 or gp3.
DomainNodesStatus.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

nodeId

public final String nodeId()

The ID of the node.

Returns:

The ID of the node.

nodeType

public final NodeType nodeType()

Indicates whether the nodes is a data, master, or UltraWarm node.

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

Returns:

Indicates whether the nodes is a data, master, or UltraWarm node.

See Also:

NodeType

nodeTypeAsString

public final String nodeTypeAsString()

Indicates whether the nodes is a data, master, or UltraWarm node.

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

Returns:

Indicates whether the nodes is a data, master, or UltraWarm node.

See Also:

NodeType

availabilityZone

public final String availabilityZone()

The Availability Zone of the node.

Returns:

The Availability Zone of the node.

instanceType

public final OpenSearchPartitionInstanceType instanceType()

The instance type information of the node.

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

Returns:

The instance type information of the node.

See Also:

OpenSearchPartitionInstanceType

instanceTypeAsString

public final String instanceTypeAsString()

The instance type information of the node.

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

Returns:

The instance type information of the node.

See Also:

OpenSearchPartitionInstanceType

nodeStatus

public final NodeStatus nodeStatus()

Indicates if the node is active or in standby.

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

Returns:

Indicates if the node is active or in standby.

See Also:

NodeStatus

nodeStatusAsString

public final String nodeStatusAsString()

Indicates if the node is active or in standby.

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

Returns:

Indicates if the node is active or in standby.

See Also:

NodeStatus

storageType

public final String storageType()

Indicates if the node has EBS or instance storage.

Returns:

Indicates if the node has EBS or instance storage.

storageVolumeType

public final VolumeType storageVolumeType()

If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only applicable for data nodes.

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

Returns:

If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only applicable for data nodes.

See Also:

VolumeType

storageVolumeTypeAsString

public final String storageVolumeTypeAsString()

If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only applicable for data nodes.

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

Returns:

If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only applicable for data nodes.

See Also:

VolumeType

storageSize

public final String storageSize()

The storage size of the node, in GiB.

Returns:

The storage size of the node, in GiB.

toBuilder

public DomainNodesStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DomainNodesStatus.Builder,DomainNodesStatus>

builder

public static DomainNodesStatus.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo