Google Cloud Optimization V1 Client - Class VisitRequest (0.3.4)

Reference documentation and code samples for the Google Cloud Optimization V1 Client class VisitRequest.

Request for a visit which can be done by a vehicle: it has a geo-location (or two, see below), opening and closing times represented by time windows, and a service duration time (time spent by the vehicle once it has arrived to pickup or drop off goods).

Generated from protobuf message google.cloud.optimization.v1.Shipment.VisitRequest

Namespace

Google \ Cloud \ Optimization \ V1 \ Shipment

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ arrival_location`	`Google\Type\LatLng` The geo-location where the vehicle arrives when performing this `VisitRequest`. If the shipment model has duration distance matrices, `arrival_location` must not be specified.
`↳ arrival_waypoint`	`Google\Cloud\Optimization\V1\Waypoint` The waypoint where the vehicle arrives when performing this `VisitRequest`. If the shipment model has duration distance matrices, `arrival_waypoint` must not be specified.
`↳ departure_location`	`Google\Type\LatLng` The geo-location where the vehicle departs after completing this `VisitRequest`. Can be omitted if it is the same as `arrival_location`. If the shipment model has duration distance matrices, `departure_location` must not be specified.
`↳ departure_waypoint`	`Google\Cloud\Optimization\V1\Waypoint` The waypoint where the vehicle departs after completing this `VisitRequest`. Can be omitted if it is the same as `arrival_waypoint`. If the shipment model has duration distance matrices, `departure_waypoint` must not be specified.
`↳ tags`	`array` Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
`↳ time_windows`	`array<Google\Cloud\Optimization\V1\TimeWindow>` Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before TimeWindow.start_time. The absence of `TimeWindow` means that the vehicle can perform this visit at any time. Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window.
`↳ duration`	`Google\Protobuf\Duration` Duration of the visit, i.e. time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see `time_windows`).
`↳ cost`	`float` Cost to service this visit request on a vehicle route. This can be used to pay different costs for each alternative pickup or delivery of a shipment. This cost must be in the same unit as `Shipment.penalty_cost` and must not be negative.
`↳ load_demands`	`array\|Google\Protobuf\Internal\MapField` Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment. The demands listed here are added to the demands listed in Shipment.load_demands.
`↳ visit_types`	`array` Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see Vehicle.extra_visit_duration_for_visit_type). A type can only appear once.
`↳ label`	`string` Specifies a label for this `VisitRequest`. This label is reported in the response as `visit_label` in the corresponding ShipmentRoute.Visit.
`↳ demands`	`array<Google\Cloud\Optimization\V1\CapacityQuantity>` Deprecated: Use VisitRequest.load_demands instead.

getArrivalLocation

The geo-location where the vehicle arrives when performing this VisitRequest. If the shipment model has duration distance matrices, arrival_location must not be specified.

Returns
Type	Description
`Google\Type\LatLng\|null`

hasArrivalLocation

clearArrivalLocation

setArrivalLocation

The geo-location where the vehicle arrives when performing this VisitRequest. If the shipment model has duration distance matrices, arrival_location must not be specified.

Parameter
Name	Description
`var`	`Google\Type\LatLng`

Returns
Type	Description
`$this`

getArrivalWaypoint

The waypoint where the vehicle arrives when performing this VisitRequest. If the shipment model has duration distance matrices, arrival_waypoint must not be specified.

Returns
Type	Description
`Google\Cloud\Optimization\V1\Waypoint\|null`

hasArrivalWaypoint

clearArrivalWaypoint

setArrivalWaypoint

The waypoint where the vehicle arrives when performing this VisitRequest. If the shipment model has duration distance matrices, arrival_waypoint must not be specified.

Parameter
Name	Description
`var`	`Google\Cloud\Optimization\V1\Waypoint`

Returns
Type	Description
`$this`

getDepartureLocation

The geo-location where the vehicle departs after completing this VisitRequest. Can be omitted if it is the same as arrival_location.

If the shipment model has duration distance matrices, departure_location must not be specified.

Returns
Type	Description
`Google\Type\LatLng\|null`

hasDepartureLocation

clearDepartureLocation

setDepartureLocation

The geo-location where the vehicle departs after completing this VisitRequest. Can be omitted if it is the same as arrival_location.

If the shipment model has duration distance matrices, departure_location must not be specified.

Parameter
Name	Description
`var`	`Google\Type\LatLng`

Returns
Type	Description
`$this`

getDepartureWaypoint

The waypoint where the vehicle departs after completing this VisitRequest. Can be omitted if it is the same as arrival_waypoint.

If the shipment model has duration distance matrices, departure_waypoint must not be specified.

Returns
Type	Description
`Google\Cloud\Optimization\V1\Waypoint\|null`

hasDepartureWaypoint

clearDepartureWaypoint

setDepartureWaypoint

The waypoint where the vehicle departs after completing this VisitRequest. Can be omitted if it is the same as arrival_waypoint.

If the shipment model has duration distance matrices, departure_waypoint must not be specified.

Parameter
Name	Description
`var`	`Google\Cloud\Optimization\V1\Waypoint`

Returns
Type	Description
`$this`

getTags

Specifies tags attached to the visit request.

Empty or duplicate strings are not allowed.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setTags

Specifies tags attached to the visit request.

Empty or duplicate strings are not allowed.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getTimeWindows

Time windows which constrain the arrival time at a visit.

Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before TimeWindow.start_time. The absence of TimeWindow means that the vehicle can perform this visit at any time. Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing order. cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setTimeWindows

Time windows which constrain the arrival time at a visit.

Parameter
Name	Description
`var`	`array<Google\Cloud\Optimization\V1\TimeWindow>`

Returns
Type	Description
`$this`

getDuration

Duration of the visit, i.e. time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see time_windows).

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasDuration

clearDuration

setDuration

Duration of the visit, i.e. time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see time_windows).

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`

getCost

Cost to service this visit request on a vehicle route. This can be used to pay different costs for each alternative pickup or delivery of a shipment. This cost must be in the same unit as Shipment.penalty_cost and must not be negative.

Returns
Type	Description
`float`

setCost

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getLoadDemands

Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment.

The demands listed here are added to the demands listed in Shipment.load_demands.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLoadDemands

Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment.

The demands listed here are added to the demands listed in Shipment.load_demands.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getVisitTypes

Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see Vehicle.extra_visit_duration_for_visit_type).

A type can only appear once.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setVisitTypes

Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see Vehicle.extra_visit_duration_for_visit_type).

A type can only appear once.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getLabel

Specifies a label for this VisitRequest. This label is reported in the response as visit_label in the corresponding ShipmentRoute.Visit.

Returns
Type	Description
`string`

setLabel

Specifies a label for this VisitRequest. This label is reported in the response as visit_label in the corresponding ShipmentRoute.Visit.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDemands

Deprecated: Use VisitRequest.load_demands instead.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDemands

Deprecated: Use VisitRequest.load_demands instead.

Parameter
Name	Description
`var`	`array<Google\Cloud\Optimization\V1\CapacityQuantity>`

Returns
Type	Description
`$this`