Cloud Optimization V1 API - Class Google::Cloud::Optimization::V1::FleetRouting::Rest::Client (v0.9.1)

Reference documentation and code samples for the Cloud Optimization V1 API class Google::Cloud::Optimization::V1::FleetRouting::Rest::Client.

REST client for the FleetRouting service.

A service for optimizing vehicle tours.

Validity of certain types of fields:

  • google.protobuf.Timestamp
    • Times are in Unix time: seconds since 1970-01-01T00:00:00+00:00.
    • seconds must be in [0, 253402300799], i.e. in [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
    • nanos must be unset or set to 0.
  • google.protobuf.Duration
    • seconds must be in [0, 253402300799], i.e. in [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
    • nanos must be unset or set to 0.
  • google.type.LatLng
    • latitude must be in [-90.0, 90.0].
    • longitude must be in [-180.0, 180.0].
    • at least one of latitude and longitude must be non-zero.

Inherits

  • Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the FleetRouting Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all FleetRouting clients
::Google::Cloud::Optimization::V1::FleetRouting::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#batch_optimize_tours

def batch_optimize_tours(request, options = nil) -> ::Gapic::Operation
def batch_optimize_tours(parent: nil, model_configs: nil) -> ::Gapic::Operation

Optimizes vehicle tours for one or more OptimizeToursRequest messages as a batch.

This method is a Long Running Operation (LRO). The inputs for optimization (OptimizeToursRequest messages) and outputs (OptimizeToursResponse messages) are read/written from/to Cloud Storage in user-specified format. Like the OptimizeTours method, each OptimizeToursRequest contains a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoutes, which are a set of routes to be performed by vehicles minimizing the overall cost.

Overloads 
def batch_optimize_tours(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_optimize_tours via a request object, either of type BatchOptimizeToursRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Optimization::V1::BatchOptimizeToursRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def batch_optimize_tours(parent: nil, model_configs: nil) -> ::Gapic::Operation
Pass arguments to batch_optimize_tours via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Target project and location to make a call.

    Format: projects/{project-id}/locations/{location-id}.

    If no location is specified, a region will be chosen automatically.

  • model_configs (::Array<::Google::Cloud::Optimization::V1::BatchOptimizeToursRequest::AsyncModelConfig, ::Hash>) — Required. Input/Output information each purchase model, such as file paths and data formats.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/optimization/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Optimization::V1::FleetRouting::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Optimization::V1::BatchOptimizeToursRequest.new

# Call the batch_optimize_tours method.
result = client.batch_optimize_tours request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the FleetRouting Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#initialize

def initialize() { |config| ... } -> Client

Create a new FleetRouting REST client object.

Yields
  • (config) — Configure the FleetRouting client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Optimization::V1::FleetRouting::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Optimization::V1::FleetRouting::Rest::Client.new do |config|
  config.timeout = 10.0
end

#operations_client

def operations_client() -> ::Google::Cloud::Optimization::V1::FleetRouting::Rest::Operations

Get the associated client for long-running operations.

Returns

#optimize_tours

def optimize_tours(request, options = nil) -> ::Google::Cloud::Optimization::V1::OptimizeToursResponse
def optimize_tours(parent: nil, timeout: nil, model: nil, solving_mode: nil, search_mode: nil, injected_first_solution_routes: nil, injected_solution_constraint: nil, refresh_details_routes: nil, interpret_injected_solutions_using_labels: nil, consider_road_traffic: nil, populate_polylines: nil, populate_transition_polylines: nil, allow_large_deadline_despite_interruption_risk: nil, use_geodesic_distances: nil, geodesic_meters_per_second: nil, max_validation_errors: nil, label: nil, populate_travel_step_polylines: nil) -> ::Google::Cloud::Optimization::V1::OptimizeToursResponse

Sends an OptimizeToursRequest containing a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoutes, which are a set of routes to be performed by vehicles minimizing the overall cost.

A ShipmentModel model consists mainly of Shipments that need to be carried out and Vehicles that can be used to transport the Shipments. The ShipmentRoutes assign Shipments to Vehicles. More specifically, they assign a series of Visits to each vehicle, where a Visit corresponds to a VisitRequest, which is a pickup or delivery for a Shipment.

The goal is to provide an assignment of ShipmentRoutes to Vehicles that minimizes the total cost where cost has many components defined in the ShipmentModel.

Overloads 
def optimize_tours(request, options = nil) -> ::Google::Cloud::Optimization::V1::OptimizeToursResponse
Pass arguments to optimize_tours via a request object, either of type OptimizeToursRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Optimization::V1::OptimizeToursRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def optimize_tours(parent: nil, timeout: nil, model: nil, solving_mode: nil, search_mode: nil, injected_first_solution_routes: nil, injected_solution_constraint: nil, refresh_details_routes: nil, interpret_injected_solutions_using_labels: nil, consider_road_traffic: nil, populate_polylines: nil, populate_transition_polylines: nil, allow_large_deadline_despite_interruption_risk: nil, use_geodesic_distances: nil, geodesic_meters_per_second: nil, max_validation_errors: nil, label: nil, populate_travel_step_polylines: nil) -> ::Google::Cloud::Optimization::V1::OptimizeToursResponse
Pass arguments to optimize_tours via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Target project and location to make a call.

    Format: projects/{project-id}/locations/{location-id}.

    If no location is specified, a region will be chosen automatically.

  • timeout (::Google::Protobuf::Duration, ::Hash) — If this timeout is set, the server returns a response before the timeout period has elapsed or the server deadline for synchronous requests is reached, whichever is sooner.

    For asynchronous requests, the server will generate a solution (if possible) before the timeout has elapsed.

  • model (::Google::Cloud::Optimization::V1::ShipmentModel, ::Hash) — Shipment model to solve.
  • solving_mode (::Google::Cloud::Optimization::V1::OptimizeToursRequest::SolvingMode) — By default, the solving mode is DEFAULT_SOLVE (0).
  • search_mode (::Google::Cloud::Optimization::V1::OptimizeToursRequest::SearchMode) — Search mode used to solve the request.
  • injected_first_solution_routes (::Array<::Google::Cloud::Optimization::V1::ShipmentRoute, ::Hash>) — Guide the optimization algorithm in finding a first solution that is similar to a previous solution.

    The model is constrained when the first solution is built. Any shipments not performed on a route are implicitly skipped in the first solution, but they may be performed in successive solutions.

    The solution must satisfy some basic validity assumptions:

    • for all routes, vehicle_index must be in range and not be duplicated.
    • for all visits, shipment_index and visit_request_index must be in range.
    • a shipment may only be referenced on one route.
    • the pickup of a pickup-delivery shipment must be performed before the delivery.
    • no more than one pickup alternative or delivery alternative of a shipment may be performed.
    • for all routes, times are increasing (i.e., vehicle_start_time <= visits[0].start_time <= visits[1].start_time ... <= vehicle_end_time).
    • a shipment may only be performed on a vehicle that is allowed. A vehicle is allowed if Shipment.allowed_vehicle_indices is empty or its vehicle_index is included in Shipment.allowed_vehicle_indices.

    If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead.

  • injected_solution_constraint (::Google::Cloud::Optimization::V1::InjectedSolutionConstraint, ::Hash) — Constrain the optimization algorithm to find a final solution that is similar to a previous solution. For example, this may be used to freeze portions of routes which have already been completed or which are to be completed but must not be modified.

    If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead.

  • refresh_details_routes (::Array<::Google::Cloud::Optimization::V1::ShipmentRoute, ::Hash>) — If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated. This does not solve the model.

    As of 2020/11, this only populates the polylines of non-empty routes and requires that populate_polylines is true.

    The route_polyline fields of the passed-in routes may be inconsistent with route transitions.

    This field must not be used together with injected_first_solution_routes or injected_solution_constraint.

    Shipment.ignore and Vehicle.ignore have no effect on the behavior. Polylines are still populated between all visits in all non-empty routes regardless of whether the related shipments or vehicles are ignored.

  • interpret_injected_solutions_using_labels (::Boolean) — If true:

    This interpretation applies to the injected_first_solution_routes, injected_solution_constraint, and refresh_details_routes fields. It can be used when shipment or vehicle indices in the request have changed since the solution was created, perhaps because shipments or vehicles have been removed from or added to the request.

    If true, labels in the following categories must appear at most once in their category:

    If a vehicle_label in the injected solution does not correspond to a request vehicle, the corresponding route is removed from the solution along with its visits. If a shipment_label in the injected solution does not correspond to a request shipment, the corresponding visit is removed from the solution. If a SkippedShipment.label in the injected solution does not correspond to a request shipment, the SkippedShipment is removed from the solution.

    Removing route visits or entire routes from an injected solution may have an effect on the implied constraints, which may lead to change in solution, validation errors, or infeasibility.

    NOTE: The caller must ensure that each Vehicle.label (resp. Shipment.label) uniquely identifies a vehicle (resp. shipment) entity used across the two relevant requests: the past request that produced the OptimizeToursResponse used in the injected solution and the current request that includes the injected solution. The uniqueness checks described above are not enough to guarantee this requirement.

  • consider_road_traffic (::Boolean) — Consider traffic estimation in calculating ShipmentRoute fields Transition.travel_duration, Visit.start_time, and vehicle_end_time; in setting the ShipmentRoute.has_traffic_infeasibilities field, and in calculating the OptimizeToursResponse.total_cost field.
  • populate_polylines (::Boolean) — If true, polylines will be populated in response ShipmentRoutes.
  • populate_transition_polylines (::Boolean) — If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travel_steps.
  • allow_large_deadline_despite_interruption_risk (::Boolean) — If this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines) of up to 60 minutes. Otherwise, the maximum deadline is only 30 minutes. Note that long-lived requests have a significantly larger (but still small) risk of interruption.
  • use_geodesic_distances (::Boolean) — If true, travel distances will be computed using geodesic distances instead of Google Maps distances, and travel times will be computed using geodesic distances with a speed defined by geodesic_meters_per_second.
  • geodesic_meters_per_second (::Float) — When use_geodesic_distances is true, this field must be set and defines the speed applied to compute travel times. Its value must be at least 1.0 meters/seconds.
  • max_validation_errors (::Integer) — Truncates the number of validation errors returned. These errors are typically attached to an INVALID_ARGUMENT error payload as a BadRequest error detail (https://cloud.google.com/apis/design/errors#error_details), unless solving_mode=VALIDATE_ONLY: see the OptimizeToursResponse.validation_errors field. This defaults to 100 and is capped at 10,000.
  • label (::String) — Label that may be used to identify this request, reported back in the OptimizeToursResponse.request_label.
  • populate_travel_step_polylines (::Boolean) — Deprecated: Use OptimizeToursRequest.populate_transition_polylines instead. If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travel_steps.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/optimization/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Optimization::V1::FleetRouting::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Optimization::V1::OptimizeToursRequest.new

# Call the optimize_tours method.
result = client.optimize_tours request

# The returned object is of type Google::Cloud::Optimization::V1::OptimizeToursResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)