Skip to content

GetGeofenceResponse

Source code in docs_src/capo_location/types/get_geofence_response.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class GetGeofenceResponse(TypedDict, closed=True):
    geofence_id: "capo_location.types.id.Id"
    """<p>The geofence identifier.</p>"""
    geometry: "capo_location.types.geofence_geometry.GeofenceGeometry"
    """<p>Contains the geofence geometry details describing the position of the geofence. Can be a circle, a polygon, or a multipolygon.</p>"""
    status: "str"
    """<p>Identifies the state of the geofence. A geofence will hold one of the following states:</p> <ul> <li> <p> <code>ACTIVE</code> — The geofence has been indexed by the system. </p> </li> <li> <p> <code>PENDING</code> — The geofence is being processed by the system.</p> </li> <li> <p> <code>FAILED</code> — The geofence failed to be indexed by the system.</p> </li> <li> <p> <code>DELETED</code> — The geofence has been deleted from the system index.</p> </li> <li> <p> <code>DELETING</code> — The geofence is being deleted from the system index.</p> </li> </ul>"""
    create_time: "capo_location.types.timestamp.Timestamp"
    """<p>The timestamp for when the geofence collection was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code> </p>"""
    update_time: "capo_location.types.timestamp.Timestamp"
    """<p>The timestamp for when the geofence collection was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code> </p>"""
    geofence_properties: NotRequired["capo_location.types.property_map.PropertyMap"]
    """<p>User defined properties of 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>"""

create_time instance-attribute 

create_time: Timestamp

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

geofence_id instance-attribute 

geofence_id: Id

The geofence identifier.

geofence_properties instance-attribute 

geofence_properties: NotRequired[PropertyMap]

User defined properties of 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 geofence geometry details describing the position of the geofence. Can be a circle, a polygon, or a multipolygon.

status instance-attribute 

status: str

Identifies the state of the geofence. A geofence will hold one of the following states:

  • ACTIVE — The geofence has been indexed by the system.

  • PENDING — The geofence is being processed by the system.

  • FAILED — The geofence failed to be indexed by the system.

  • DELETED — The geofence has been deleted from the system index.

  • DELETING — The geofence is being deleted from the system index.

update_time instance-attribute 

update_time: Timestamp

The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ