Skip to content

RouteWaypoint

Source code in docs_src/capo_geo_routes/types/route_waypoint.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class RouteWaypoint(TypedDict, closed=True):
    avoid_actions_for_distance: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p> Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    avoid_u_turns: NotRequired[
        "capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p> Avoid U-turns for calculation on highways and motorways. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    heading: "capo_geo_routes.types.heading.Heading"
    """<p> GPS Heading at the position. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    matching: NotRequired[
        "capo_geo_routes.types.route_matching_options.RouteMatchingOptions"
    ]
    """<p> Options to configure matching the provided position to the road network. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    pass_through: NotRequired[
        "capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p> If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn't split the route into different legs. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    position: "capo_geo_routes.types.position.Position"
    """<p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>"""
    side_of_street: NotRequired[
        "capo_geo_routes.types.route_side_of_street_options.RouteSideOfStreetOptions"
    ]
    """<p> Options to configure matching the provided position to a side of the street. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    stop_duration: "capo_geo_routes.types.duration_seconds.DurationSeconds"
    """<p> Duration of the stop. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p> <b>Unit</b>: <code>seconds</code> </p>"""

avoid_actions_for_distance instance-attribute 

avoid_actions_for_distance: DistanceMeters

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

avoid_u_turns instance-attribute 

avoid_u_turns: NotRequired[SensitiveBoolean]

Avoid U-turns for calculation on highways and motorways. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

heading instance-attribute 

heading: Heading

GPS Heading at the position. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

matching instance-attribute 

matching: NotRequired[RouteMatchingOptions]

Options to configure matching the provided position to the road network. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

pass_through instance-attribute 

pass_through: NotRequired[SensitiveBoolean]

If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn't split the route into different legs. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

position instance-attribute 

position: Position

Position in World Geodetic System (WGS 84) format: [longitude, latitude].

side_of_street instance-attribute 

side_of_street: NotRequired[RouteSideOfStreetOptions]

Options to configure matching the provided position to a side of the street. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

stop_duration instance-attribute 

stop_duration: DurationSeconds

Duration of the stop. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Unit: seconds