software.amazon.awssdk.services.ec2.model

Class DescribeAvailabilityZonesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.DescribeAvailabilityZonesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAvailabilityZonesRequest.Builder,DescribeAvailabilityZonesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeAvailabilityZonesRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeAvailabilityZonesRequest.Builder,DescribeAvailabilityZonesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeAvailabilityZonesRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	allAvailabilityZones() Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
static DescribeAvailabilityZonesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters() The filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
boolean	hasZoneIds() For responses, this returns true if the service returned a value for the ZoneIds property.
boolean	hasZoneNames() For responses, this returns true if the service returned a value for the ZoneNames property.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAvailabilityZonesRequest.Builder>	serializableBuilderClass()
DescribeAvailabilityZonesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	zoneIds() The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
List<String>	zoneNames() The names of the Availability Zones, Local Zones, and Wavelength Zones.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters 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.

filters

public final List<Filter> filters()

The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• message - The Zone message.

• opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).

• parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• region-name - The name of the Region for the Zone (for example, us-east-1).

• state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone ( available).

• zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-type - The type of zone (availability-zone | local-zone | 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 hasFilters() method.

Returns:

The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• message - The Zone message.

• opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).

• parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• region-name - The name of the Region for the Zone (for example, us-east-1).

• state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone ( available).

• zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).

hasZoneNames

public final boolean hasZoneNames()

For responses, this returns true if the service returned a value for the ZoneNames 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.

zoneNames

public final List<String> zoneNames()

The names of the Availability Zones, Local Zones, and Wavelength Zones.

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 hasZoneNames() method.

Returns:

The names of the Availability Zones, Local Zones, and Wavelength Zones.

hasZoneIds

public final boolean hasZoneIds()

For responses, this returns true if the service returned a value for the ZoneIds 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.

zoneIds

public final List<String> zoneIds()

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

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 hasZoneIds() method.

Returns:

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

allAvailabilityZones

public final Boolean allAvailabilityZones()

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

Returns:

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

toBuilder

public DescribeAvailabilityZonesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAvailabilityZonesRequest.Builder,DescribeAvailabilityZonesRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeAvailabilityZonesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeAvailabilityZonesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo