@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GeofenceGeometry extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
GeofenceGeometry() |
Modifier and Type | Method and Description |
---|---|
GeofenceGeometry |
clone() |
boolean |
equals(Object obj) |
Circle |
getCircle()
A circle on the earth, as defined by a center point and a radius.
|
List<List<List<Double>>> |
getPolygon()
A polygon is a list of linear rings which are each made up of a list of vertices.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCircle(Circle circle)
A circle on the earth, as defined by a center point and a radius.
|
void |
setPolygon(Collection<List<List<Double>>> polygon)
A polygon is a list of linear rings which are each made up of a list of vertices.
|
String |
toString()
Returns a string representation of this object.
|
GeofenceGeometry |
withCircle(Circle circle)
A circle on the earth, as defined by a center point and a radius.
|
GeofenceGeometry |
withPolygon(Collection<List<List<Double>>> polygon)
A polygon is a list of linear rings which are each made up of a list of vertices.
|
GeofenceGeometry |
withPolygon(List<List<Double>>... polygon)
A polygon is a list of linear rings which are each made up of a list of vertices.
|
public void setCircle(Circle circle)
A circle on the earth, as defined by a center point and a radius.
circle
- A circle on the earth, as defined by a center point and a radius.public Circle getCircle()
A circle on the earth, as defined by a center point and a radius.
public GeofenceGeometry withCircle(Circle circle)
A circle on the earth, as defined by a center point and a radius.
circle
- A circle on the earth, as defined by a center point and a radius.public List<List<List<Double>>> getPolygon()
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.
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.
public void setPolygon(Collection<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.
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.
public GeofenceGeometry withPolygon(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.
NOTE: This method appends the values to the existing list (if any). Use
setPolygon(java.util.Collection)
or withPolygon(java.util.Collection)
if you want to override
the existing values.
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.
public GeofenceGeometry withPolygon(Collection<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.
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.
public String toString()
toString
in class Object
Object.toString()
public GeofenceGeometry clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.