Class GeofenceGeometry

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

Contains the geofence geometry details.

A geofence geometry is made up of either a polygon or a circle. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

Amazon Location doesn't currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian.

See Also:

  • Method Details

    • hasPolygon

      public final boolean hasPolygon()
      For responses, this returns true if the service returned a value for the Polygon 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.

    • polygon

      public final List<List<List<Double>>> polygon()

      A polygon is a list of linear rings which are each made up of a list of vertices.

      Each vertex is a 2-dimensional point of the form: [longitude, latitude]. This is represented as an array of doubles of length 2 (so [double, double]).

      An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ( [[double, double], ...]).

      A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ( [[[double, double], ...], ...]).

      A linear ring for use in geofences can consist of between 4 and 1,000 vertices.

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

      Returns:
      A polygon is a list of linear rings which are each made up of a list of vertices.

      Each vertex is a 2-dimensional point of the form: [longitude, latitude]. This is represented as an array of doubles of length 2 (so [double, double]).

      An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ([[double, double], ...]).

      A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ( [[[double, double], ...], ...]).

      A linear ring for use in geofences can consist of between 4 and 1,000 vertices.

    • circle

      public final Circle circle()

      A circle on the earth, as defined by a center point and a radius.

      Returns:
      A circle on the earth, as defined by a center point and a radius.

    • geobuf

      public final SdkBytes geobuf()

      Geobuf is a compact binary encoding for geographic data that provides lossless compression of GeoJSON polygons. The Geobuf must be Base64-encoded.

      A polygon in Geobuf format can have up to 100,000 vertices.

      Returns:
      Geobuf is a compact binary encoding for geographic data that provides lossless compression of GeoJSON polygons. The Geobuf must be Base64-encoded.

      A polygon in Geobuf format can have up to 100,000 vertices.

    • toBuilder

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

    • builder

      public static GeofenceGeometry.Builder builder()

    • serializableBuilderClass

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