Class Visit (1.3.0)

Visit(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A visit performed during a route. This visit corresponds to a pickup or a delivery of a Shipment.

Attributes

Name	Description
`shipment_index`	`int` Index of the `shipments` field in the source ShipmentModel.
`is_pickup`	`bool` If true the visit corresponds to a pickup of a `Shipment`. Otherwise, it corresponds to a delivery.
`visit_request_index`	`int` Index of `VisitRequest` in either the pickup or delivery field of the `Shipment` (see `is_pickup`).
`start_time`	`google.protobuf.timestamp_pb2.Timestamp` Time at which the visit starts. Note that the vehicle may arrive earlier than this at the visit location. Times are consistent with the `ShipmentModel`.
`load_demands`	`MutableMapping[str, google.cloud.optimization_v1.types.Shipment.Load]` Total visit load demand as the sum of the shipment and the visit request `load_demands`. The values are negative if the visit is a delivery. Demands are reported for the same types as the Transition.loads (see this field).
`detour`	`google.protobuf.duration_pb2.Duration` Extra detour time due to the shipments visited on the route before the visit and to the potential waiting time induced by time windows. If the visit is a delivery, the detour is computed from the corresponding pickup visit and is equal to: :: start_time(delivery) - start_time(pickup) - (duration(pickup) + travel duration from the pickup location to the delivery location). Otherwise, it is computed from the vehicle `start_location` and is equal to: :: start_time - vehicle_start_time - travel duration from the vehicle's `start_location` to the visit.
`shipment_label`	`str` Copy of the corresponding `Shipment.label`, if specified in the `Shipment`.
`visit_label`	`str` Copy of the corresponding VisitRequest.label, if specified in the `VisitRequest`.
`arrival_loads`	`MutableSequence[google.cloud.optimization_v1.types.CapacityQuantity]` Deprecated: Use [ShipmentRoute.Transition.loads][] instead. Vehicle loads upon arrival at the visit location, for each type specified in Vehicle.capacities, `start_load_intervals`, `end_load_intervals` or `demands`. Exception: we omit loads for quantity types unconstrained by intervals and that don't have any non-zero demand on the route.
`delay_before_start`	`google.cloud.optimization_v1.types.ShipmentRoute.Delay` Deprecated: Use [ShipmentRoute.Transition.delay_duration][] instead.
`demands`	`MutableSequence[google.cloud.optimization_v1.types.CapacityQuantity]` Deprecated: Use [Visit.load_demands][] instead.

Classes

LoadDemandsEntry

LoadDemandsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters

Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.