Class GeoProximityLocation

java.lang.Object
software.amazon.awssdk.services.route53.model.GeoProximityLocation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<GeoProximityLocation.Builder,GeoProximityLocation>
@Generated("software.amazon.awssdk:codegen") public final class GeoProximityLocation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GeoProximityLocation.Builder,GeoProximityLocation>

(Resource record sets only): A complex type that lets you specify where your resources are located. Only one of LocalZoneGroup, Coordinates, or Amazon Web ServicesRegion is allowed per request at a time.

For more information about geoproximity routing, see Geoproximity routing in the Amazon Route 53 Developer Guide.

See Also:

  • Method Details

    • awsRegion

      public final String awsRegion()

      The Amazon Web Services Region the resource you are directing DNS traffic to, is in.

      Returns:
      The Amazon Web Services Region the resource you are directing DNS traffic to, is in.

    • localZoneGroup

      public final String localZoneGroup()

      Specifies an Amazon Web Services Local Zone Group.

      A local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is us-east-1-bue-1a the Local Zone Group is us-east-1-bue-1.

      You can identify the Local Zones Group for a specific Local Zone by using the describe-availability-zones CLI command:

      This command returns: "GroupName": "us-west-2-den-1", specifying that the Local Zone us-west-2-den-1a belongs to the Local Zone Group us-west-2-den-1.

      Returns:
      Specifies an Amazon Web Services Local Zone Group.

      A local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is us-east-1-bue-1a the Local Zone Group is us-east-1-bue-1.

      You can identify the Local Zones Group for a specific Local Zone by using the describe-availability-zones CLI command:

      This command returns: "GroupName": "us-west-2-den-1", specifying that the Local Zone us-west-2-den-1a belongs to the Local Zone Group us-west-2-den-1.

    • coordinates

      public final Coordinates coordinates()

      Contains the longitude and latitude for a geographic region.

      Returns:
      Contains the longitude and latitude for a geographic region.

    • bias

      public final Integer bias()

      The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource.

      To use Bias to change the size of the geographic region, specify the applicable value for the bias:

      • To expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions.

      • To shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions.

      Returns:
      The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource.

      To use Bias to change the size of the geographic region, specify the applicable value for the bias:

      • To expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions.

      • To shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions.

    • toBuilder

      public GeoProximityLocation.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<GeoProximityLocation.Builder,GeoProximityLocation>
      Returns:
      a builder for type T

    • builder

      public static GeoProximityLocation.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.