Skip to content

RouteVehicleTravelStep

Source code in docs_src/capo_geo_routes/types/route_vehicle_travel_step.py
class RouteVehicleTravelStep(TypedDict, closed=True):
    continue_highway_step_details: NotRequired[
        "capo_geo_routes.types.route_continue_highway_step_details.RouteContinueHighwayStepDetails"
    ]
    """<p>Details that are specific to a Continue Highway step.</p>"""
    continue_step_details: NotRequired[
        "capo_geo_routes.types.route_continue_step_details.RouteContinueStepDetails"
    ]
    """<p>Details that are specific to a Continue step.</p>"""
    current_road: NotRequired["capo_geo_routes.types.route_road.RouteRoad"]
    """<p>Details of the current road.</p>"""
    distance: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>Distance of the step.</p>"""
    duration: "capo_geo_routes.types.duration_seconds.DurationSeconds"
    """<p>Duration of the step.</p> <p> <b>Unit</b>: <code>seconds</code> </p>"""
    enter_highway_step_details: NotRequired[
        "capo_geo_routes.types.route_enter_highway_step_details.RouteEnterHighwayStepDetails"
    ]
    """<p>Details that are specific to a Enter Highway step.</p>"""
    exit_number: NotRequired[
        "capo_geo_routes.types.localized_string_list.LocalizedStringList"
    ]
    """<p>Exit number of the road exit, if applicable.</p>"""
    exit_step_details: NotRequired[
        "capo_geo_routes.types.route_exit_step_details.RouteExitStepDetails"
    ]
    """<p>Details that are specific to a Roundabout Exit step.</p>"""
    geometry_offset: NotRequired["int"]
    """<p>Offset in the leg geometry corresponding to the start of this step.</p>"""
    instruction: NotRequired["capo_geo_routes.types.sensitive_string.SensitiveString"]
    """<p>Brief description of the step in the requested language.</p> <note> <p>Only available when the TravelStepType is Default.</p> </note>"""
    keep_step_details: NotRequired[
        "capo_geo_routes.types.route_keep_step_details.RouteKeepStepDetails"
    ]
    """<p>Details that are specific to a Keep step.</p>"""
    next_road: NotRequired["capo_geo_routes.types.route_road.RouteRoad"]
    """<p>Details of the next road. See RouteRoad for details of sub-attributes.</p>"""
    ramp_step_details: NotRequired[
        "capo_geo_routes.types.route_ramp_step_details.RouteRampStepDetails"
    ]
    """<p>Details that are specific to a Ramp step.</p>"""
    roundabout_enter_step_details: NotRequired[
        "capo_geo_routes.types.route_roundabout_enter_step_details.RouteRoundaboutEnterStepDetails"
    ]
    """<p>Details that are specific to a Roundabout Enter step.</p>"""
    roundabout_exit_step_details: NotRequired[
        "capo_geo_routes.types.route_roundabout_exit_step_details.RouteRoundaboutExitStepDetails"
    ]
    """<p>Details that are specific to a Roundabout Exit step.</p>"""
    roundabout_pass_step_details: NotRequired[
        "capo_geo_routes.types.route_roundabout_pass_step_details.RouteRoundaboutPassStepDetails"
    ]
    """<p>Details that are specific to a Roundabout Pass step.</p>"""
    signpost: NotRequired["capo_geo_routes.types.route_signpost.RouteSignpost"]
    """<p>Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.</p>"""
    turn_step_details: NotRequired[
        "capo_geo_routes.types.route_turn_step_details.RouteTurnStepDetails"
    ]
    """<p>Details that are specific to a Turn step.</p>"""
    type: "capo_geo_routes.types.route_vehicle_travel_step_type.RouteVehicleTravelStepType"
    """<p>Type of the step.</p>"""
    u_turn_step_details: NotRequired[
        "capo_geo_routes.types.route_u_turn_step_details.RouteUTurnStepDetails"
    ]
    """<p>Details that are specific to a Turn step.</p>"""

continue_highway_step_details instance-attribute

continue_highway_step_details: NotRequired[RouteContinueHighwayStepDetails]

Details that are specific to a Continue Highway step.

continue_step_details instance-attribute

continue_step_details: NotRequired[RouteContinueStepDetails]

Details that are specific to a Continue step.

current_road instance-attribute

current_road: NotRequired[RouteRoad]

Details of the current road.

distance instance-attribute

distance: DistanceMeters

Distance of the step.

duration instance-attribute

duration: DurationSeconds

Duration of the step.

Unit: seconds

enter_highway_step_details instance-attribute

enter_highway_step_details: NotRequired[RouteEnterHighwayStepDetails]

Details that are specific to a Enter Highway step.

exit_number instance-attribute

exit_number: NotRequired[LocalizedStringList]

Exit number of the road exit, if applicable.

exit_step_details instance-attribute

exit_step_details: NotRequired[RouteExitStepDetails]

Details that are specific to a Roundabout Exit step.

geometry_offset instance-attribute

geometry_offset: NotRequired[int]

Offset in the leg geometry corresponding to the start of this step.

instruction instance-attribute

instruction: NotRequired[SensitiveString]

Brief description of the step in the requested language.

Only available when the TravelStepType is Default.

keep_step_details instance-attribute

keep_step_details: NotRequired[RouteKeepStepDetails]

Details that are specific to a Keep step.

next_road instance-attribute

next_road: NotRequired[RouteRoad]

Details of the next road. See RouteRoad for details of sub-attributes.

ramp_step_details instance-attribute

ramp_step_details: NotRequired[RouteRampStepDetails]

Details that are specific to a Ramp step.

roundabout_enter_step_details instance-attribute

roundabout_enter_step_details: NotRequired[RouteRoundaboutEnterStepDetails]

Details that are specific to a Roundabout Enter step.

roundabout_exit_step_details instance-attribute

roundabout_exit_step_details: NotRequired[RouteRoundaboutExitStepDetails]

Details that are specific to a Roundabout Exit step.

roundabout_pass_step_details instance-attribute

roundabout_pass_step_details: NotRequired[RouteRoundaboutPassStepDetails]

Details that are specific to a Roundabout Pass step.

signpost instance-attribute

signpost: NotRequired[RouteSignpost]

Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.

turn_step_details instance-attribute

turn_step_details: NotRequired[RouteTurnStepDetails]

Details that are specific to a Turn step.

type instance-attribute

Type of the step.

u_turn_step_details instance-attribute

u_turn_step_details: NotRequired[RouteUTurnStepDetails]

Details that are specific to a Turn step.