Represents a Visit.
Package
@google-cloud/optimizationConstructors
(constructor)(properties)
constructor(properties?: google.cloud.optimization.v1.ShipmentRoute.IVisit);Constructs a new Visit.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVisit
Properties to set |
Properties
arrivalLoads
public arrivalLoads: google.cloud.optimization.v1.ICapacityQuantity[];Visit arrivalLoads.
delayBeforeStart
public delayBeforeStart?: (google.cloud.optimization.v1.ShipmentRoute.IDelay|null);Visit delayBeforeStart.
demands
public demands: google.cloud.optimization.v1.ICapacityQuantity[];Visit demands.
detour
public detour?: (google.protobuf.IDuration|null);Visit detour.
isPickup
public isPickup: boolean;Visit isPickup.
loadDemands
public loadDemands: { [k: string]: google.cloud.optimization.v1.Shipment.ILoad };Visit loadDemands.
shipmentIndex
public shipmentIndex: number;Visit shipmentIndex.
shipmentLabel
public shipmentLabel: string;Visit shipmentLabel.
startTime
public startTime?: (google.protobuf.ITimestamp|null);Visit startTime.
visitLabel
public visitLabel: string;Visit visitLabel.
visitRequestIndex
public visitRequestIndex: number;Visit visitRequestIndex.
Methods
create(properties)
public static create(properties?: google.cloud.optimization.v1.ShipmentRoute.IVisit): google.cloud.optimization.v1.ShipmentRoute.Visit;Creates a new Visit instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVisit
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Visit | Visit instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.optimization.v1.ShipmentRoute.Visit;Decodes a Visit message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Visit | Visit |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.optimization.v1.ShipmentRoute.Visit;Decodes a Visit message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Visit | Visit |
encode(message, writer)
public static encode(message: google.cloud.optimization.v1.ShipmentRoute.IVisit, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Visit message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IVisit
Visit 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.ShipmentRoute.IVisit, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Visit message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IVisit
Visit 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.ShipmentRoute.Visit;Creates a Visit 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 |
Visit | Visit |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Visit
| 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 Visit to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.optimization.v1.ShipmentRoute.Visit, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Visit message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Visit
Visit |
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 Visit message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|