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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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<DomainNodesStatus.Builder,DomainNodesStatus>
      Returns:
      a builder for type T

    • 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)
      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.