Represents a ShipmentRoute.
Package
@googlemaps/routeoptimizationConstructors
(constructor)(properties)
constructor(properties?: google.maps.routeoptimization.v1.IShipmentRoute);Constructs a new ShipmentRoute.
| Parameter | |
|---|---|
| Name | Description |
properties |
IShipmentRoute
Properties to set |
Properties
breaks
public breaks: google.maps.routeoptimization.v1.ShipmentRoute.IBreak[];ShipmentRoute breaks.
hasTrafficInfeasibilities
public hasTrafficInfeasibilities: boolean;ShipmentRoute hasTrafficInfeasibilities.
metrics
public metrics?: (google.maps.routeoptimization.v1.IAggregatedMetrics|null);ShipmentRoute metrics.
routeCosts
public routeCosts: { [k: string]: number };ShipmentRoute routeCosts.
routePolyline
public routePolyline?: (google.maps.routeoptimization.v1.ShipmentRoute.IEncodedPolyline|null);ShipmentRoute routePolyline.
routeTotalCost
public routeTotalCost: number;ShipmentRoute routeTotalCost.
transitions
public transitions: google.maps.routeoptimization.v1.ShipmentRoute.ITransition[];ShipmentRoute transitions.
vehicleEndTime
public vehicleEndTime?: (google.protobuf.ITimestamp|null);ShipmentRoute vehicleEndTime.
vehicleIndex
public vehicleIndex: number;ShipmentRoute vehicleIndex.
vehicleLabel
public vehicleLabel: string;ShipmentRoute vehicleLabel.
vehicleStartTime
public vehicleStartTime?: (google.protobuf.ITimestamp|null);ShipmentRoute vehicleStartTime.
visits
public visits: google.maps.routeoptimization.v1.ShipmentRoute.IVisit[];ShipmentRoute visits.
Methods
create(properties)
public static create(properties?: google.maps.routeoptimization.v1.IShipmentRoute): google.maps.routeoptimization.v1.ShipmentRoute;Creates a new ShipmentRoute instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IShipmentRoute
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
ShipmentRoute instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.routeoptimization.v1.ShipmentRoute;Decodes a ShipmentRoute message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
ShipmentRoute |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.routeoptimization.v1.ShipmentRoute;Decodes a ShipmentRoute message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
ShipmentRoute |
encode(message, writer)
public static encode(message: google.maps.routeoptimization.v1.IShipmentRoute, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ShipmentRoute message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IShipmentRoute
ShipmentRoute message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.maps.routeoptimization.v1.IShipmentRoute, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ShipmentRoute message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IShipmentRoute
ShipmentRoute message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.maps.routeoptimization.v1.ShipmentRoute;Creates a ShipmentRoute message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
ShipmentRoute |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ShipmentRoute
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this ShipmentRoute to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.maps.routeoptimization.v1.ShipmentRoute, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ShipmentRoute message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ShipmentRoute
ShipmentRoute |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a ShipmentRoute message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|