# Cloud Optimization V1 API - Class Google::Cloud::Optimization::V1::Shipment::VisitRequest (v0.16.0)

0.16.0 (latest) 0.15.0 0.14.1 0.13.0 0.12.0 0.11.1 0.10.0 0.9.2 0.8.2 0.7.0 0.6.0 0.5.0 0.4.1 0.3.0 0.2.1 0.1.1 Reference documentation and code samples for the Cloud Optimization V1 API class Google::Cloud::Optimization::V1::Shipment::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).

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #arrival_location

    def arrival_location() -> ::Google::Type::LatLng

**Returns**

- ([::Google::Type::LatLng](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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_location=

    def arrival_location=(value) -> ::Google::Type::LatLng

**Parameter**

- **value** ([::Google::Type::LatLng](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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.
**Returns**

- ([::Google::Type::LatLng](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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

    def arrival_waypoint() -> ::Google::Cloud::Optimization::V1::Waypoint

**Returns**

- ([::Google::Cloud::Optimization::V1::Waypoint](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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.

### #arrival_waypoint=

    def arrival_waypoint=(value) -> ::Google::Cloud::Optimization::V1::Waypoint

**Parameter**

- **value** ([::Google::Cloud::Optimization::V1::Waypoint](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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.
**Returns**

- ([::Google::Cloud::Optimization::V1::Waypoint](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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.

### #cost

    def cost() -> ::Float

**Returns**

- (::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.

### #cost=

    def cost=(value) -> ::Float

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #demands

    def demands() -> ::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>

**Returns**

- (::Array\<[::Google::Cloud::Optimization::V1::CapacityQuantity](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-CapacityQuantity)\>) --- Deprecated: Use [VisitRequest.load_demands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment-VisitRequest#Google__Cloud__Optimization__V1__Shipment__VisitRequest_load_demands_instance_ "Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands (method)") instead.

### #demands=

    def demands=(value) -> ::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Optimization::V1::CapacityQuantity](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-CapacityQuantity)\>) --- Deprecated: Use [VisitRequest.load_demands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment-VisitRequest#Google__Cloud__Optimization__V1__Shipment__VisitRequest_load_demands_instance_ "Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands (method)") instead.
**Returns**

- (::Array\<[::Google::Cloud::Optimization::V1::CapacityQuantity](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-CapacityQuantity)\>) --- Deprecated: Use [VisitRequest.load_demands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment-VisitRequest#Google__Cloud__Optimization__V1__Shipment__VisitRequest_load_demands_instance_ "Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands (method)") instead.

### #departure_location

    def departure_location() -> ::Google::Type::LatLng

**Returns**

- ([::Google::Type::LatLng](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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_location=

    def departure_location=(value) -> ::Google::Type::LatLng

**Parameter**

- **value** ([::Google::Type::LatLng](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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.
**Returns**

- ([::Google::Type::LatLng](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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

    def departure_waypoint() -> ::Google::Cloud::Optimization::V1::Waypoint

**Returns**

- ([::Google::Cloud::Optimization::V1::Waypoint](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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.

### #departure_waypoint=

    def departure_waypoint=(value) -> ::Google::Cloud::Optimization::V1::Waypoint

**Parameter**

- **value** ([::Google::Cloud::Optimization::V1::Waypoint](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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.
**Returns**

- ([::Google::Cloud::Optimization::V1::Waypoint](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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.

### #duration

    def duration() -> ::Google::Protobuf::Duration

**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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`).

### #duration=

    def duration=(value) -> ::Google::Protobuf::Duration

**Parameter**

- **value** ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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`).
**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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`).

### #label

    def label() -> ::String

**Returns**

- (::String) --- Specifies a label for this `VisitRequest`. This label is reported in the response as `visit_label` in the corresponding [ShipmentRoute.Visit](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-ShipmentRoute-Visit "Google::Cloud::Optimization::V1::ShipmentRoute::Visit (class)").

### #label=

    def label=(value) -> ::String

**Parameter**

- **value** (::String) --- Specifies a label for this `VisitRequest`. This label is reported in the response as `visit_label` in the corresponding [ShipmentRoute.Visit](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-ShipmentRoute-Visit "Google::Cloud::Optimization::V1::ShipmentRoute::Visit (class)").
**Returns**

- (::String) --- Specifies a label for this `VisitRequest`. This label is reported in the response as `visit_label` in the corresponding [ShipmentRoute.Visit](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-ShipmentRoute-Visit "Google::Cloud::Optimization::V1::ShipmentRoute::Visit (class)").

### #load_demands

    def load_demands() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::Google::Cloud::Optimization::V1::Shipment::Load}) --- Load demands of this visit request. This is just like [Shipment.load_demands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment#Google__Cloud__Optimization__V1__Shipment_load_demands_instance_ "Google::Cloud::Optimization::V1::Shipment#load_demands (method)") field, except that it only applies to this [VisitRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment-VisitRequest "Google::Cloud::Optimization::V1::Shipment::VisitRequest (class)") instead of the whole [Shipment](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment "Google::Cloud::Optimization::V1::Shipment (class)"). The demands listed here are added to the demands listed in [Shipment.load_demands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment#Google__Cloud__Optimization__V1__Shipment_load_demands_instance_ "Google::Cloud::Optimization::V1::Shipment#load_demands (method)").

### #load_demands=

    def load_demands=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::Google::Cloud::Optimization::V1::Shipment::Load}) --- Load demands of this visit request. This is just like [Shipment.load_demands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment#Google__Cloud__Optimization__V1__Shipment_load_demands_instance_ "Google::Cloud::Optimization::V1::Shipment#load_demands (method)") field, except that it only applies to this [VisitRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment-VisitRequest "Google::Cloud::Optimization::V1::Shipment::VisitRequest (class)") instead of the whole [Shipment](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment "Google::Cloud::Optimization::V1::Shipment (class)"). The demands listed here are added to the demands listed in [Shipment.load_demands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment#Google__Cloud__Optimization__V1__Shipment_load_demands_instance_ "Google::Cloud::Optimization::V1::Shipment#load_demands (method)").
**Returns**

- (::Google::Protobuf::Map{::String =\> ::Google::Cloud::Optimization::V1::Shipment::Load}) --- Load demands of this visit request. This is just like [Shipment.load_demands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment#Google__Cloud__Optimization__V1__Shipment_load_demands_instance_ "Google::Cloud::Optimization::V1::Shipment#load_demands (method)") field, except that it only applies to this [VisitRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment-VisitRequest "Google::Cloud::Optimization::V1::Shipment::VisitRequest (class)") instead of the whole [Shipment](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment "Google::Cloud::Optimization::V1::Shipment (class)"). The demands listed here are added to the demands listed in [Shipment.load_demands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Shipment#Google__Cloud__Optimization__V1__Shipment_load_demands_instance_ "Google::Cloud::Optimization::V1::Shipment#load_demands (method)").

### #tags

    def tags() -> ::Array<::String>

**Returns**

- (::Array\<::String\>) --- Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.

### #tags=

    def tags=(value) -> ::Array<::String>

**Parameter**

- **value** (::Array\<::String\>) --- Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
**Returns**

- (::Array\<::String\>) --- Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.

### #time_windows

    def time_windows() -> ::Array<::Google::Cloud::Optimization::V1::TimeWindow>

**Returns**

- (::Array\<[::Google::Cloud::Optimization::V1::TimeWindow](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-TimeWindow#Google__Cloud__Optimization__V1__TimeWindow_start_time_instance_ "Google::Cloud::Optimization::V1::TimeWindow#start_time (method)").


  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.

### #time_windows=

    def time_windows=(value) -> ::Array<::Google::Cloud::Optimization::V1::TimeWindow>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Optimization::V1::TimeWindow](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-TimeWindow#Google__Cloud__Optimization__V1__TimeWindow_start_time_instance_ "Google::Cloud::Optimization::V1::TimeWindow#start_time (method)").


  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**

- (::Array\<[::Google::Cloud::Optimization::V1::TimeWindow](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-TimeWindow#Google__Cloud__Optimization__V1__TimeWindow_start_time_instance_ "Google::Cloud::Optimization::V1::TimeWindow#start_time (method)").


  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.

### #visit_types

    def visit_types() -> ::Array<::String>

**Returns**

- (::Array\<::String\>) --- 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Vehicle#Google__Cloud__Optimization__V1__Vehicle_extra_visit_duration_for_visit_type_instance_ "Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type (method)")).


  A type can only appear once.

### #visit_types=

    def visit_types=(value) -> ::Array<::String>

**Parameter**

- **value** (::Array\<::String\>) --- 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Vehicle#Google__Cloud__Optimization__V1__Vehicle_extra_visit_duration_for_visit_type_instance_ "Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type (method)")).


  A type can only appear once.
**Returns**

- (::Array\<::String\>) --- 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest/Google-Cloud-Optimization-V1-Vehicle#Google__Cloud__Optimization__V1__Vehicle_extra_visit_duration_for_visit_type_instance_ "Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type (method)")).


  A type can only appear once.