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:

  • Method Details

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

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

    • 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()
      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<AvailabilityZoneInfo.Builder,AvailabilityZoneInfo>
      Returns:
      a builder for type T

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.