software.amazon.awssdk.services.lightsail.model

Class Region

java.lang.Object

software.amazon.awssdk.services.lightsail.model.Region

All Implemented Interfaces:

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

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

Describes the Amazon Web Services Region.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Region.Builder

Method Summary

Modifier and Type	Method and Description
List<AvailabilityZone>	availabilityZones() The Availability Zones.
static Region.Builder	builder()
String	continentCode() The continent code (e.g., NA, meaning North America).
String	description() The description of the Amazon Web Services Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).
String	displayName() The display name (e.g., Ohio).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAvailabilityZones() For responses, this returns true if the service returned a value for the AvailabilityZones property.
int	hashCode()
boolean	hasRelationalDatabaseAvailabilityZones() For responses, this returns true if the service returned a value for the RelationalDatabaseAvailabilityZones property.
RegionName	name() The region name (e.g., us-east-2).
String	nameAsString() The region name (e.g., us-east-2).
List<AvailabilityZone>	relationalDatabaseAvailabilityZones() The Availability Zones for databases.
List<SdkField<?>>	sdkFields()
static Class<? extends Region.Builder>	serializableBuilderClass()
Region.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

continentCode

public final String continentCode()

The continent code (e.g., NA, meaning North America).

Returns:

The continent code (e.g., NA, meaning North America).

description

public final String description()

The description of the Amazon Web Services Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).

Returns:

The description of the Amazon Web Services Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).

displayName

public final String displayName()

The display name (e.g., Ohio).

Returns:

The display name (e.g., Ohio).

name

public final RegionName name()

The region name (e.g., us-east-2).

If the service returns an enum value that is not available in the current SDK version, name will return RegionName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The region name (e.g., us-east-2).

See Also:

RegionName

nameAsString

public final String nameAsString()

The region name (e.g., us-east-2).

If the service returns an enum value that is not available in the current SDK version, name will return RegionName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The region name (e.g., us-east-2).

See Also:

RegionName

hasAvailabilityZones

public final boolean hasAvailabilityZones()

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

availabilityZones

public final List<AvailabilityZone> availabilityZones()

The Availability Zones. Follows the format us-east-2a (case-sensitive).

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

Returns:

The Availability Zones. Follows the format us-east-2a (case-sensitive).

hasRelationalDatabaseAvailabilityZones

public final boolean hasRelationalDatabaseAvailabilityZones()

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

relationalDatabaseAvailabilityZones

public final List<AvailabilityZone> relationalDatabaseAvailabilityZones()

The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).

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

Returns:

The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).

toBuilder

public Region.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Region.Builder,Region>

builder

public static Region.Builder builder()

serializableBuilderClass

public static Class<? extends Region.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