Reference documentation and code samples for the Google Cloud Optimization V1 Client class FleetRoutingClient.
Service Description: 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.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$fleetRoutingClient = new FleetRoutingClient();
try {
$parent = 'parent';
$modelConfigs = [];
$operationResponse = $fleetRoutingClient->batchOptimizeTours($parent, $modelConfigs);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $fleetRoutingClient->batchOptimizeTours($parent, $modelConfigs);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $fleetRoutingClient->resumeOperation($operationName, 'batchOptimizeTours');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$fleetRoutingClient->close();
}
This service has a new (beta) implementation. See Google\Cloud\Optimization\V1\Client\FleetRoutingClient to use the new surface.
Namespace
Google \ Cloud \ Optimization \ V1Methods
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ clientConfig
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
batchOptimizeTours
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 ShipmentRoute
s, which are a set of routes to be performed by
vehicles minimizing the overall cost.
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.
modelConfigs
array< Google\Cloud\Optimization\V1\BatchOptimizeToursRequest\AsyncModelConfig
>
Required. Input/Output information each purchase model, such as file paths and data formats.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Optimization\V1\BatchOptimizeToursRequest;
use Google\Cloud\Optimization\V1\BatchOptimizeToursRequest\AsyncModelConfig;
use Google\Cloud\Optimization\V1\BatchOptimizeToursResponse;
use Google\Cloud\Optimization\V1\Client\FleetRoutingClient;
use Google\Cloud\Optimization\V1\InputConfig;
use Google\Cloud\Optimization\V1\OutputConfig;
use Google\Rpc\Status;
/**
* @param string $parent 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.
*/
function batch_optimize_tours_sample(string $parent): void
{
// Create a client.
$fleetRoutingClient = new FleetRoutingClient();
// Prepare the request message.
$modelConfigsInputConfig = new InputConfig();
$modelConfigsOutputConfig = new OutputConfig();
$asyncModelConfig = (new AsyncModelConfig())
->setInputConfig($modelConfigsInputConfig)
->setOutputConfig($modelConfigsOutputConfig);
$modelConfigs = [$asyncModelConfig,];
$request = (new BatchOptimizeToursRequest())
->setParent($parent)
->setModelConfigs($modelConfigs);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $fleetRoutingClient->batchOptimizeTours($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var BatchOptimizeToursResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$parent = '[PARENT]';
batch_optimize_tours_sample($parent);
}
optimizeTours
Sends an OptimizeToursRequest
containing a ShipmentModel
and returns an OptimizeToursResponse
containing ShipmentRoute
s, which are a set of
routes to be performed by vehicles minimizing the overall cost.
A ShipmentModel
model consists mainly of Shipment
s that need to be
carried out and Vehicle
s that can be used to transport the Shipment
s.
The ShipmentRoute
s assign Shipment
s to Vehicle
s. More specifically,
they assign a series of Visit
s 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 ShipmentRoute
s to Vehicle
s that
minimizes the total cost where cost has many components defined in the ShipmentModel
.
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.
optionalArgs
array
Optional.
↳ timeout
Duration
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
ShipmentModel
Shipment model to solve.
↳ solvingMode
int
By default, the solving mode is DEFAULT_SOLVE
(0). For allowed values, use constants defined on Google\Cloud\Optimization\V1\OptimizeToursRequest\SolvingMode
↳ searchMode
int
Search mode used to solve the request. For allowed values, use constants defined on Google\Cloud\Optimization\V1\OptimizeToursRequest\SearchMode
↳ injectedFirstSolutionRoutes
ShipmentRoute[]
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.
↳ injectedSolutionConstraint
InjectedSolutionConstraint
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.
↳ refreshDetailsRoutes
ShipmentRoute[]
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.
↳ interpretInjectedSolutionsUsingLabels
bool
If true: * uses ShipmentRoute.vehicle_label
instead of vehicle_index
to match routes in an injected solution with vehicles in the request; reuses the mapping of original ShipmentRoute.vehicle_index
to new ShipmentRoute.vehicle_index
to update ConstraintRelaxation.vehicle_indices
if non-empty, but the mapping must be unambiguous (i.e., multiple ShipmentRoute
s must not share the same original vehicle_index
). * uses ShipmentRoute.Visit.shipment_label
instead of shipment_index
to match visits in an injected solution with shipments in the request; * uses SkippedShipment.label
instead of SkippedShipment.index
to match skipped shipments in the injected solution with request shipments. 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: * Vehicle.label
in the request; * Shipment.label
in the request; * ShipmentRoute.vehicle_label
in the injected solution; * SkippedShipment.label
and ShipmentRoute.Visit.shipment_label
in the injected solution (except pickup/delivery visit pairs, whose shipment_label
must appear twice). 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.
↳ considerRoadTraffic
bool
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.
↳ populatePolylines
bool
If true, polylines will be populated in response ShipmentRoute
s.
↳ populateTransitionPolylines
bool
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
.
↳ allowLargeDeadlineDespiteInterruptionRisk
bool
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.
↳ useGeodesicDistances
bool
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
.
↳ geodesicMetersPerSecond
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.
↳ maxValidationErrors
int
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 .
↳ populateTravelStepPolylines
bool
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
.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\Cloud\Optimization\V1\Client\FleetRoutingClient;
use Google\Cloud\Optimization\V1\OptimizeToursRequest;
use Google\Cloud\Optimization\V1\OptimizeToursResponse;
/**
* @param string $parent 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.
*/
function optimize_tours_sample(string $parent): void
{
// Create a client.
$fleetRoutingClient = new FleetRoutingClient();
// Prepare the request message.
$request = (new OptimizeToursRequest())
->setParent($parent);
// Call the API and handle any network failures.
try {
/** @var OptimizeToursResponse $response */
$response = $fleetRoutingClient->optimizeTours($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$parent = '[PARENT]';
optimize_tours_sample($parent);
}
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
Constants
SERVICE_NAME
Value: 'google.cloud.optimization.v1.FleetRouting'
The name of the service.
SERVICE_ADDRESS
Value: 'cloudoptimization.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.
