software.amazon.awssdk.services.location.model

Class GeofenceGeometry

java.lang.Object

software.amazon.awssdk.services.location.model.GeofenceGeometry

All Implemented Interfaces:

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

@Generated(value="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 either a polygon or a circle. Including both 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GeofenceGeometry.Builder

Method Summary

Modifier and Type	Method and Description
static GeofenceGeometry.Builder	builder()
Circle	circle() A circle on the earth, as defined by a center point and a radius.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPolygon() For responses, this returns true if the service returned a value for the Polygon property.
List<List<List<Double>>>	polygon() A polygon is a list of linear rings which are each made up of a list of vertices.
List<SdkField<?>>	sdkFields()
static Class<? extends GeofenceGeometry.Builder>	serializableBuilderClass()
GeofenceGeometry.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

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.

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.

toBuilder

public GeofenceGeometry.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GeofenceGeometry.Builder,GeofenceGeometry>

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)

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