Skip to content

ForecastGeofenceEventsRequest

Source code in docs_src/capo_location/types/forecast_geofence_events_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class ForecastGeofenceEventsRequest(TypedDict, closed=True):
    collection_name: "capo_location.types.resource_name.ResourceName"
    """<p>The name of the geofence collection.</p>"""
    device_state: "capo_location.types.forecast_geofence_events_device_state.ForecastGeofenceEventsDeviceState"
    """<p>Represents the device's state, including its current position and speed. When speed is omitted, this API performs a <i>containment check</i>. The <i>containment check</i> operation returns <code>IDLE</code> events for geofences where the device is currently inside of, but no other events.</p>"""
    time_horizon_minutes: NotRequired["float"]
    """<p>The forward-looking time window for forecasting, specified in minutes. The API only returns events that are predicted to occur within this time horizon. When no value is specified, this API performs a <i>containment check</i>. The <i>containment check</i> operation returns <code>IDLE</code> events for geofences where the device is currently inside of, but no other events.</p>"""
    distance_unit: NotRequired["capo_location.types.distance_unit.DistanceUnit"]
    """<p>The distance unit used for the <code>NearestDistance</code> property returned in a forecasted event. The measurement system must match for <code>DistanceUnit</code> and <code>SpeedUnit</code>; if <code>Kilometers</code> is specified for <code>DistanceUnit</code>, then <code>SpeedUnit</code> must be <code>KilometersPerHour</code>. </p> <p>Default Value: <code>Kilometers</code> </p>"""
    speed_unit: NotRequired["capo_location.types.speed_unit.SpeedUnit"]
    """<p>The speed unit for the device captured by the device state. The measurement system must match for <code>DistanceUnit</code> and <code>SpeedUnit</code>; if <code>Kilometers</code> is specified for <code>DistanceUnit</code>, then <code>SpeedUnit</code> must be <code>KilometersPerHour</code>.</p> <p>Default Value: <code>KilometersPerHour</code>.</p>"""
    next_token: NotRequired["capo_location.types.large_token.LargeToken"]
    """<p>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.</p> <p>Default value: <code>null</code> </p>"""
    max_results: NotRequired["int"]
    """<p>An optional limit for the number of resources returned in a single call.</p> <p>Default value: <code>20</code> </p>"""

collection_name instance-attribute 

collection_name: ResourceName

The name of the geofence collection.

device_state instance-attribute 

device_state: ForecastGeofenceEventsDeviceState

Represents the device's state, including its current position and speed. When speed is omitted, this API performs a containment check. The containment check operation returns IDLE events for geofences where the device is currently inside of, but no other events.

distance_unit instance-attribute 

distance_unit: NotRequired[DistanceUnit]

The distance unit used for the NearestDistance property returned in a forecasted event. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: Kilometers

max_results instance-attribute 

max_results: NotRequired[int]

An optional limit for the number of resources returned in a single call.

Default value: 20

next_token instance-attribute 

next_token: NotRequired[LargeToken]

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

speed_unit instance-attribute 

speed_unit: NotRequired[SpeedUnit]

The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: KilometersPerHour.

time_horizon_minutes instance-attribute 

time_horizon_minutes: NotRequired[float]

The forward-looking time window for forecasting, specified in minutes. The API only returns events that are predicted to occur within this time horizon. When no value is specified, this API performs a containment check. The containment check operation returns IDLE events for geofences where the device is currently inside of, but no other events.