Visit

google.cloud.optimization.v1.ShipmentRoute. Visit

Represents a Visit.

Constructor

new Visit(propertiesopt)

Constructs a new Visit.

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

Properties to set

Implements:
  • IVisit

Members

arrivalLoads

Visit arrivalLoads.

delayBeforeStart

Visit delayBeforeStart.

demands

Visit demands.

detour

Visit detour.

isPickup

Visit isPickup.

loadDemands

Visit loadDemands.

shipmentIndex

Visit shipmentIndex.

shipmentLabel

Visit shipmentLabel.

startTime

Visit startTime.

visitLabel

Visit visitLabel.

visitRequestIndex

Visit visitRequestIndex.

Methods

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

Converts this Visit to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Visit instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.cloud.optimization.v1.ShipmentRoute.Visit

Visit instance

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

Decodes a Visit 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.ShipmentRoute.Visit

Visit

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.ShipmentRoute.Visit}

Decodes a Visit 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.ShipmentRoute.Visit

Visit

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

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

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

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

Visit 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.ShipmentRoute.Visit}

Creates a Visit 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.ShipmentRoute.Visit

Visit

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Visit

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

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

Visit

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a Visit 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