AvailabilityZoneInfo (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.opensearch.model.AvailabilityZoneInfo

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AvailabilityZoneInfo
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about an Availability Zone on a domain.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

AvailabilityZoneInfo()

Constructors
Constructor and Description
`AvailabilityZoneInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AvailabilityZoneInfo`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAvailabilityZoneName()` The name of the Availability Zone.
`String`	`getAvailableDataNodeCount()` The number of data nodes active in the Availability Zone.
`String`	`getConfiguredDataNodeCount()` The total number of data nodes configured in the Availability Zone.
`String`	`getTotalShards()` The total number of primary and replica shards in the Availability Zone.
`String`	`getTotalUnAssignedShards()` The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.
`String`	`getZoneStatus()` The current state of the Availability Zone.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAvailabilityZoneName(String availabilityZoneName)` The name of the Availability Zone.
`void`	`setAvailableDataNodeCount(String availableDataNodeCount)` The number of data nodes active in the Availability Zone.
`void`	`setConfiguredDataNodeCount(String configuredDataNodeCount)` The total number of data nodes configured in the Availability Zone.
`void`	`setTotalShards(String totalShards)` The total number of primary and replica shards in the Availability Zone.
`void`	`setTotalUnAssignedShards(String totalUnAssignedShards)` The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.
`void`	`setZoneStatus(String zoneStatus)` The current state of the Availability Zone.
`String`	`toString()` Returns a string representation of this object.
`AvailabilityZoneInfo`	`withAvailabilityZoneName(String availabilityZoneName)` The name of the Availability Zone.
`AvailabilityZoneInfo`	`withAvailableDataNodeCount(String availableDataNodeCount)` The number of data nodes active in the Availability Zone.
`AvailabilityZoneInfo`	`withConfiguredDataNodeCount(String configuredDataNodeCount)` The total number of data nodes configured in the Availability Zone.
`AvailabilityZoneInfo`	`withTotalShards(String totalShards)` The total number of primary and replica shards in the Availability Zone.
`AvailabilityZoneInfo`	`withTotalUnAssignedShards(String totalUnAssignedShards)` The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.
`AvailabilityZoneInfo`	`withZoneStatus(String zoneStatus)` The current state of the Availability Zone.
`AvailabilityZoneInfo`	`withZoneStatus(ZoneStatus zoneStatus)` The current state of the Availability Zone.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AvailabilityZoneInfo
```
public AvailabilityZoneInfo()
```
- Method Detail
  - setAvailabilityZoneName
```
public void setAvailabilityZoneName(String availabilityZoneName)
```
    The name of the Availability Zone.
    
    Parameters:
    
    availabilityZoneName - The name of the Availability Zone.
  - getAvailabilityZoneName
```
public String getAvailabilityZoneName()
```
    The name of the Availability Zone.
    
    Returns:
    
    The name of the Availability Zone.
  - withAvailabilityZoneName
```
public AvailabilityZoneInfo withAvailabilityZoneName(String availabilityZoneName)
```
    The name of the Availability Zone.
    
    Parameters:
    
    availabilityZoneName - The name of the Availability Zone.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setZoneStatus
```
public void setZoneStatus(String 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.
    Parameters:
    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.
    See Also:
    
    ZoneStatus
  - getZoneStatus
```
public String getZoneStatus()
```
    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.
    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
  - withZoneStatus
```
public AvailabilityZoneInfo withZoneStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ZoneStatus
  - withZoneStatus
```
public AvailabilityZoneInfo withZoneStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ZoneStatus
  - setConfiguredDataNodeCount
```
public void setConfiguredDataNodeCount(String configuredDataNodeCount)
```
    The total number of data nodes configured in the Availability Zone.
    
    Parameters:
    
    configuredDataNodeCount - The total number of data nodes configured in the Availability Zone.
  - getConfiguredDataNodeCount
```
public String getConfiguredDataNodeCount()
```
    The total number of data nodes configured in the Availability Zone.
    
    Returns:
    
    The total number of data nodes configured in the Availability Zone.
  - withConfiguredDataNodeCount
```
public AvailabilityZoneInfo withConfiguredDataNodeCount(String configuredDataNodeCount)
```
    The total number of data nodes configured in the Availability Zone.
    
    Parameters:
    
    configuredDataNodeCount - The total number of data nodes configured in the Availability Zone.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAvailableDataNodeCount
```
public void setAvailableDataNodeCount(String availableDataNodeCount)
```
    The number of data nodes active in the Availability Zone.
    
    Parameters:
    
    availableDataNodeCount - The number of data nodes active in the Availability Zone.
  - getAvailableDataNodeCount
```
public String getAvailableDataNodeCount()
```
    The number of data nodes active in the Availability Zone.
    
    Returns:
    
    The number of data nodes active in the Availability Zone.
  - withAvailableDataNodeCount
```
public AvailabilityZoneInfo withAvailableDataNodeCount(String availableDataNodeCount)
```
    The number of data nodes active in the Availability Zone.
    
    Parameters:
    
    availableDataNodeCount - The number of data nodes active in the Availability Zone.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalShards
```
public void setTotalShards(String totalShards)
```
    The total number of primary and replica shards in the Availability Zone.
    
    Parameters:
    
    totalShards - The total number of primary and replica shards in the Availability Zone.
  - getTotalShards
```
public String getTotalShards()
```
    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.
  - withTotalShards
```
public AvailabilityZoneInfo withTotalShards(String totalShards)
```
    The total number of primary and replica shards in the Availability Zone.
    
    Parameters:
    
    totalShards - The total number of primary and replica shards in the Availability Zone.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalUnAssignedShards
```
public void setTotalUnAssignedShards(String totalUnAssignedShards)
```
    The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.
    
    Parameters:
    
    totalUnAssignedShards - The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.
  - getTotalUnAssignedShards
```
public String getTotalUnAssignedShards()
```
    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.
  - withTotalUnAssignedShards
```
public AvailabilityZoneInfo withTotalUnAssignedShards(String totalUnAssignedShards)
```
    The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.
    
    Parameters:
    
    totalUnAssignedShards - The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AvailabilityZoneInfo clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class AvailabilityZoneInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AvailabilityZoneInfo

Method Detail

setAvailabilityZoneName

getAvailabilityZoneName

withAvailabilityZoneName

setZoneStatus

getZoneStatus

withZoneStatus

withZoneStatus

setConfiguredDataNodeCount

getConfiguredDataNodeCount

withConfiguredDataNodeCount

setAvailableDataNodeCount

getAvailableDataNodeCount

withAvailableDataNodeCount

setTotalShards

getTotalShards

withTotalShards

setTotalUnAssignedShards

getTotalUnAssignedShards

withTotalUnAssignedShards

toString

equals

hashCode

clone

marshall