Class protos.google.cloud.optimization.v1.Shipment (2.1.1)

Represents a Shipment.

Package

@google-cloud/optimization

Constructors

(constructor)(properties)

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

Constructs a new Shipment.

Parameter
Name Description
properties IShipment

Properties to set

Properties

_penaltyCost

public _penaltyCost?: "penaltyCost";

Shipment _penaltyCost.

_pickupToDeliveryRelativeDetourLimit

public _pickupToDeliveryRelativeDetourLimit?: "pickupToDeliveryRelativeDetourLimit";

Shipment _pickupToDeliveryRelativeDetourLimit.

allowedVehicleIndices

public allowedVehicleIndices: number[];

Shipment allowedVehicleIndices.

costsPerVehicle

public costsPerVehicle: number[];

Shipment costsPerVehicle.

costsPerVehicleIndices

public costsPerVehicleIndices: number[];

Shipment costsPerVehicleIndices.

deliveries

public deliveries: google.cloud.optimization.v1.Shipment.IVisitRequest[];

Shipment deliveries.

demands

public demands: google.cloud.optimization.v1.ICapacityQuantity[];

Shipment demands.

ignore

public ignore: boolean;

Shipment ignore.

label

public label: string;

Shipment label.

loadDemands

public loadDemands: { [k: string]: google.cloud.optimization.v1.Shipment.ILoad };

Shipment loadDemands.

penaltyCost

public penaltyCost?: (number|null);

Shipment penaltyCost.

pickups

public pickups: google.cloud.optimization.v1.Shipment.IVisitRequest[];

Shipment pickups.

pickupToDeliveryAbsoluteDetourLimit

public pickupToDeliveryAbsoluteDetourLimit?: (google.protobuf.IDuration|null);

Shipment pickupToDeliveryAbsoluteDetourLimit.

pickupToDeliveryRelativeDetourLimit

public pickupToDeliveryRelativeDetourLimit?: (number|null);

Shipment pickupToDeliveryRelativeDetourLimit.

pickupToDeliveryTimeLimit

public pickupToDeliveryTimeLimit?: (google.protobuf.IDuration|null);

Shipment pickupToDeliveryTimeLimit.

shipmentType

public shipmentType: string;

Shipment shipmentType.

Methods

create(properties)

public static create(properties?: google.cloud.optimization.v1.IShipment): google.cloud.optimization.v1.Shipment;

Creates a new Shipment instance using the specified properties.

Parameter
Name Description
properties IShipment

Properties to set
Returns
Type Description
google.cloud.optimization.v1.Shipment

Shipment instance

decode(reader, length)

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

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

Shipment

decodeDelimited(reader)

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

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

Shipment

encode(message, writer)

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

Encodes the specified Shipment message. Does not implicitly messages.

Parameters
Name Description
message IShipment

Shipment 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.IShipment, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IShipment

Shipment 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.Shipment;

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

Shipment

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Shipment

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.optimization.v1.Shipment

Shipment
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 Shipment 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