DescribeDomainHealthResponse (AWS Java SDK :: Services

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(value="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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeDomainHealthResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeDomainHealthResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`activeAvailabilityZoneCount()` The number of active Availability Zones configured for the domain.
`String`	`availabilityZoneCount()` The number of Availability Zones configured for the domain.
`static DescribeDomainHealthResponse.Builder`	`builder()`
`DomainHealth`	`clusterHealth()` The current health status of your cluster.
`String`	`clusterHealthAsString()` The current health status of your cluster.
`String`	`dataNodeCount()` The number of data nodes configured for the domain.
`Boolean`	`dedicatedMaster()` A boolean that indicates if dedicated master nodes are activated for the domain.
`DomainState`	`domainState()` The current state of the domain.
`String`	`domainStateAsString()` The current state of the domain.
`List<EnvironmentInfo>`	`environmentInformation()` A list of `EnvironmentInfo` for the domain.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEnvironmentInformation()` For responses, this returns true if the service returned a value for the EnvironmentInformation property.
`int`	`hashCode()`
`String`	`masterEligibleNodeCount()` The number of nodes that can be elected as a master node.
`MasterNodeStatus`	`masterNode()` Indicates whether the domain has an elected master node.
`String`	`masterNodeAsString()` Indicates whether the domain has an elected master node.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeDomainHealthResponse.Builder>`	`serializableBuilderClass()`
`String`	`standByAvailabilityZoneCount()` The number of standby Availability Zones configured for the domain.
`DescribeDomainHealthResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`totalShards()` The total number of primary and replica shards for the domain.
`String`	`totalUnAssignedShards()` The total number of primary and replica shards not allocated to any of the nodes for the cluster.
`String`	`warmNodeCount()` The number of warm nodes configured for the domain.

Methods inherited from class software.amazon.awssdk.services.opensearch.model.OpenSearchResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - 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:
    
    DomainState
  - 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:
    
    DomainState
  - 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:
    
    MasterNodeStatus
  - 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:
    
    MasterNodeStatus
  - 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:
    
    DomainHealth
  - 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:
    
    DomainHealth
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeDomainHealthResponse.Builder,DescribeDomainHealthResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - 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)
```
    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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeDomainHealthResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.opensearch.model.OpenSearchResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

domainState

domainStateAsString

availabilityZoneCount

activeAvailabilityZoneCount

standByAvailabilityZoneCount

dataNodeCount

dedicatedMaster

masterEligibleNodeCount

warmNodeCount

masterNode

masterNodeAsString

clusterHealth

clusterHealthAsString

totalShards

totalUnAssignedShards

hasEnvironmentInformation

environmentInformation

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields