software.amazon.awssdk.services.ec2.model

Class AvailabilityZone

java.lang.Object

software.amazon.awssdk.services.ec2.model.AvailabilityZone

All Implemented Interfaces:

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

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

Describes a Zone.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AvailabilityZone.Builder

Method Summary

Modifier and Type	Method and Description
static AvailabilityZone.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupName() For Availability Zones, this parameter has the same value as the Region name.
int	hashCode()
boolean	hasMessages() Returns true if the Messages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<AvailabilityZoneMessage>	messages() Any messages about the Zone.
String	networkBorderGroup() The name of the location from which the address is advertised.
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 control plane operations, such as API calls.
String	parentZoneName() The name of the zone that handles some of the Local Zone control plane operations, such as API calls.
String	regionName() The name of the Region.
List<SdkField<?>>	sdkFields()
static Class<? extends AvailabilityZone.Builder>	serializableBuilderClass()
AvailabilityZoneState	state() The state of the Zone.
String	stateAsString() The state of the Zone.
AvailabilityZone.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	zoneId() The ID of the Zone.
String	zoneName() The name of the 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

state

public AvailabilityZoneState state()

The state of the Zone.

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

See Also:

AvailabilityZoneState

stateAsString

public String stateAsString()

The state of the Zone.

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

See Also:

AvailabilityZoneState

optInStatus

public AvailabilityZoneOptInStatus optInStatus()

For Availability Zones, this parameter always has the value of opt-in-not-required.

For Local 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, this parameter is the opt in status. The possible values are opted-in, and not-opted-in.

See Also:

AvailabilityZoneOptInStatus

optInStatusAsString

public String optInStatusAsString()

For Availability Zones, this parameter always has the value of opt-in-not-required.

For Local 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, this parameter is the opt in status. The possible values are opted-in, and not-opted-in.

See Also:

AvailabilityZoneOptInStatus

hasMessages

public boolean hasMessages()

Returns true if the Messages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

messages

public List<AvailabilityZoneMessage> messages()

Any messages about the Zone.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasMessages() to see if a value was sent in this field.

Returns:

Any messages about the Zone.

regionName

public String regionName()

The name of the Region.

Returns:

The name of the Region.

zoneName

public String zoneName()

The name of the Zone.

Returns:

The name of the Zone.

zoneId

public String zoneId()

The ID of the Zone.

Returns:

The ID of the Zone.

groupName

public String groupName()

For Availability Zones, this parameter has the same value as the Region name.

For Local Zones, the name of the associated group, for example us-west-2-lax-1.

Returns:

For Availability Zones, this parameter has the same value as the Region name.

For Local Zones, the name of the associated group, for example us-west-2-lax-1.

networkBorderGroup

public String networkBorderGroup()

The name of the location from which the address is advertised.

Returns:

The name of the location from which the address is advertised.

zoneType

public String zoneType()

The type of zone. The valid values are availability-zone and local-zone.

Returns:

The type of zone. The valid values are availability-zone and local-zone.

parentZoneName

public String parentZoneName()

The name of the zone that handles some of the Local Zone control plane operations, such as API calls.

Returns:

The name of the zone that handles some of the Local Zone control plane operations, such as API calls.

parentZoneId

public String parentZoneId()

The ID of the zone that handles some of the Local Zone control plane operations, such as API calls.

Returns:

The ID of the zone that handles some of the Local Zone control plane operations, such as API calls.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo