@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()
An array of 1 or more linear rings.
|
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)
An array of 1 or more linear rings.
|
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)
An array of 1 or more linear rings.
|
GeofenceGeometry |
withPolygon(List<List<Double>>... polygon)
An array of 1 or more linear rings.
|
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()
An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last
vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form:
[longitude, latitude].
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
A geofence polygon can consist of between 4 and 1,000 vertices.
[longitude, latitude].
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
A geofence polygon can consist of between 4 and 1,000 vertices.
public void setPolygon(Collection<List<List<Double>>> polygon)
An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last
vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form:
[longitude, latitude].
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
A geofence polygon can consist of between 4 and 1,000 vertices.
polygon - An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and
last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form:
[longitude, latitude].
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
A geofence polygon can consist of between 4 and 1,000 vertices.
public GeofenceGeometry withPolygon(List<List<Double>>... polygon)
An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last
vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form:
[longitude, latitude].
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
A geofence polygon 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 - An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and
last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form:
[longitude, latitude].
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
A geofence polygon can consist of between 4 and 1,000 vertices.
public GeofenceGeometry withPolygon(Collection<List<List<Double>>> polygon)
An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last
vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form:
[longitude, latitude].
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
A geofence polygon can consist of between 4 and 1,000 vertices.
polygon - An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and
last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form:
[longitude, latitude].
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
A geofence polygon can consist of between 4 and 1,000 vertices.
public String toString()
toString in class ObjectObject.toString()public GeofenceGeometry clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.