Skip to content

BatchPutGeofenceRequestEntry

Source code in docs_src/capo_location/types/batch_put_geofence_request_entry.py 
15
16
17
18
19
20
21
class BatchPutGeofenceRequestEntry(TypedDict, closed=True):
    geofence_id: "capo_location.types.id.Id"
    """<p>The identifier for the geofence to be stored in a given geofence collection.</p>"""
    geometry: "capo_location.types.geofence_geometry.GeofenceGeometry"
    """<p>Contains the details to specify the position of the geofence. Can be a circle, a polygon, or a multipolygon. <code>Polygon</code> and <code>MultiPolygon</code> geometries can be defined using their respective parameters, or encoded in Geobuf format using the <code>Geobuf</code> parameter. Including multiple geometry types in the same request will return a validation error.</p> <note> <p>The geofence <code>Polygon</code> and <code>MultiPolygon</code> formats support a maximum of 1,000 total vertices. The <code>Geobuf</code> format supports a maximum of 100,000 vertices.</p> </note>"""
    geofence_properties: NotRequired["capo_location.types.property_map.PropertyMap"]
    """<p>Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.</p> <p>Format: <code>"key" : "value"</code> </p>"""

geofence_id instance-attribute 

geofence_id: Id

The identifier for the geofence to be stored in a given geofence collection.

geofence_properties instance-attribute 

geofence_properties: NotRequired[PropertyMap]

Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: "key" : "value"

geometry instance-attribute 

geometry: GeofenceGeometry

Contains the details to specify the position of the geofence. Can be a circle, a polygon, or a multipolygon. Polygon and MultiPolygon geometries can be defined using their respective parameters, or encoded in Geobuf format using the Geobuf parameter. Including multiple geometry types in the same request will return a validation error.

The geofence Polygon and MultiPolygon formats support a maximum of 1,000 total vertices. The Geobuf format supports a maximum of 100,000 vertices.