Class: Google::Cloud::Optimization::V1::Shipment

Inherits:

Object

• Object
• Google::Cloud::Optimization::V1::Shipment

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/optimization/v1/fleet_routing.rb

Overview

The shipment of a single item, from one of its pickups to one of its deliveries. For the shipment to be considered as performed, a unique vehicle must visit one of its pickup locations (and decrease its spare capacities accordingly), then visit one of its delivery locations later on (and therefore re-increase its spare capacities accordingly).

Defined Under Namespace

Classes: Load, LoadDemandsEntry, VisitRequest

Instance Attribute Summary

• #allowed_vehicle_indices ⇒ ::Array<::Integer>

  The set of vehicles that may perform this shipment.

• #costs_per_vehicle ⇒ ::Array<::Float>

  Specifies the cost that is incurred when this shipment is delivered by each vehicle.

• #costs_per_vehicle_indices ⇒ ::Array<::Integer>

  Indices of the vehicles to which costs_per_vehicle applies.

• #deliveries ⇒ ::Array<::Google::Cloud::Optimization::V1::Shipment::VisitRequest>

  Set of delivery alternatives associated to the shipment.

• #demands ⇒ ::Array<::Google::Cloud::Optimization::V1::CapacityQuantity> deprecated Deprecated.

  This field is deprecated and may be removed in the next major version update.

• #ignore ⇒ ::Boolean

  If true, skip this shipment, but don't apply a penalty_cost.

• #label ⇒ ::String

  Specifies a label for this shipment.

• #load_demands ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}

  Load demands of the shipment (for example weight, volume, number of pallets etc).

• #penalty_cost ⇒ ::Float

  If the shipment is not completed, this penalty is added to the overall cost of the routes.

• #pickup_to_delivery_absolute_detour_limit ⇒ ::Google::Protobuf::Duration

  Specifies the maximum absolute detour time compared to the shortest path from pickup to delivery.

• #pickup_to_delivery_relative_detour_limit ⇒ ::Float

  Specifies the maximum relative detour time compared to the shortest path from pickup to delivery.

• #pickup_to_delivery_time_limit ⇒ ::Google::Protobuf::Duration

  Specifies the maximum duration from start of pickup to start of delivery of a shipment.

• #pickups ⇒ ::Array<::Google::Cloud::Optimization::V1::Shipment::VisitRequest>

  Set of pickup alternatives associated to the shipment.

• #shipment_type ⇒ ::String

  Non-empty string specifying a "type" for this shipment.

Instance Attribute Details

#allowed_vehicle_indices ⇒ ::Array<::Integer>

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#costs_per_vehicle ⇒ ::Array<::Float>

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#costs_per_vehicle_indices ⇒ ::Array<::Integer>

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#deliveries ⇒ ::Array<::Google::Cloud::Optimization::V1::Shipment::VisitRequest>

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#demands ⇒ ::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated: Use Shipment.load_demands instead.

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ignore ⇒ ::Boolean

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#label ⇒ ::String

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#load_demands ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#penalty_cost ⇒ ::Float

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pickup_to_delivery_absolute_detour_limit ⇒ ::Google::Protobuf::Duration

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pickup_to_delivery_relative_detour_limit ⇒ ::Float

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pickup_to_delivery_time_limit ⇒ ::Google::Protobuf::Duration

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pickups ⇒ ::Array<::Google::Cloud::Optimization::V1::Shipment::VisitRequest>

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#shipment_type ⇒ ::String

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 913

class Shipment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] arrival_location
  #   @return [::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.
  # @!attribute [rw] arrival_waypoint
  #   @return [::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.
  # @!attribute [rw] departure_location
  #   @return [::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.
  # @!attribute [rw] departure_waypoint
  #   @return [::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.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Specifies tags attached to the visit request.
  #     Empty or duplicate strings are not allowed.
  # @!attribute [rw] time_windows
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::TimeWindow#start_time 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.
  # @!attribute [rw] duration
  #   @return [::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`).
  # @!attribute [rw] cost
  #   @return [::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.
  # @!attribute [rw] load_demands
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}]
  #     Load demands of this visit request. This is just like
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
  #     field, except that it only applies to this
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest VisitRequest}
  #     instead of the whole {::Google::Cloud::Optimization::V1::Shipment Shipment}.
  #     The demands listed here are added to the demands listed in
  #     {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}.
  # @!attribute [rw] visit_types
  #   @return [::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
  #     {::Google::Cloud::Optimization::V1::Vehicle#extra_visit_duration_for_visit_type Vehicle.extra_visit_duration_for_visit_type}).
  #
  #     A type can only appear once.
  # @!attribute [rw] label
  #   @return [::String]
  #     Specifies a label for this `VisitRequest`. This label is reported in the
  #     response as `visit_label` in the corresponding
  #     {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
  # @!attribute [rw] demands
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
  #     Deprecated: Use
  #     {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
  #     instead.
  class VisitRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
    class LoadDemandsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # When performing a visit, a predefined amount may be added to the vehicle
  # load if it's a pickup, or subtracted if it's a delivery. This message
  # defines such amount. See
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands load_demands}.
  # @!attribute [rw] amount
  #   @return [::Integer]
  #     The amount by which the load of the vehicle performing the corresponding
  #     visit will vary. Since it is an integer, users are advised to choose an
  #     appropriate unit to avoid loss of precision. Must be ≥ 0.
  class Load
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end