java.lang.Object
- software.amazon.awssdk.services.ec2.model.AvailabilityZone

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AvailabilityZone.Builder,AvailabilityZone>

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

Describes Availability Zones, Local Zones, and Wavelength Zones.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AvailabilityZone.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static AvailabilityZone.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`groupLongName()`	The long name of the Availability Zone group, Local Zone group, or Wavelength Zone group.
`String`	`groupName()`	The name of the zone group.
`int`	`hashCode()`
`boolean`	`hasMessages()`	For responses, this returns true if the service returned a value for the Messages property.
`List<AvailabilityZoneMessage>`	`messages()`	Any messages about the Availability Zone, Local Zone, or Wavelength Zone.
`String`	`networkBorderGroup()`	The name of the network border group.
`AvailabilityZoneOptInStatus`	`optInStatus()`	For Availability Zones, this parameter always has the value of `opt-in-not-required`.
`String`	`optInStatusAsString()`	For Availability Zones, this parameter always has the value of `opt-in-not-required`.
`String`	`parentZoneId()`	The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
`String`	`parentZoneName()`	The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
`String`	`regionName()`	The name of the Region.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AvailabilityZone.Builder>`	`serializableBuilderClass()`
`AvailabilityZoneState`	`state()`	The state of the Availability Zone, Local Zone, or Wavelength Zone.
`String`	`stateAsString()`	The state of the Availability Zone, Local Zone, or Wavelength Zone.
`AvailabilityZone.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`zoneId()`	The ID of the Availability Zone, Local Zone, or Wavelength Zone.
`String`	`zoneName()`	The name of the Availability Zone, Local Zone, or Wavelength Zone.
`String`	`zoneType()`	The type of 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
  - optInStatus
```
public final AvailabilityZoneOptInStatus optInStatus()
```
    For Availability Zones, this parameter always has the value of opt-in-not-required.
    
    For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are opted-in and not-opted-in.
    
    If the service returns an enum value that is not available in the current SDK version, optInStatus will return AvailabilityZoneOptInStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from optInStatusAsString().
    
    Returns:
    
    For Availability Zones, this parameter always has the value of opt-in-not-required.
    
    For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are opted-in and not-opted-in.
    
    See Also:
    
    AvailabilityZoneOptInStatus
  - optInStatusAsString
```
public final String optInStatusAsString()
```
    For Availability Zones, this parameter always has the value of opt-in-not-required.
    
    For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are opted-in and not-opted-in.
    
    If the service returns an enum value that is not available in the current SDK version, optInStatus will return AvailabilityZoneOptInStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from optInStatusAsString().
    
    Returns:
    
    For Availability Zones, this parameter always has the value of opt-in-not-required.
    
    For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are opted-in and not-opted-in.
    
    See Also:
    
    AvailabilityZoneOptInStatus
  - hasMessages
```
public final boolean hasMessages()
```
    For responses, this returns true if the service returned a value for the Messages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - messages
```
public final List<AvailabilityZoneMessage> messages()
```
    Any messages about the Availability Zone, Local Zone, or Wavelength Zone.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMessages() method.
    
    Returns:
    
    Any messages about the Availability Zone, Local Zone, or Wavelength Zone.
  - regionName
```
public final String regionName()
```
    The name of the Region.
    
    Returns:
    
    The name of the Region.
  - zoneName
```
public final String zoneName()
```
    The name of the Availability Zone, Local Zone, or Wavelength Zone.
    
    Returns:
    
    The name of the Availability Zone, Local Zone, or Wavelength Zone.
  - zoneId
```
public final String zoneId()
```
    The ID of the Availability Zone, Local Zone, or Wavelength Zone.
    
    Returns:
    
    The ID of the Availability Zone, Local Zone, or Wavelength Zone.
  - groupName
```
public final String groupName()
```
    The name of the zone group. For example:
    
    Availability Zones - us-east-1-zg-1
    
    Local Zones - us-west-2-lax-1
    
    Wavelength Zones - us-east-1-wl1-bos-wlz-1
    Returns:
    
    The name of the zone group. For example:
    
    Availability Zones - us-east-1-zg-1
    
    Local Zones - us-west-2-lax-1
    
    Wavelength Zones - us-east-1-wl1-bos-wlz-1
  - networkBorderGroup
```
public final String networkBorderGroup()
```
    The name of the network border group.
    
    Returns:
    
    The name of the network border group.
  - zoneType
```
public final String zoneType()
```
    The type of zone.
    
    Valid values: availability-zone | local-zone | wavelength-zone
    
    Returns:
    
    The type of zone.
    
    Valid values: availability-zone | local-zone | wavelength-zone
  - parentZoneName
```
public final String parentZoneName()
```
    The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
    
    Returns:
    
    The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
  - parentZoneId
```
public final String parentZoneId()
```
    The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
    
    Returns:
    
    The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
  - groupLongName
```
public final String groupLongName()
```
    The long name of the Availability Zone group, Local Zone group, or Wavelength Zone group.
    
    Returns:
    
    The long name of the Availability Zone group, Local Zone group, or Wavelength Zone group.
  - state
```
public final AvailabilityZoneState state()
```
    The state of the Availability Zone, Local Zone, or Wavelength Zone. The possible values are available, unavailable, and constrained.
    
    If the service returns an enum value that is not available in the current SDK version, state will return AvailabilityZoneState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the Availability Zone, Local Zone, or Wavelength Zone. The possible values are available, unavailable, and constrained.
    
    See Also:
    
    AvailabilityZoneState
  - stateAsString
```
public final String stateAsString()
```
    The state of the Availability Zone, Local Zone, or Wavelength Zone. The possible values are available, unavailable, and constrained.
    
    If the service returns an enum value that is not available in the current SDK version, state will return AvailabilityZoneState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the Availability Zone, Local Zone, or Wavelength Zone. The possible values are available, unavailable, and constrained.
    
    See Also:
    
    AvailabilityZoneState
  - toBuilder
```
public AvailabilityZone.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AvailabilityZone.Builder,AvailabilityZone>
  - builder
```
public static AvailabilityZone.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AvailabilityZone.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

Class AvailabilityZone

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

optInStatus

optInStatusAsString

hasMessages

messages

regionName

zoneName

zoneId

groupName

networkBorderGroup

zoneType

parentZoneName

parentZoneId

groupLongName

state

stateAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField