Constructor
new VisitRequest(propertiesopt)
Constructs a new VisitRequest.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.optimization.v1.Shipment.IVisitRequest |
<optional> |
Properties to set |
- Implements:
-
- IVisitRequest
Members
arrivalLocation
VisitRequest arrivalLocation.
arrivalWaypoint
VisitRequest arrivalWaypoint.
cost
VisitRequest cost.
demands
VisitRequest demands.
departureLocation
VisitRequest departureLocation.
departureWaypoint
VisitRequest departureWaypoint.
duration
VisitRequest duration.
label
VisitRequest label.
loadDemands
VisitRequest loadDemands.
tags
VisitRequest tags.
timeWindows
VisitRequest timeWindows.
visitTypes
VisitRequest visitTypes.
Methods
toJSON() → {Object.<string, *>}
Converts this VisitRequest to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.optimization.v1.Shipment.VisitRequest}
Creates a new VisitRequest instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.optimization.v1.Shipment.IVisitRequest |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.optimization.v1.Shipment.VisitRequest |
VisitRequest instance |
(static) decode(reader, lengthopt) → {google.cloud.optimization.v1.Shipment.VisitRequest}
Decodes a VisitRequest 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.Shipment.VisitRequest |
VisitRequest |
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.Shipment.VisitRequest}
Decodes a VisitRequest 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.Shipment.VisitRequest |
VisitRequest |
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 VisitRequest message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.optimization.v1.Shipment.IVisitRequest |
VisitRequest 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 VisitRequest message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.optimization.v1.Shipment.IVisitRequest |
VisitRequest 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.Shipment.VisitRequest}
Creates a VisitRequest 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.Shipment.VisitRequest |
VisitRequest |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for VisitRequest
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 VisitRequest message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.optimization.v1.Shipment.VisitRequest |
VisitRequest |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a VisitRequest message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|