proto_docs/google/cloud/optimization/v1/fleet_routing.rb in google-cloud-optimization-v1-0.7.0 vs proto_docs/google/cloud/optimization/v1/fleet_routing.rb in google-cloud-optimization-v1-0.8.0
- old
+ new
@@ -221,10 +221,11 @@
# @!attribute [rw] label
# @return [::String]
# Label that may be used to identify this request, reported back in the
# {::Google::Cloud::Optimization::V1::OptimizeToursResponse#request_label OptimizeToursResponse.request_label}.
# @!attribute [rw] populate_travel_step_polylines
+ # @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Boolean]
# Deprecated: Use
# {::Google::Cloud::Optimization::V1::OptimizeToursRequest#populate_transition_polylines OptimizeToursRequest.populate_transition_polylines}
# instead. If true, polylines will be populated in response
# {::Google::Cloud::Optimization::V1::ShipmentRoute#transitions ShipmentRoute.transitions}.
@@ -303,10 +304,11 @@
# message.
# @!attribute [rw] metrics
# @return [::Google::Cloud::Optimization::V1::OptimizeToursResponse::Metrics]
# Duration, distance and usage metrics for this solution.
# @!attribute [rw] total_cost
+ # @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Float]
# Deprecated: Use
# {::Google::Cloud::Optimization::V1::OptimizeToursResponse::Metrics#total_cost Metrics.total_cost}
# instead. Total cost of the solution. This takes into account all costs:
# costs per per hour and travel hour, fixed vehicle costs, unperformed
@@ -601,10 +603,11 @@
# Sets of `shipment_type` requirements (see `ShipmentTypeRequirement`).
# @!attribute [rw] precedence_rules
# @return [::Array<::Google::Cloud::Optimization::V1::ShipmentModel::PrecedenceRule>]
# Set of precedence rules which must be enforced in the model.
# @!attribute [rw] break_rules
+ # @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Array<::Google::Cloud::Optimization::V1::ShipmentModel::BreakRule>]
# Deprecated: No longer used.
# Set of break rules used in the model.
# Each vehicle specifies the `BreakRule` that applies to it via the
# {::Google::Cloud::Optimization::V1::Vehicle#break_rule_indices Vehicle.break_rule_indices}
@@ -692,10 +695,11 @@
# before or right after a visit, but not in the middle of a visit), in
# which case it extends the corresponding transit time between the visits
# * before the vehicle start (the vehicle may not start in the middle of
# a break), in which case it does not affect the vehicle start time.
# * after the vehicle end (ditto, with the vehicle end time).
+ # @deprecated This message is deprecated and may be removed in the next major version update.
# @!attribute [rw] break_requests
# @return [::Array<::Google::Cloud::Optimization::V1::ShipmentModel::BreakRule::BreakRequest>]
# Sequence of breaks. See the `BreakRequest` message.
# @!attribute [rw] frequency_constraints
# @return [::Array<::Google::Cloud::Optimization::V1::ShipmentModel::BreakRule::FrequencyConstraint>]
@@ -899,10 +903,11 @@
# Ignoring a shipment that is performed in `injected_first_solution_routes`
# or `injected_solution_constraint` is permitted; the solver removes the
# related pickup/delivery visits from the performing route.
# `precedence_rules` that reference ignored shipments will also be ignored.
# @!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#load_demands Shipment.load_demands}
# instead.
class Shipment
@@ -986,10 +991,11 @@
# @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
@@ -1334,28 +1340,32 @@
# constrained to remain on the vehicle (i.e., not relaxed to level
# `RELAX_ALL_AFTER_THRESHOLD`), it is skipped in the response.
# If a shipment has a non-empty `allowed_vehicle_indices` field and all of
# the allowed vehicles are ignored, it is skipped in the response.
# @!attribute [rw] break_rule_indices
+ # @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Array<::Integer>]
# Deprecated: No longer used.
# Indices in the `break_rule` field in the source
# {::Google::Cloud::Optimization::V1::ShipmentModel ShipmentModel}. They
# correspond to break rules enforced on the vehicle.
#
# As of 2018/03, at most one rule index per vehicle can be specified.
# @!attribute [rw] capacities
+ # @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::Vehicle#load_limits Vehicle.load_limits}
# instead.
# @!attribute [rw] start_load_intervals
+ # @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>]
# Deprecated: Use
# {::Google::Cloud::Optimization::V1::Vehicle::LoadLimit#start_load_interval Vehicle.LoadLimit.start_load_interval}
# instead.
# @!attribute [rw] end_load_intervals
+ # @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>]
# Deprecated: Use
# {::Google::Cloud::Optimization::V1::Vehicle::LoadLimit#end_load_interval Vehicle.LoadLimit.end_load_interval}
# instead.
class Vehicle
@@ -1589,10 +1599,11 @@
end
# Deprecated: Use
# {::Google::Cloud::Optimization::V1::Vehicle::LoadLimit::Interval Vehicle.LoadLimit.Interval}
# instead.
+ # @deprecated This message is deprecated and may be removed in the next major version update.
# @!attribute [rw] type
# @return [::String]
# @!attribute [rw] value
# @return [::Integer]
class CapacityQuantity
@@ -1601,10 +1612,11 @@
end
# Deprecated: Use
# {::Google::Cloud::Optimization::V1::Vehicle::LoadLimit::Interval Vehicle.LoadLimit.Interval}
# instead.
+ # @deprecated This message is deprecated and may be removed in the next major version update.
# @!attribute [rw] type
# @return [::String]
# @!attribute [rw] min_value
# @return [::Integer]
# @!attribute [rw] max_value
@@ -1994,25 +2006,28 @@
# that are only reported in an aggregated way as of 2022/01.
# @!attribute [rw] route_total_cost
# @return [::Float]
# Total cost of the route. The sum of all costs in the cost map.
# @!attribute [rw] end_loads
+ # @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::ShipmentRoute::Transition#vehicle_loads Transition.vehicle_loads}
# instead. Vehicle loads upon arrival at its end location, for each type
# specified in
# {::Google::Cloud::Optimization::V1::Vehicle#capacities Vehicle.capacities},
# `start_load_intervals`, `end_load_intervals` or demands. Exception: we omit
# loads for quantity types unconstrained by intervals and that don't have any
# non-zero demand on the route.
# @!attribute [rw] travel_steps
+ # @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Array<::Google::Cloud::Optimization::V1::ShipmentRoute::TravelStep>]
# Deprecated: Use
# {::Google::Cloud::Optimization::V1::ShipmentRoute#transitions ShipmentRoute.transitions}
# instead. Ordered list of travel steps for the route.
# @!attribute [rw] vehicle_detour
+ # @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Google::Protobuf::Duration]
# Deprecated: No longer used.
# This field will only be populated at the
# {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}
# level.
@@ -2021,10 +2036,11 @@
# route.
#
# It is equal to `vehicle_end_time` - `vehicle_start_time` - travel duration
# from the vehicle's start_location to its `end_location`.
# @!attribute [rw] delay_before_vehicle_end
+ # @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Google::Cloud::Optimization::V1::ShipmentRoute::Delay]
# Deprecated: Delay occurring before the vehicle end. See
# {::Google::Cloud::Optimization::V1::TransitionAttributes#delay TransitionAttributes.delay}.
class ShipmentRoute
include ::Google::Protobuf::MessageExts
@@ -2032,10 +2048,11 @@
# Deprecated: Use
# {::Google::Cloud::Optimization::V1::ShipmentRoute::Transition#delay_duration ShipmentRoute.Transition.delay_duration}
# instead. Time interval spent on the route resulting from a
# {::Google::Cloud::Optimization::V1::TransitionAttributes#delay TransitionAttributes.delay}.
+ # @deprecated This message is deprecated and may be removed in the next major version update.
# @!attribute [rw] start_time
# @return [::Google::Protobuf::Timestamp]
# Start of the delay.
# @!attribute [rw] duration
# @return [::Google::Protobuf::Duration]
@@ -2096,10 +2113,11 @@
# @return [::String]
# Copy of the corresponding
# {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#label VisitRequest.label},
# if specified in the `VisitRequest`.
# @!attribute [rw] arrival_loads
+ # @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::ShipmentRoute::Transition#vehicle_loads Transition.vehicle_loads}
# instead. Vehicle loads upon arrival at the visit location, for each type
# specified in
@@ -2107,15 +2125,17 @@
# `start_load_intervals`, `end_load_intervals` or `demands`.
#
# Exception: we omit loads for quantity types unconstrained by intervals
# and that don't have any non-zero demand on the route.
# @!attribute [rw] delay_before_start
+ # @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Google::Cloud::Optimization::V1::ShipmentRoute::Delay]
# Deprecated: Use
# {::Google::Cloud::Optimization::V1::ShipmentRoute::Transition#delay_duration ShipmentRoute.Transition.delay_duration}
# instead. Delay occurring before the visit starts.
# @!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::ShipmentRoute::Visit#load_demands Visit.load_demands}
# instead.
class Visit
@@ -2199,10 +2219,11 @@
# The loads during the first transition are the starting loads of the
# vehicle route. Then, after each visit, the visit's `load_demands` are
# either added or subtracted to get the next transition's loads, depending
# on whether the visit was a pickup or a delivery.
# @!attribute [rw] loads
+ # @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::ShipmentRoute::Transition#vehicle_loads Transition.vehicle_loads}
# instead.
class Transition
@@ -2268,10 +2289,11 @@
#
# Invariant: `travel_steps_size() == visits_size() + 1`.
#
# If the vehicle does not have a start_ and/or end_location, the
# corresponding travel metrics are 0 and/or empty.
+ # @deprecated This message is deprecated and may be removed in the next major version update.
# @!attribute [rw] duration
# @return [::Google::Protobuf::Duration]
# Duration of the travel step.
# @!attribute [rw] distance_meters
# @return [::Float]
@@ -2457,16 +2479,18 @@
# all
# {::Google::Cloud::Optimization::V1::ShipmentRoute::Transition#vehicle_loads Transition.vehicle_loads}
# (resp.
# {::Google::Cloud::Optimization::V1::AggregatedMetrics#max_loads ShipmentRoute.metrics.max_loads}.
# @!attribute [rw] costs
+ # @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Google::Protobuf::Map{::String => ::Float}]
# Deprecated: Use
# {::Google::Cloud::Optimization::V1::ShipmentRoute#route_costs ShipmentRoute.route_costs}
# and
# {::Google::Cloud::Optimization::V1::OptimizeToursResponse::Metrics#costs OptimizeToursResponse.Metrics.costs}
# instead.
# @!attribute [rw] total_cost
+ # @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Float]
# Deprecated: Use
# {::Google::Cloud::Optimization::V1::ShipmentRoute#route_total_cost ShipmentRoute.route_total_cost}
# and
# {::Google::Cloud::Optimization::V1::OptimizeToursResponse::Metrics#total_cost OptimizeToursResponse.Metrics.total_cost}