Path
Stay organized with collections
Save and categorize content based on your preferences.
Path for a shipment within the network.
| JSON representation |
{
"shipment": string,
"segments": [
{
object (AnnotatedPathSegment)
}
],
"departureTime": {
object (DateTime)
},
"arrivalTime": {
object (DateTime)
},
"incurredPenalties": number,
"costConstant": number,
"cost": {
string: number,
...
}
} |
| Fields |
shipment |
string
Required. Shipment whose path is being described.
|
segments[] |
object (AnnotatedPathSegment)
Required. Segments of the path.
|
departureTime |
object (DateTime)
Output only. Actual departure time of the shipment.
|
arrivalTime |
object (DateTime)
Output only. Actual arrival time of the shipment.
|
incurredPenalties |
number
Output only. Penalties due to soft constraints not respected.
|
costConstant |
number
Output only. Constant cost for this shipment.
|
cost |
map (key: string, value: number)
Output only. Cost by components. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
|
AnnotatedPathSegment
Represents a part of a path with more redundant information that can be computed based on the contained PathSegment and the Network. These messages are typically returned by the API server.
| JSON representation |
{
"segment": {
object (PathSegment)
},
"arrivalTime": {
object (DateTime)
},
"departureTime": {
object (DateTime)
},
"isCommitted": boolean,
"segmentCostConstant": number,
"segmentCostDueToVehicle": {
string: number,
...
},
"segmentCostDueToDeparture": number,
"segmentCostDueToArrival": number
} |
| Fields |
segment |
object (PathSegment)
Required. Segment being annotated.
|
arrivalTime |
object (DateTime)
Output only. Arrival time of this segment.
|
departureTime |
object (DateTime)
Output only. Departure time of this segment.
|
isCommitted |
boolean
Output only. Whether the API customer has decided to commit this part of the path.
|
segmentCostConstant |
number
Output only. Constant cost for this segment.
|
segmentCostDueToVehicle |
map (key: string, value: number)
Output only. One entry per dimension. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
|
segmentCostDueToDeparture |
number
Output only. Cost due to the line rotation: departure.
|
segmentCostDueToArrival |
number
Output only. Cost due to the line rotation: arrival.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-14 UTC."],[[["\u003cp\u003eDefines the \u003ccode\u003ePath\u003c/code\u003e object which represents the route for a shipment within a network, including segments, departure and arrival times, and associated costs.\u003c/p\u003e\n"],["\u003cp\u003eDetails the \u003ccode\u003eAnnotatedPathSegment\u003c/code\u003e object, providing richer information about each segment in the path, like arrival/departure times, commitment status, and segment-specific costs.\u003c/p\u003e\n"],["\u003cp\u003eBoth \u003ccode\u003ePath\u003c/code\u003e and \u003ccode\u003eAnnotatedPathSegment\u003c/code\u003e leverage the \u003ccode\u003eDateTime\u003c/code\u003e object for representing time and include cost breakdowns for better understanding shipment expenses.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAnnotatedPathSegment\u003c/code\u003e builds upon \u003ccode\u003ePathSegment\u003c/code\u003e by adding computed information derived from the network context.\u003c/p\u003e\n"]]],["This document describes a shipment's path within a network, detailing its segments and associated data. Key information includes the `shipment` identifier, a list of `segments` each represented by an `AnnotatedPathSegment`, `departureTime`, and `arrivalTime`. Each segment has details on `isCommitted` status, and various costs, such as `segmentCostConstant`, `segmentCostDueToVehicle`, `segmentCostDueToDeparture`, and `segmentCostDueToArrival`. Overall costs for the entire shipment are also listed, with `incurredPenalties`, `costConstant` and costs broken down by components.\n"],null,["# Path for a shipment within the network.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"shipment\": string, \"segments\": [ { object (/optimization/middlemileoptimization/reference/rest/v1/Path#AnnotatedPathSegment) } ], \"departureTime\": { object (/optimization/middlemileoptimization/reference/rest/v1/DateTime) }, \"arrivalTime\": { object (/optimization/middlemileoptimization/reference/rest/v1/DateTime) }, \"incurredPenalties\": number, \"costConstant\": number, \"cost\": { string: number, ... } } ``` |\n\n| Fields ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `shipment` | `string` Required. Shipment whose path is being described. |\n| `segments[]` | `object (`[AnnotatedPathSegment](/optimization/middlemileoptimization/reference/rest/v1/Path#AnnotatedPathSegment)`)` Required. Segments of the path. |\n| `departure``Time` | `object (`[DateTime](/optimization/middlemileoptimization/reference/rest/v1/DateTime)`)` Output only. Actual departure time of the shipment. |\n| `arrival``Time` | `object (`[DateTime](/optimization/middlemileoptimization/reference/rest/v1/DateTime)`)` Output only. Actual arrival time of the shipment. |\n| `incurred``Penalties` | `number` Output only. Penalties due to soft constraints not respected. |\n| `cost``Constant` | `number` Output only. Constant cost for this shipment. |\n| `cost` | `map (key: string, value: number)` Output only. Cost by components. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n\nAnnotatedPathSegment\n--------------------\n\nRepresents a part of a path with more redundant information that can be computed based on the contained PathSegment and the Network. These messages are typically returned by the API server.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"segment\": { object (/optimization/middlemileoptimization/reference/rest/v1/PathSegment) }, \"arrivalTime\": { object (/optimization/middlemileoptimization/reference/rest/v1/DateTime) }, \"departureTime\": { object (/optimization/middlemileoptimization/reference/rest/v1/DateTime) }, \"isCommitted\": boolean, \"segmentCostConstant\": number, \"segmentCostDueToVehicle\": { string: number, ... }, \"segmentCostDueToDeparture\": number, \"segmentCostDueToArrival\": number } ``` |\n\n| Fields ||\n|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `segment` | `object (`[PathSegment](/optimization/middlemileoptimization/reference/rest/v1/PathSegment)`)` Required. Segment being annotated. |\n| `arrival``Time` | `object (`[DateTime](/optimization/middlemileoptimization/reference/rest/v1/DateTime)`)` Output only. Arrival time of this segment. |\n| `departure``Time` | `object (`[DateTime](/optimization/middlemileoptimization/reference/rest/v1/DateTime)`)` Output only. Departure time of this segment. |\n| `is``Committed` | `boolean` Output only. Whether the API customer has decided to commit this part of the path. |\n| `segment``Cost``Constant` | `number` Output only. Constant cost for this segment. |\n| `segment``Cost``Due``To``Vehicle` | `map (key: string, value: number)` Output only. One entry per dimension. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `segment``Cost``Due``To``Departure` | `number` Output only. Cost due to the line rotation: departure. |\n| `segment``Cost``Due``To``Arrival` | `number` Output only. Cost due to the line rotation: arrival. |"]]