/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.opensearch.model; import java.io.Serializable; import javax.annotation.Generated; /** *
* The result of a DescribeDomainHealth
request. Contains health information for the requested domain.
*
* The current state of the domain. *
*
* Processing
- The domain has updates in progress.
*
* Active
- Requested changes have been processed and deployed to the domain.
*
* The number of Availability Zones configured for the domain. If the service is unable to fetch this information,
* it will return NotAvailable
.
*
* The number of active Availability Zones configured for the domain. If the service is unable to fetch this
* information, it will return NotAvailable
.
*
* The number of standby Availability Zones configured for the domain. If the service is unable to fetch this
* information, it will return NotAvailable
.
*
* The number of data nodes configured for the domain. If the service is unable to fetch this information, it will
* return NotAvailable
.
*
* A boolean that indicates if dedicated master nodes are activated for the domain. *
*/ private Boolean dedicatedMaster; /** *
* 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
.
*
* The number of warm nodes configured for the domain. *
*/ private String warmNodeCount; /** ** 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. *
** 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.
*
* The total number of primary and replica shards for the domain. *
*/ private String totalShards; /** ** The total number of primary and replica shards not allocated to any of the nodes for the cluster. *
*/ private String totalUnAssignedShards; /** *
* A list of EnvironmentInfo
for the domain.
*
* The current state of the domain. *
*
* Processing
- The domain has updates in progress.
*
* Active
- Requested changes have been processed and deployed to the domain.
*
* Processing
- The domain has updates in progress.
*
* Active
- Requested changes have been processed and deployed to the domain.
*
* The current state of the domain. *
*
* Processing
- The domain has updates in progress.
*
* Active
- Requested changes have been processed and deployed to the domain.
*
* Processing
- The domain has updates in progress.
*
* Active
- Requested changes have been processed and deployed to the domain.
*
* The current state of the domain. *
*
* Processing
- The domain has updates in progress.
*
* Active
- Requested changes have been processed and deployed to the domain.
*
* Processing
- The domain has updates in progress.
*
* Active
- Requested changes have been processed and deployed to the domain.
*
* The current state of the domain. *
*
* Processing
- The domain has updates in progress.
*
* Active
- Requested changes have been processed and deployed to the domain.
*
* Processing
- The domain has updates in progress.
*
* Active
- Requested changes have been processed and deployed to the domain.
*
* The number of Availability Zones configured for the domain. If the service is unable to fetch this information,
* it will return NotAvailable
.
*
NotAvailable
.
*/
public void setAvailabilityZoneCount(String availabilityZoneCount) {
this.availabilityZoneCount = availabilityZoneCount;
}
/**
*
* The number of Availability Zones configured for the domain. If the service is unable to fetch this information,
* it will return NotAvailable
.
*
NotAvailable
.
*/
public String getAvailabilityZoneCount() {
return this.availabilityZoneCount;
}
/**
*
* The number of Availability Zones configured for the domain. If the service is unable to fetch this information,
* it will return NotAvailable
.
*
NotAvailable
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDomainHealthResult withAvailabilityZoneCount(String availabilityZoneCount) {
setAvailabilityZoneCount(availabilityZoneCount);
return this;
}
/**
*
* The number of active Availability Zones configured for the domain. If the service is unable to fetch this
* information, it will return NotAvailable
.
*
NotAvailable
.
*/
public void setActiveAvailabilityZoneCount(String activeAvailabilityZoneCount) {
this.activeAvailabilityZoneCount = activeAvailabilityZoneCount;
}
/**
*
* The number of active Availability Zones configured for the domain. If the service is unable to fetch this
* information, it will return NotAvailable
.
*
NotAvailable
.
*/
public String getActiveAvailabilityZoneCount() {
return this.activeAvailabilityZoneCount;
}
/**
*
* The number of active Availability Zones configured for the domain. If the service is unable to fetch this
* information, it will return NotAvailable
.
*
NotAvailable
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDomainHealthResult withActiveAvailabilityZoneCount(String activeAvailabilityZoneCount) {
setActiveAvailabilityZoneCount(activeAvailabilityZoneCount);
return this;
}
/**
*
* The number of standby Availability Zones configured for the domain. If the service is unable to fetch this
* information, it will return NotAvailable
.
*
NotAvailable
.
*/
public void setStandByAvailabilityZoneCount(String standByAvailabilityZoneCount) {
this.standByAvailabilityZoneCount = standByAvailabilityZoneCount;
}
/**
*
* The number of standby Availability Zones configured for the domain. If the service is unable to fetch this
* information, it will return NotAvailable
.
*
NotAvailable
.
*/
public String getStandByAvailabilityZoneCount() {
return this.standByAvailabilityZoneCount;
}
/**
*
* The number of standby Availability Zones configured for the domain. If the service is unable to fetch this
* information, it will return NotAvailable
.
*
NotAvailable
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDomainHealthResult withStandByAvailabilityZoneCount(String standByAvailabilityZoneCount) {
setStandByAvailabilityZoneCount(standByAvailabilityZoneCount);
return this;
}
/**
*
* The number of data nodes configured for the domain. If the service is unable to fetch this information, it will
* return NotAvailable
.
*
NotAvailable
.
*/
public void setDataNodeCount(String dataNodeCount) {
this.dataNodeCount = dataNodeCount;
}
/**
*
* The number of data nodes configured for the domain. If the service is unable to fetch this information, it will
* return NotAvailable
.
*
NotAvailable
.
*/
public String getDataNodeCount() {
return this.dataNodeCount;
}
/**
*
* The number of data nodes configured for the domain. If the service is unable to fetch this information, it will
* return NotAvailable
.
*
NotAvailable
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDomainHealthResult withDataNodeCount(String dataNodeCount) {
setDataNodeCount(dataNodeCount);
return this;
}
/**
* * A boolean that indicates if dedicated master nodes are activated for the domain. *
* * @param dedicatedMaster * A boolean that indicates if dedicated master nodes are activated for the domain. */ public void setDedicatedMaster(Boolean dedicatedMaster) { this.dedicatedMaster = dedicatedMaster; } /** ** A boolean that indicates if dedicated master nodes are activated for the domain. *
* * @return A boolean that indicates if dedicated master nodes are activated for the domain. */ public Boolean getDedicatedMaster() { return this.dedicatedMaster; } /** ** A boolean that indicates if dedicated master nodes are activated for the domain. *
* * @param dedicatedMaster * A boolean that indicates if dedicated master nodes are activated for the domain. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDomainHealthResult withDedicatedMaster(Boolean dedicatedMaster) { setDedicatedMaster(dedicatedMaster); return this; } /** ** A boolean that indicates if dedicated master nodes are activated for the domain. *
* * @return A boolean that indicates if dedicated master nodes are activated for the domain. */ public Boolean isDedicatedMaster() { return this.dedicatedMaster; } /** *
* 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
.
*
NotAvailable
.
*/
public void setMasterEligibleNodeCount(String masterEligibleNodeCount) {
this.masterEligibleNodeCount = 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
.
*
NotAvailable
.
*/
public String getMasterEligibleNodeCount() {
return this.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
.
*
NotAvailable
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDomainHealthResult withMasterEligibleNodeCount(String masterEligibleNodeCount) {
setMasterEligibleNodeCount(masterEligibleNodeCount);
return this;
}
/**
* * The number of warm nodes configured for the domain. *
* * @param warmNodeCount * The number of warm nodes configured for the domain. */ public void setWarmNodeCount(String warmNodeCount) { this.warmNodeCount = warmNodeCount; } /** ** The number of warm nodes configured for the domain. *
* * @return The number of warm nodes configured for the domain. */ public String getWarmNodeCount() { return this.warmNodeCount; } /** ** The number of warm nodes configured for the domain. *
* * @param warmNodeCount * The number of warm nodes configured for the domain. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDomainHealthResult withWarmNodeCount(String warmNodeCount) { setWarmNodeCount(warmNodeCount); return this; } /** ** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* The total number of primary and replica shards for the domain. *
* * @param totalShards * The total number of primary and replica shards for the domain. */ public void setTotalShards(String totalShards) { this.totalShards = totalShards; } /** ** The total number of primary and replica shards for the domain. *
* * @return The total number of primary and replica shards for the domain. */ public String getTotalShards() { return this.totalShards; } /** ** The total number of primary and replica shards for the domain. *
* * @param totalShards * The total number of primary and replica shards for the domain. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDomainHealthResult withTotalShards(String totalShards) { setTotalShards(totalShards); return this; } /** ** The total number of primary and replica shards not allocated to any of the nodes for the cluster. *
* * @param totalUnAssignedShards * The total number of primary and replica shards not allocated to any of the nodes for the cluster. */ public void setTotalUnAssignedShards(String totalUnAssignedShards) { this.totalUnAssignedShards = totalUnAssignedShards; } /** ** The total number of primary and replica shards not allocated to any of the nodes for the cluster. *
* * @return The total number of primary and replica shards not allocated to any of the nodes for the cluster. */ public String getTotalUnAssignedShards() { return this.totalUnAssignedShards; } /** ** The total number of primary and replica shards not allocated to any of the nodes for the cluster. *
* * @param totalUnAssignedShards * The total number of primary and replica shards not allocated to any of the nodes for the cluster. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDomainHealthResult withTotalUnAssignedShards(String totalUnAssignedShards) { setTotalUnAssignedShards(totalUnAssignedShards); return this; } /** *
* A list of EnvironmentInfo
for the domain.
*
EnvironmentInfo
for the domain.
*/
public java.util.List
* A list of EnvironmentInfo
for the domain.
*
EnvironmentInfo
for the domain.
*/
public void setEnvironmentInformation(java.util.Collection
* A list of EnvironmentInfo
for the domain.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setEnvironmentInformation(java.util.Collection)} or * {@link #withEnvironmentInformation(java.util.Collection)} if you want to override the existing values. *
* * @param environmentInformation * A list ofEnvironmentInfo
for the domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDomainHealthResult withEnvironmentInformation(EnvironmentInfo... environmentInformation) {
if (this.environmentInformation == null) {
setEnvironmentInformation(new java.util.ArrayList
* A list of EnvironmentInfo
for the domain.
*
EnvironmentInfo
for the domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDomainHealthResult withEnvironmentInformation(java.util.Collection