Skip to content

RouteFerryTravelStep

Source code in docs_src/capo_geo_routes/types/route_ferry_travel_step.py 
16
17
18
19
20
21
22
23
24
25
26
class RouteFerryTravelStep(TypedDict, closed=True):
    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>"""
    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>"""
    type: "capo_geo_routes.types.route_ferry_travel_step_type.RouteFerryTravelStepType"
    """<p>Type of the step.</p>"""

distance instance-attribute 

distance: DistanceMeters

Distance of the step.

duration instance-attribute 

duration: DurationSeconds

Duration of the step.

Unit: seconds

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.

type instance-attribute 

type: RouteFerryTravelStepType

Type of the step.