Class protos.google.cloud.optimization.v1.ShipmentModel (2.2.2)

Represents a ShipmentModel.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.optimization.v1.IShipmentModel);

Constructs a new ShipmentModel.

Parameter
Name	Description
`properties`	`IShipmentModel` Properties to set

Properties

_maxActiveVehicles

public _maxActiveVehicles?: "maxActiveVehicles";

ShipmentModel _maxActiveVehicles.

breakRules

public breakRules: google.cloud.optimization.v1.ShipmentModel.IBreakRule[];

ShipmentModel breakRules.

durationDistanceMatrices

public durationDistanceMatrices: google.cloud.optimization.v1.ShipmentModel.IDurationDistanceMatrix[];

ShipmentModel durationDistanceMatrices.

durationDistanceMatrixDstTags

public durationDistanceMatrixDstTags: string[];

ShipmentModel durationDistanceMatrixDstTags.

durationDistanceMatrixSrcTags

public durationDistanceMatrixSrcTags: string[];

ShipmentModel durationDistanceMatrixSrcTags.

globalDurationCostPerHour

public globalDurationCostPerHour: number;

ShipmentModel globalDurationCostPerHour.

globalEndTime

public globalEndTime?: (google.protobuf.ITimestamp|null);

ShipmentModel globalEndTime.

globalStartTime

public globalStartTime?: (google.protobuf.ITimestamp|null);

ShipmentModel globalStartTime.

maxActiveVehicles

public maxActiveVehicles?: (number|null);

ShipmentModel maxActiveVehicles.

precedenceRules

public precedenceRules: google.cloud.optimization.v1.ShipmentModel.IPrecedenceRule[];

ShipmentModel precedenceRules.

shipments

public shipments: google.cloud.optimization.v1.IShipment[];

ShipmentModel shipments.

shipmentTypeIncompatibilities

public shipmentTypeIncompatibilities: google.cloud.optimization.v1.IShipmentTypeIncompatibility[];

ShipmentModel shipmentTypeIncompatibilities.

shipmentTypeRequirements

public shipmentTypeRequirements: google.cloud.optimization.v1.IShipmentTypeRequirement[];

ShipmentModel shipmentTypeRequirements.

transitionAttributes

public transitionAttributes: google.cloud.optimization.v1.ITransitionAttributes[];

ShipmentModel transitionAttributes.

vehicles

public vehicles: google.cloud.optimization.v1.IVehicle[];

ShipmentModel vehicles.

Methods

create(properties)

public static create(properties?: google.cloud.optimization.v1.IShipmentModel): google.cloud.optimization.v1.ShipmentModel;

Creates a new ShipmentModel instance using the specified properties.

Parameter
Name	Description
`properties`	`IShipmentModel` Properties to set

Returns
Type	Description
`google.cloud.optimization.v1.ShipmentModel`	ShipmentModel instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.optimization.v1.ShipmentModel;

Decodes a ShipmentModel message from the specified reader or buffer.

Parameters
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

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

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.optimization.v1.ShipmentModel;

Decodes a ShipmentModel message from the specified reader or buffer, length delimited.

Parameter
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

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

encode(message, writer)

public static encode(message: google.cloud.optimization.v1.IShipmentModel, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ShipmentModel message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IShipmentModel` ShipmentModel 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.cloud.optimization.v1.IShipmentModel, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ShipmentModel message, length delimited. Does not implicitly messages.

Parameters
Name	Description
`message`	`IShipmentModel` ShipmentModel 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.cloud.optimization.v1.ShipmentModel;

Creates a ShipmentModel 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
`google.cloud.optimization.v1.ShipmentModel`	ShipmentModel

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ShipmentModel

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 ShipmentModel to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.optimization.v1.ShipmentModel, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a ShipmentModel message. Also converts values to other types if specified.

Parameters
Name	Description
`message`	`google.cloud.optimization.v1.ShipmentModel` ShipmentModel
`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 ShipmentModel message.

Parameter
Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns
Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not