software.amazon.awssdk.services.opensearch.model

Interface DescribeDomainHealthResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeDomainHealthResponse.Builder,DescribeDomainHealthResponse>, OpenSearchResponse.Builder, SdkBuilder<DescribeDomainHealthResponse.Builder,DescribeDomainHealthResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeDomainHealthResponse

public static interface DescribeDomainHealthResponse.Builder
extends OpenSearchResponse.Builder, SdkPojo, CopyableBuilder<DescribeDomainHealthResponse.Builder,DescribeDomainHealthResponse>

Method Summary

Modifier and Type	Method and Description
DescribeDomainHealthResponse.Builder	activeAvailabilityZoneCount(String activeAvailabilityZoneCount) The number of active Availability Zones configured for the domain.
DescribeDomainHealthResponse.Builder	availabilityZoneCount(String availabilityZoneCount) The number of Availability Zones configured for the domain.
DescribeDomainHealthResponse.Builder	clusterHealth(DomainHealth clusterHealth) The current health status of your cluster.
DescribeDomainHealthResponse.Builder	clusterHealth(String clusterHealth) The current health status of your cluster.
DescribeDomainHealthResponse.Builder	dataNodeCount(String dataNodeCount) The number of data nodes configured for the domain.
DescribeDomainHealthResponse.Builder	dedicatedMaster(Boolean dedicatedMaster) A boolean that indicates if dedicated master nodes are activated for the domain.
DescribeDomainHealthResponse.Builder	domainState(DomainState domainState) The current state of the domain.
DescribeDomainHealthResponse.Builder	domainState(String domainState) The current state of the domain.
DescribeDomainHealthResponse.Builder	environmentInformation(Collection<EnvironmentInfo> environmentInformation) A list of EnvironmentInfo for the domain.
DescribeDomainHealthResponse.Builder	environmentInformation(Consumer<EnvironmentInfo.Builder>... environmentInformation) A list of EnvironmentInfo for the domain.
DescribeDomainHealthResponse.Builder	environmentInformation(EnvironmentInfo... environmentInformation) A list of EnvironmentInfo for the domain.
DescribeDomainHealthResponse.Builder	masterEligibleNodeCount(String masterEligibleNodeCount) The number of nodes that can be elected as a master node.
DescribeDomainHealthResponse.Builder	masterNode(MasterNodeStatus masterNode) Indicates whether the domain has an elected master node.
DescribeDomainHealthResponse.Builder	masterNode(String masterNode) Indicates whether the domain has an elected master node.
DescribeDomainHealthResponse.Builder	standByAvailabilityZoneCount(String standByAvailabilityZoneCount) The number of standby Availability Zones configured for the domain.
DescribeDomainHealthResponse.Builder	totalShards(String totalShards) The total number of primary and replica shards for the domain.
DescribeDomainHealthResponse.Builder	totalUnAssignedShards(String totalUnAssignedShards) The total number of primary and replica shards not allocated to any of the nodes for the cluster.
DescribeDomainHealthResponse.Builder	warmNodeCount(String warmNodeCount) The number of warm nodes configured for the domain.

Methods inherited from interface software.amazon.awssdk.services.opensearch.model.OpenSearchResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

domainState

DescribeDomainHealthResponse.Builder domainState(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DomainState, DomainState

domainState

DescribeDomainHealthResponse.Builder domainState(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DomainState, DomainState

availabilityZoneCount

DescribeDomainHealthResponse.Builder availabilityZoneCount(String availabilityZoneCount)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

activeAvailabilityZoneCount

DescribeDomainHealthResponse.Builder activeAvailabilityZoneCount(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

standByAvailabilityZoneCount

DescribeDomainHealthResponse.Builder standByAvailabilityZoneCount(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

dataNodeCount

DescribeDomainHealthResponse.Builder dataNodeCount(String dataNodeCount)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dedicatedMaster

DescribeDomainHealthResponse.Builder dedicatedMaster(Boolean dedicatedMaster)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

masterEligibleNodeCount

DescribeDomainHealthResponse.Builder masterEligibleNodeCount(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

warmNodeCount

DescribeDomainHealthResponse.Builder warmNodeCount(String warmNodeCount)

The number of warm nodes configured for the domain.

Parameters:

warmNodeCount - The number of warm nodes configured for the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

masterNode

DescribeDomainHealthResponse.Builder masterNode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MasterNodeStatus, MasterNodeStatus

masterNode

DescribeDomainHealthResponse.Builder masterNode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MasterNodeStatus, MasterNodeStatus

clusterHealth

DescribeDomainHealthResponse.Builder clusterHealth(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DomainHealth, DomainHealth

clusterHealth

DescribeDomainHealthResponse.Builder clusterHealth(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DomainHealth, DomainHealth

totalShards

DescribeDomainHealthResponse.Builder totalShards(String totalShards)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

totalUnAssignedShards

DescribeDomainHealthResponse.Builder totalUnAssignedShards(String totalUnAssignedShards)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

environmentInformation

DescribeDomainHealthResponse.Builder environmentInformation(Collection<EnvironmentInfo> environmentInformation)

A list of EnvironmentInfo for the domain.

Parameters:

environmentInformation - A list of EnvironmentInfo for the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

environmentInformation

DescribeDomainHealthResponse.Builder environmentInformation(EnvironmentInfo... environmentInformation)

A list of EnvironmentInfo for the domain.

Parameters:

environmentInformation - A list of EnvironmentInfo for the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

environmentInformation

DescribeDomainHealthResponse.Builder environmentInformation(Consumer<EnvironmentInfo.Builder>... environmentInformation)

A list of EnvironmentInfo for the domain.

This is a convenience method that creates an instance of the EnvironmentInfo.Builder avoiding the need to create one manually via EnvironmentInfo.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #environmentInformation(List).

Parameters:

environmentInformation - a consumer that will call methods on EnvironmentInfo.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#environmentInformation(java.util.Collection)