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 and Local 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() Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasZoneIds() Returns true if the ZoneIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasZoneNames() Returns true if the ZoneNames 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<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 Zones.
List<String>	zoneNames() The names of the 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 boolean hasFilters()

Returns true if the Filters 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.

filters

public 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).

• message - The Zone message.

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

• The ID of the zone that handles some of the Local 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 or Local Zone (available | information | impaired | unavailable).

• zone-id - The ID of the Availability Zone (for example, use1-az1) or the Local Zone (for example, use usw2-lax1-az1).

• zone-type - The type of zone, for example, local-zone.

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

• zone-type - The type of zone, for example, local-zone.

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

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

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

• message - The Zone message.

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

• The ID of the zone that handles some of the Local 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 or Local Zone (available | information | impaired | unavailable).

• zone-id - The ID of the Availability Zone (for example, use1-az1) or the Local Zone (for example, use usw2-lax1-az1).

• zone-type - The type of zone, for example, local-zone.

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

• zone-type - The type of zone, for example, local-zone.

hasZoneNames

public boolean hasZoneNames()

Returns true if the ZoneNames 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.

zoneNames

public List<String> zoneNames()

The names of the Zones.

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

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

Returns:

The names of the Zones.

hasZoneIds

public boolean hasZoneIds()

Returns true if the ZoneIds 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.

zoneIds

public List<String> zoneIds()

The IDs of the Zones.

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

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

Returns:

The IDs of the Zones.

allAvailabilityZones

public Boolean allAvailabilityZones()

Include all Availability Zones and Local 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 and Local 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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo