Package software.amazon.awssdk.services.opensearch.model

Class AvailabilityZoneInfo

java.lang.Object

software.amazon.awssdk.services.opensearch.model.AvailabilityZoneInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AvailabilityZoneInfo.Builder,AvailabilityZoneInfo>

@Generated("software.amazon.awssdk:codegen")
public final class AvailabilityZoneInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AvailabilityZoneInfo.Builder,AvailabilityZoneInfo>

Information about an Availability Zone on a domain.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AvailabilityZoneInfo.Builder

Method Summary

Modifier and Type	Method	Description
String	availabilityZoneName()	The name of the Availability Zone.
String	availableDataNodeCount()	The number of data nodes active in the Availability Zone.
static AvailabilityZoneInfo.Builder	builder()
String	configuredDataNodeCount()	The total number of data nodes configured in the Availability Zone.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AvailabilityZoneInfo.Builder>	serializableBuilderClass()
AvailabilityZoneInfo.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	totalShards()	The total number of primary and replica shards in the Availability Zone.
String	totalUnAssignedShards()	The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.
ZoneStatus	zoneStatus()	The current state of the Availability Zone.
String	zoneStatusAsString()	The current state of the Availability Zone.

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

availabilityZoneName

public final String availabilityZoneName()

The name of the Availability Zone.

Returns:

The name of the Availability Zone.

zoneStatus

public final ZoneStatus zoneStatus()

The current state of the Availability Zone. Current options are Active and StandBy.

• Active - Data nodes in the Availability Zone are in use.

• StandBy - Data nodes in the Availability Zone are in a standby state.

• NotAvailable - Unable to retrieve information.

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

Returns:

The current state of the Availability Zone. Current options are Active and StandBy.

• Active - Data nodes in the Availability Zone are in use.

• StandBy - Data nodes in the Availability Zone are in a standby state.

• NotAvailable - Unable to retrieve information.

See Also:

ZoneStatus

zoneStatusAsString

public final String zoneStatusAsString()

The current state of the Availability Zone. Current options are Active and StandBy.

• Active - Data nodes in the Availability Zone are in use.

• StandBy - Data nodes in the Availability Zone are in a standby state.

• NotAvailable - Unable to retrieve information.

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

Returns:

The current state of the Availability Zone. Current options are Active and StandBy.

• Active - Data nodes in the Availability Zone are in use.

• StandBy - Data nodes in the Availability Zone are in a standby state.

• NotAvailable - Unable to retrieve information.

See Also:

ZoneStatus

configuredDataNodeCount

public final String configuredDataNodeCount()

The total number of data nodes configured in the Availability Zone.

Returns:

The total number of data nodes configured in the Availability Zone.

availableDataNodeCount

public final String availableDataNodeCount()

The number of data nodes active in the Availability Zone.

Returns:

The number of data nodes active in the Availability Zone.

totalShards

public final String totalShards()

The total number of primary and replica shards in the Availability Zone.

Returns:

The total number of primary and replica shards in the Availability Zone.

totalUnAssignedShards

public final String totalUnAssignedShards()

The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.

Returns:

The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.

toBuilder

public AvailabilityZoneInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AvailabilityZoneInfo.Builder,AvailabilityZoneInfo>

builder

public static AvailabilityZoneInfo.Builder builder()

serializableBuilderClass

public static Class<? extends AvailabilityZoneInfo.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)

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo