GeofenceGeometry (AWS Java SDK for Amazon Location 1.12.632 API)

java.lang.Object
- com.amazonaws.services.location.model.GeofenceGeometry

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GeofenceGeometry()

Constructors
Constructor and Description
`GeofenceGeometry()`

Method Summary

All Methods Instance Methods Concrete Methods
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)`
`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.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GeofenceGeometry
```
public GeofenceGeometry()
```
- Method Detail
  - setCircle
```
public void setCircle(Circle circle)
```
    A circle on the earth, as defined by a center point and a radius.
    
    Parameters:
    
    circle - A circle on the earth, as defined by a center point and a radius.
  - getCircle
```
public Circle getCircle()
```
    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.
  - withCircle
```
public GeofenceGeometry withCircle(Circle circle)
```
    A circle on the earth, as defined by a center point and a radius.
    
    Parameters:
    
    circle - A circle on the earth, as defined by a center point and a radius.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPolygon
```
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.
    
    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.
  - setPolygon
```
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.
    
    Parameters:
    
    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.
  - withPolygon
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPolygon
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GeofenceGeometry clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class GeofenceGeometry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GeofenceGeometry

Method Detail

setCircle

getCircle

withCircle

getPolygon

setPolygon

withPolygon

withPolygon

toString

equals

hashCode

clone

marshall