Interface GeofenceGeometry.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<GeofenceGeometry.Builder,
,GeofenceGeometry> SdkBuilder<GeofenceGeometry.Builder,
,GeofenceGeometry> SdkPojo
- Enclosing class:
GeofenceGeometry
-
Method Summary
Modifier and TypeMethodDescriptiondefault GeofenceGeometry.Builder
circle
(Consumer<Circle.Builder> circle) A circle on the earth, as defined by a center point and a radius.A circle on the earth, as defined by a center point and a radius.Geobuf is a compact binary encoding for geographic data that provides lossless compression of GeoJSON polygons.multiPolygon
(Collection<? extends Collection<? extends Collection<? extends Collection<Double>>>> multiPolygon) AMultiPolygon
is a list of up to 250Polygon
elements which represent the shape of a geofence.multiPolygon
(Collection<? extends Collection<? extends Collection<Double>>>... multiPolygon) AMultiPolygon
is a list of up to 250Polygon
elements which represent the shape of a geofence.polygon
(Collection<? extends Collection<? extends Collection<Double>>> polygon) APolygon
is a list of up to 250 linear rings which represent the shape of a geofence.polygon
(Collection<? extends Collection<Double>>... polygon) APolygon
is a list of up to 250 linear rings which represent the shape of a geofence.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
polygon
GeofenceGeometry.Builder polygon(Collection<? extends Collection<? extends Collection<Double>>> polygon) A
Polygon
is a list of up to 250 linear rings which represent the shape of a geofence. This list must include 1 exterior ring (representing the outer perimeter of the geofence), and can optionally include up to 249 interior rings (representing polygonal spaces within the perimeter, which are excluded from the geofence area).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 represented as an array of doubles of length 2:
[longitude, latitude]
.Each linear ring is represented as an array of arrays of doubles (
[[longitude, latitude], [longitude, latitude], ...]
). The vertices for the exterior ring must be listed in counter-clockwise sequence. Vertices for all interior rings must be listed in clockwise sequence.The list of linear rings that describe the entire
Polygon
is represented as an array of arrays of arrays of doubles ([[[longitude, latitude], [longitude, latitude], ...], [[longitude, latitude], [longitude, latitude], ...], ...]
). The exterior ring must be listed first, before any interior rings.The following additional requirements and limitations apply to geometries defined using the
Polygon
parameter:-
The entire
Polygon
must consist of no more than 1,000 vertices, including all vertices from the exterior ring and all interior rings. -
Rings must not touch or cross each other.
-
All interior rings must be fully contained within the exterior ring.
-
Interior rings must not contain other interior rings.
-
No ring is permitted to intersect itself.
- Parameters:
polygon
- APolygon
is a list of up to 250 linear rings which represent the shape of a geofence. This list must include 1 exterior ring (representing the outer perimeter of the geofence), and can optionally include up to 249 interior rings (representing polygonal spaces within the perimeter, which are excluded from the geofence area).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 represented as an array of doubles of length 2:
[longitude, latitude]
.Each linear ring is represented as an array of arrays of doubles (
[[longitude, latitude], [longitude, latitude], ...]
). The vertices for the exterior ring must be listed in counter-clockwise sequence. Vertices for all interior rings must be listed in clockwise sequence.The list of linear rings that describe the entire
Polygon
is represented as an array of arrays of arrays of doubles ([[[longitude, latitude], [longitude, latitude], ...], [[longitude, latitude], [longitude, latitude], ...], ...]
). The exterior ring must be listed first, before any interior rings.The following additional requirements and limitations apply to geometries defined using the
Polygon
parameter:-
The entire
Polygon
must consist of no more than 1,000 vertices, including all vertices from the exterior ring and all interior rings. -
Rings must not touch or cross each other.
-
All interior rings must be fully contained within the exterior ring.
-
Interior rings must not contain other interior rings.
-
No ring is permitted to intersect itself.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
polygon
A
Polygon
is a list of up to 250 linear rings which represent the shape of a geofence. This list must include 1 exterior ring (representing the outer perimeter of the geofence), and can optionally include up to 249 interior rings (representing polygonal spaces within the perimeter, which are excluded from the geofence area).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 represented as an array of doubles of length 2:
[longitude, latitude]
.Each linear ring is represented as an array of arrays of doubles (
[[longitude, latitude], [longitude, latitude], ...]
). The vertices for the exterior ring must be listed in counter-clockwise sequence. Vertices for all interior rings must be listed in clockwise sequence.The list of linear rings that describe the entire
Polygon
is represented as an array of arrays of arrays of doubles ([[[longitude, latitude], [longitude, latitude], ...], [[longitude, latitude], [longitude, latitude], ...], ...]
). The exterior ring must be listed first, before any interior rings.The following additional requirements and limitations apply to geometries defined using the
Polygon
parameter:-
The entire
Polygon
must consist of no more than 1,000 vertices, including all vertices from the exterior ring and all interior rings. -
Rings must not touch or cross each other.
-
All interior rings must be fully contained within the exterior ring.
-
Interior rings must not contain other interior rings.
-
No ring is permitted to intersect itself.
- Parameters:
polygon
- APolygon
is a list of up to 250 linear rings which represent the shape of a geofence. This list must include 1 exterior ring (representing the outer perimeter of the geofence), and can optionally include up to 249 interior rings (representing polygonal spaces within the perimeter, which are excluded from the geofence area).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 represented as an array of doubles of length 2:
[longitude, latitude]
.Each linear ring is represented as an array of arrays of doubles (
[[longitude, latitude], [longitude, latitude], ...]
). The vertices for the exterior ring must be listed in counter-clockwise sequence. Vertices for all interior rings must be listed in clockwise sequence.The list of linear rings that describe the entire
Polygon
is represented as an array of arrays of arrays of doubles ([[[longitude, latitude], [longitude, latitude], ...], [[longitude, latitude], [longitude, latitude], ...], ...]
). The exterior ring must be listed first, before any interior rings.The following additional requirements and limitations apply to geometries defined using the
Polygon
parameter:-
The entire
Polygon
must consist of no more than 1,000 vertices, including all vertices from the exterior ring and all interior rings. -
Rings must not touch or cross each other.
-
All interior rings must be fully contained within the exterior ring.
-
Interior rings must not contain other interior rings.
-
No ring is permitted to intersect itself.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
-
circle
A circle on the earth, as defined by a center point and a radius.
This is a convenience method that creates an instance of theCircle.Builder
avoiding the need to create one manually viaCircle.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocircle(Circle)
.- Parameters:
circle
- a consumer that will call methods onCircle.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
geobuf
Geobuf is a compact binary encoding for geographic data that provides lossless compression of GeoJSON polygons. The Geobuf must be Base64-encoded.
This parameter can contain a Geobuf-encoded GeoJSON geometry object of type
Polygon
ORMultiPolygon
. For more information and specific configuration requirements for these object types, see Polygon and MultiPolygon.The following limitations apply specifically to geometries defined using the
Geobuf
parameter, and supercede the corresponding limitations of thePolygon
andMultiPolygon
parameters:-
A
Polygon
inGeobuf
format can have up to 25,000 rings and up to 100,000 total vertices, including all vertices from all component rings. -
A
MultiPolygon
inGeobuf
format can contain up to 10,000Polygons
and up to 100,000 total vertices, including all vertices from all componentPolygons
.
- Parameters:
geobuf
- Geobuf is a compact binary encoding for geographic data that provides lossless compression of GeoJSON polygons. The Geobuf must be Base64-encoded.This parameter can contain a Geobuf-encoded GeoJSON geometry object of type
Polygon
ORMultiPolygon
. For more information and specific configuration requirements for these object types, see Polygon and MultiPolygon.The following limitations apply specifically to geometries defined using the
Geobuf
parameter, and supercede the corresponding limitations of thePolygon
andMultiPolygon
parameters:-
A
Polygon
inGeobuf
format can have up to 25,000 rings and up to 100,000 total vertices, including all vertices from all component rings. -
A
MultiPolygon
inGeobuf
format can contain up to 10,000Polygons
and up to 100,000 total vertices, including all vertices from all componentPolygons
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
multiPolygon
GeofenceGeometry.Builder multiPolygon(Collection<? extends Collection<? extends Collection<? extends Collection<Double>>>> multiPolygon) A
MultiPolygon
is a list of up to 250Polygon
elements which represent the shape of a geofence. ThePolygon
components of aMultiPolygon
geometry can define separate geographical areas that are considered part of the same geofence, perimeters of larger exterior areas with smaller interior spaces that are excluded from the geofence, or some combination of these use cases to form complex geofence boundaries.For more information and specific configuration requirements for the
Polygon
components that form aMultiPolygon
, see Polygon.The following additional requirements and limitations apply to geometries defined using the
MultiPolygon
parameter:-
The entire
MultiPolygon
must consist of no more than 1,000 vertices, including all vertices from all componentPolygons
. -
Each edge of a component
Polygon
must intersect no more than 5 edges from otherPolygons
. Parallel edges that are shared but do not cross are not counted toward this limit. -
The total number of intersecting edges of component
Polygons
must be no more than 100,000. Parallel edges that are shared but do not cross are not counted toward this limit.
- Parameters:
multiPolygon
- AMultiPolygon
is a list of up to 250Polygon
elements which represent the shape of a geofence. ThePolygon
components of aMultiPolygon
geometry can define separate geographical areas that are considered part of the same geofence, perimeters of larger exterior areas with smaller interior spaces that are excluded from the geofence, or some combination of these use cases to form complex geofence boundaries.For more information and specific configuration requirements for the
Polygon
components that form aMultiPolygon
, see Polygon.The following additional requirements and limitations apply to geometries defined using the
MultiPolygon
parameter:-
The entire
MultiPolygon
must consist of no more than 1,000 vertices, including all vertices from all componentPolygons
. -
Each edge of a component
Polygon
must intersect no more than 5 edges from otherPolygons
. Parallel edges that are shared but do not cross are not counted toward this limit. -
The total number of intersecting edges of component
Polygons
must be no more than 100,000. Parallel edges that are shared but do not cross are not counted toward this limit.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
multiPolygon
GeofenceGeometry.Builder multiPolygon(Collection<? extends Collection<? extends Collection<Double>>>... multiPolygon) A
MultiPolygon
is a list of up to 250Polygon
elements which represent the shape of a geofence. ThePolygon
components of aMultiPolygon
geometry can define separate geographical areas that are considered part of the same geofence, perimeters of larger exterior areas with smaller interior spaces that are excluded from the geofence, or some combination of these use cases to form complex geofence boundaries.For more information and specific configuration requirements for the
Polygon
components that form aMultiPolygon
, see Polygon.The following additional requirements and limitations apply to geometries defined using the
MultiPolygon
parameter:-
The entire
MultiPolygon
must consist of no more than 1,000 vertices, including all vertices from all componentPolygons
. -
Each edge of a component
Polygon
must intersect no more than 5 edges from otherPolygons
. Parallel edges that are shared but do not cross are not counted toward this limit. -
The total number of intersecting edges of component
Polygons
must be no more than 100,000. Parallel edges that are shared but do not cross are not counted toward this limit.
- Parameters:
multiPolygon
- AMultiPolygon
is a list of up to 250Polygon
elements which represent the shape of a geofence. ThePolygon
components of aMultiPolygon
geometry can define separate geographical areas that are considered part of the same geofence, perimeters of larger exterior areas with smaller interior spaces that are excluded from the geofence, or some combination of these use cases to form complex geofence boundaries.For more information and specific configuration requirements for the
Polygon
components that form aMultiPolygon
, see Polygon.The following additional requirements and limitations apply to geometries defined using the
MultiPolygon
parameter:-
The entire
MultiPolygon
must consist of no more than 1,000 vertices, including all vertices from all componentPolygons
. -
Each edge of a component
Polygon
must intersect no more than 5 edges from otherPolygons
. Parallel edges that are shared but do not cross are not counted toward this limit. -
The total number of intersecting edges of component
Polygons
must be no more than 100,000. Parallel edges that are shared but do not cross are not counted toward this limit.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-