Skip to content

PutGeofenceRequest

Source code in docs_src/capo_location/types/put_geofence_request.py 
16
17
18
19
20
21
22
23
24
class PutGeofenceRequest(TypedDict, closed=True):
    collection_name: "capo_location.types.resource_name.ResourceName"
    """<p>The geofence collection to store the geofence in.</p>"""
    geofence_id: "capo_location.types.id.Id"
    """<p>An identifier for the geofence. For example, <code>ExampleGeofence-1</code>.</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>"""

collection_name instance-attribute 

collection_name: ResourceName

The geofence collection to store the geofence in.

geofence_id instance-attribute 

geofence_id: Id

An identifier for the geofence. For example, ExampleGeofence-1.

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.