ShipmentModel

google.cloud.optimization.v1. ShipmentModel

Represents a ShipmentModel.

Constructor

new ShipmentModel(propertiesopt)

Constructs a new ShipmentModel.

Parameters:
Name Type Attributes Description
properties google.cloud.optimization.v1.IShipmentModel <optional>

Properties to set

Implements:
  • IShipmentModel

Classes

BreakRule
DurationDistanceMatrix
PrecedenceRule

Members

_maxActiveVehicles

ShipmentModel _maxActiveVehicles.

breakRules

ShipmentModel breakRules.

durationDistanceMatrices

ShipmentModel durationDistanceMatrices.

durationDistanceMatrixDstTags

ShipmentModel durationDistanceMatrixDstTags.

durationDistanceMatrixSrcTags

ShipmentModel durationDistanceMatrixSrcTags.

globalDurationCostPerHour

ShipmentModel globalDurationCostPerHour.

globalEndTime

ShipmentModel globalEndTime.

globalStartTime

ShipmentModel globalStartTime.

maxActiveVehicles

ShipmentModel maxActiveVehicles.

precedenceRules

ShipmentModel precedenceRules.

shipmentTypeIncompatibilities

ShipmentModel shipmentTypeIncompatibilities.

shipmentTypeRequirements

ShipmentModel shipmentTypeRequirements.

shipments

ShipmentModel shipments.

transitionAttributes

ShipmentModel transitionAttributes.

vehicles

ShipmentModel vehicles.

Methods

toJSON() → {Object.<string, *>}

Converts this ShipmentModel to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.optimization.v1.ShipmentModel}

Creates a new ShipmentModel instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.optimization.v1.IShipmentModel <optional>

Properties to set

Returns:
Type Description
google.cloud.optimization.v1.ShipmentModel

ShipmentModel instance

(static) decode(reader, lengthopt) → {google.cloud.optimization.v1.ShipmentModel}

Decodes a ShipmentModel 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.ShipmentModel

ShipmentModel

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.ShipmentModel}

Decodes a ShipmentModel 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.ShipmentModel

ShipmentModel

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 ShipmentModel message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.optimization.v1.IShipmentModel

ShipmentModel 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 ShipmentModel message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.optimization.v1.IShipmentModel

ShipmentModel 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.ShipmentModel}

Creates a ShipmentModel 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.ShipmentModel

ShipmentModel

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ShipmentModel

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 ShipmentModel message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.optimization.v1.ShipmentModel

ShipmentModel

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a ShipmentModel message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not