PathSegment
Stay organized with collections
Save and categorize content based on your preferences.
Represents a part of a path, either sent by the API customer to the API server (e.g., state change) or by the API server to the API customer (e.g., routing a shipment).
JSON representation |
{
"sourceHub": string,
"destinationHub": string,
"line": string,
"lineRotation": string,
"vehicle": string
} |
Fields |
sourceHub |
string
Required. Source of the segment.
|
destinationHub |
string
Required. Destination of the segment.
|
line |
string
Required. Line being followed for this segment.
|
lineRotation |
string
Required. Rotation being followed for this segment.
|
vehicle |
string
Required. Vehicle followed by this segment.
|
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."],[[["Represents a part of a path, either sent by the API customer or the API server, containing information about the movement or routing."],["Includes information about the source and destination hubs, the line and rotation being followed, and the vehicle used for the segment."],["Defined by a JSON object with required fields for `sourceHub`, `destinationHub`, `line`, `lineRotation`, and `vehicle`."]]],["This content defines a path segment, detailing its structure and fields. It utilizes a JSON format with five required string fields: `sourceHub`, `destinationHub`, `line`, `lineRotation`, and `vehicle`. These fields respectively identify the segment's origin, destination, the route being taken, the direction of travel on that route, and the specific vehicle in use. This segment is exchanged between the API server and its customer to indicate movements or changes.\n"]]