Constructor
new Shipment(propertiesopt)
Constructs a new Shipment.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.optimization.v1.IShipment |
<optional> |
Properties to set |
- Implements:
-
- IShipment
Classes
Members
_penaltyCost
Shipment _penaltyCost.
_pickupToDeliveryRelativeDetourLimit
Shipment _pickupToDeliveryRelativeDetourLimit.
allowedVehicleIndices
Shipment allowedVehicleIndices.
costsPerVehicle
Shipment costsPerVehicle.
costsPerVehicleIndices
Shipment costsPerVehicleIndices.
deliveries
Shipment deliveries.
demands
Shipment demands.
ignore
Shipment ignore.
label
Shipment label.
loadDemands
Shipment loadDemands.
penaltyCost
Shipment penaltyCost.
pickupToDeliveryAbsoluteDetourLimit
Shipment pickupToDeliveryAbsoluteDetourLimit.
pickupToDeliveryRelativeDetourLimit
Shipment pickupToDeliveryRelativeDetourLimit.
pickupToDeliveryTimeLimit
Shipment pickupToDeliveryTimeLimit.
pickups
Shipment pickups.
shipmentType
Shipment shipmentType.
Methods
toJSON() → {Object.<string, *>}
Converts this Shipment to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.optimization.v1.Shipment}
Creates a new Shipment instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.optimization.v1.IShipment |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.optimization.v1.Shipment |
Shipment instance |
(static) decode(reader, lengthopt) → {google.cloud.optimization.v1.Shipment}
Decodes a Shipment 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.Shipment |
Shipment |
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.Shipment}
Decodes a Shipment 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.Shipment |
Shipment |
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 Shipment message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.optimization.v1.IShipment |
Shipment 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 Shipment message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.optimization.v1.IShipment |
Shipment 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.Shipment}
Creates a Shipment 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.Shipment |
Shipment |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Shipment
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 Shipment message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.optimization.v1.Shipment |
Shipment |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Shipment message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|