Constructor
new ShipmentRoute(propertiesopt)
Constructs a new ShipmentRoute.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.optimization.v1.IShipmentRoute |
<optional> |
Properties to set |
- Implements:
-
- IShipmentRoute
Classes
Members
breaks
ShipmentRoute breaks.
delayBeforeVehicleEnd
ShipmentRoute delayBeforeVehicleEnd.
endLoads
ShipmentRoute endLoads.
hasTrafficInfeasibilities
ShipmentRoute hasTrafficInfeasibilities.
metrics
ShipmentRoute metrics.
routeCosts
ShipmentRoute routeCosts.
routePolyline
ShipmentRoute routePolyline.
routeTotalCost
ShipmentRoute routeTotalCost.
transitions
ShipmentRoute transitions.
travelSteps
ShipmentRoute travelSteps.
vehicleDetour
ShipmentRoute vehicleDetour.
vehicleEndTime
ShipmentRoute vehicleEndTime.
vehicleIndex
ShipmentRoute vehicleIndex.
vehicleLabel
ShipmentRoute vehicleLabel.
vehicleStartTime
ShipmentRoute vehicleStartTime.
visits
ShipmentRoute visits.
Methods
toJSON() → {Object.<string, *>}
Converts this ShipmentRoute to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.optimization.v1.ShipmentRoute}
Creates a new ShipmentRoute instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.optimization.v1.IShipmentRoute |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.optimization.v1.ShipmentRoute |
ShipmentRoute instance |
(static) decode(reader, lengthopt) → {google.cloud.optimization.v1.ShipmentRoute}
Decodes a ShipmentRoute message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.optimization.v1.ShipmentRoute |
ShipmentRoute |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.optimization.v1.ShipmentRoute}
Decodes a ShipmentRoute message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.optimization.v1.ShipmentRoute |
ShipmentRoute |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified ShipmentRoute message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.optimization.v1.IShipmentRoute |
ShipmentRoute message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified ShipmentRoute message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.optimization.v1.IShipmentRoute |
ShipmentRoute message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.optimization.v1.ShipmentRoute}
Creates a ShipmentRoute message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.optimization.v1.ShipmentRoute |
ShipmentRoute |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for ShipmentRoute
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a ShipmentRoute message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.optimization.v1.ShipmentRoute |
ShipmentRoute |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a ShipmentRoute message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|