Class AvailabilityZone
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AvailabilityZone.Builder,
AvailabilityZone>
Describes Availability Zones, Local Zones, and Wavelength Zones.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AvailabilityZone.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final String
For Availability Zones, this parameter has the same value as the Region name.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Messages property.final List
<AvailabilityZoneMessage> messages()
Any messages about the Availability Zone, Local Zone, or Wavelength Zone.final String
The name of the network border group.For Availability Zones, this parameter always has the value ofopt-in-not-required
.final String
For Availability Zones, this parameter always has the value ofopt-in-not-required
.final String
The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.final String
The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.final String
The name of the Region.static Class
<? extends AvailabilityZone.Builder> final AvailabilityZoneState
state()
The state of the Availability Zone, Local Zone, or Wavelength Zone.final String
The state of the Availability Zone, Local Zone, or Wavelength Zone.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
zoneId()
The ID of the Availability Zone, Local Zone, or Wavelength Zone.final String
zoneName()
The name of the Availability Zone, Local Zone, or Wavelength Zone.final String
zoneType()
The type of zone.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
state
The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always
available
.If the service returns an enum value that is not available in the current SDK version,
state
will returnAvailabilityZoneState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always
available
. - See Also:
-
stateAsString
The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always
available
.If the service returns an enum value that is not available in the current SDK version,
state
will returnAvailabilityZoneState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always
available
. - See Also:
-
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
, andnot-opted-in
.If the service returns an enum value that is not available in the current SDK version,
optInStatus
will returnAvailabilityZoneOptInStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoptInStatusAsString()
.- 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
, andnot-opted-in
. - See Also:
-
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
, andnot-opted-in
.If the service returns an enum value that is not available in the current SDK version,
optInStatus
will returnAvailabilityZoneOptInStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoptInStatusAsString()
.- 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
, andnot-opted-in
. - See Also:
-
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 theisEmpty()
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
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
The name of the Region.
- Returns:
- The name of the Region.
-
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
The ID of the Availability Zone, Local Zone, or Wavelength Zone.
- Returns:
- The ID of the Availability Zone, Local Zone, or Wavelength Zone.
-
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
.For Wavelength Zones, the name of the associated group, for example
us-east-1-wl1-bos-wlz-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
.For Wavelength Zones, the name of the associated group, for example
us-east-1-wl1-bos-wlz-1
.
-
networkBorderGroup
The name of the network border group.
- Returns:
- The name of the network border group.
-
zoneType
The type of zone. The valid values are
availability-zone
,local-zone
, andwavelength-zone
.- Returns:
- The type of zone. The valid values are
availability-zone
,local-zone
, andwavelength-zone
.
-
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
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.
-
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 interfaceToCopyableBuilder<AvailabilityZone.Builder,
AvailabilityZone> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-