Class DescribeDomainHealthResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.opensearch.model.OpenSearchResponse
software.amazon.awssdk.services.opensearch.model.DescribeDomainHealthResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeDomainHealthResponse.Builder,DescribeDomainHealthResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeDomainHealthResponse extends OpenSearchResponse implements ToCopyableBuilder<DescribeDomainHealthResponse.Builder,DescribeDomainHealthResponse>

The result of a DescribeDomainHealth request. Contains health information for the requested domain.

  • Method Details

    • domainState

      public final DomainState domainState()

      The current state of the domain.

      • Processing - The domain has updates in progress.

      • Active - Requested changes have been processed and deployed to the domain.

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

      Returns:
      The current state of the domain.

      • Processing - The domain has updates in progress.

      • Active - Requested changes have been processed and deployed to the domain.

      See Also:

    • domainStateAsString

      public final String domainStateAsString()

      The current state of the domain.

      • Processing - The domain has updates in progress.

      • Active - Requested changes have been processed and deployed to the domain.

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

      Returns:
      The current state of the domain.

      • Processing - The domain has updates in progress.

      • Active - Requested changes have been processed and deployed to the domain.

      See Also:

    • availabilityZoneCount

      public final String availabilityZoneCount()

      The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

      Returns:
      The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

    • activeAvailabilityZoneCount

      public final String activeAvailabilityZoneCount()

      The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

      Returns:
      The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

    • standByAvailabilityZoneCount

      public final String standByAvailabilityZoneCount()

      The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

      Returns:
      The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

    • dataNodeCount

      public final String dataNodeCount()

      The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

      Returns:
      The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

    • dedicatedMaster

      public final Boolean dedicatedMaster()

      A boolean that indicates if dedicated master nodes are activated for the domain.

      Returns:
      A boolean that indicates if dedicated master nodes are activated for the domain.

    • masterEligibleNodeCount

      public final String masterEligibleNodeCount()

      The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

      Returns:
      The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

    • warmNodeCount

      public final String warmNodeCount()

      The number of warm nodes configured for the domain.

      Returns:
      The number of warm nodes configured for the domain.

    • masterNode

      public final MasterNodeStatus masterNode()

      Indicates whether the domain has an elected master node.

      • Available - The domain has an elected master node.

      • UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.

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

      Returns:
      Indicates whether the domain has an elected master node.

      • Available - The domain has an elected master node.

      • UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.

      See Also:

    • masterNodeAsString

      public final String masterNodeAsString()

      Indicates whether the domain has an elected master node.

      • Available - The domain has an elected master node.

      • UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.

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

      Returns:
      Indicates whether the domain has an elected master node.

      • Available - The domain has an elected master node.

      • UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.

      See Also:

    • clusterHealth

      public final DomainHealth clusterHealth()

      The current health status of your cluster.

      • Red - At least one primary shard is not allocated to any node.

      • Yellow - All primary shards are allocated to nodes, but some replicas aren’t.

      • Green - All primary shards and their replicas are allocated to nodes.

      • NotAvailable - Unable to retrieve cluster health.

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

      Returns:
      The current health status of your cluster.

      • Red - At least one primary shard is not allocated to any node.

      • Yellow - All primary shards are allocated to nodes, but some replicas aren’t.

      • Green - All primary shards and their replicas are allocated to nodes.

      • NotAvailable - Unable to retrieve cluster health.

      See Also:

    • clusterHealthAsString

      public final String clusterHealthAsString()

      The current health status of your cluster.

      • Red - At least one primary shard is not allocated to any node.

      • Yellow - All primary shards are allocated to nodes, but some replicas aren’t.

      • Green - All primary shards and their replicas are allocated to nodes.

      • NotAvailable - Unable to retrieve cluster health.

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

      Returns:
      The current health status of your cluster.

      • Red - At least one primary shard is not allocated to any node.

      • Yellow - All primary shards are allocated to nodes, but some replicas aren’t.

      • Green - All primary shards and their replicas are allocated to nodes.

      • NotAvailable - Unable to retrieve cluster health.

      See Also:

    • totalShards

      public final String totalShards()

      The total number of primary and replica shards for the domain.

      Returns:
      The total number of primary and replica shards for the domain.

    • totalUnAssignedShards

      public final String totalUnAssignedShards()

      The total number of primary and replica shards not allocated to any of the nodes for the cluster.

      Returns:
      The total number of primary and replica shards not allocated to any of the nodes for the cluster.

    • hasEnvironmentInformation

      public final boolean hasEnvironmentInformation()
      For responses, this returns true if the service returned a value for the EnvironmentInformation property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • environmentInformation

      public final List<EnvironmentInfo> environmentInformation()

      A list of EnvironmentInfo for the domain.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironmentInformation() method.

      Returns:
      A list of EnvironmentInfo for the domain.

    • toBuilder

      public DescribeDomainHealthResponse.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<DescribeDomainHealthResponse.Builder,DescribeDomainHealthResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeDomainHealthResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeDomainHealthResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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