Skip to content

OptimizeWaypointsResponse

Source code in docs_src/capo_geo_routes/types/optimize_waypoints_response.py
class OptimizeWaypointsResponse(TypedDict, closed=True):
    connections: "capo_geo_routes.types.waypoint_optimization_connection_list.WaypointOptimizationConnectionList"
    """<p>Details about the connection from one waypoint to the next, within the optimized sequence.</p>"""
    distance: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>Overall distance to travel the whole sequence.</p>"""
    duration: "capo_geo_routes.types.duration_seconds.DurationSeconds"
    """<p>Overall duration to travel the whole sequence.</p> <p> <b>Unit</b>: <code>seconds</code> </p>"""
    impeding_waypoints: "capo_geo_routes.types.waypoint_optimization_impeding_waypoint_list.WaypointOptimizationImpedingWaypointList"
    """<p>Returns waypoints that caused the optimization problem to fail, and the constraints that were unsatisfied leading to the failure.</p>"""
    optimized_waypoints: "capo_geo_routes.types.waypoint_optimization_optimized_waypoint_list.WaypointOptimizationOptimizedWaypointList"
    """<p>Waypoints in the order of the optimized sequence.</p>"""
    pricing_bucket: "str"
    """<p>The pricing bucket for which the query is charged at.</p>"""
    time_breakdown: "capo_geo_routes.types.waypoint_optimization_time_breakdown.WaypointOptimizationTimeBreakdown"
    """<p>Time breakdown for the sequence.</p>"""

connections instance-attribute

Details about the connection from one waypoint to the next, within the optimized sequence.

distance instance-attribute

distance: DistanceMeters

Overall distance to travel the whole sequence.

duration instance-attribute

duration: DurationSeconds

Overall duration to travel the whole sequence.

Unit: seconds

impeding_waypoints instance-attribute

Returns waypoints that caused the optimization problem to fail, and the constraints that were unsatisfied leading to the failure.

optimized_waypoints instance-attribute

Waypoints in the order of the optimized sequence.

pricing_bucket instance-attribute

pricing_bucket: str

The pricing bucket for which the query is charged at.

time_breakdown instance-attribute

Time breakdown for the sequence.