Package 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("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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<Region.Builder,Region>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.