Class FleetRoutingClient (1.6.0)

public class FleetRoutingClient implements BackgroundResource

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:


 // This snippet 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 as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FleetRoutingClient fleetRoutingClient = FleetRoutingClient.create()) {
   OptimizeToursRequest request =
       OptimizeToursRequest.newBuilder()
           .setParent("parent-995424086")
           .setTimeout(Duration.newBuilder().build())
           .setModel(ShipmentModel.newBuilder().build())
           .setMaxValidationErrors(-1367418922)
           .addAllInjectedFirstSolutionRoutes(new ArrayList<ShipmentRoute>())
           .setInjectedSolutionConstraint(InjectedSolutionConstraint.newBuilder().build())
           .addAllRefreshDetailsRoutes(new ArrayList<ShipmentRoute>())
           .setInterpretInjectedSolutionsUsingLabels(true)
           .setConsiderRoadTraffic(true)
           .setPopulatePolylines(true)
           .setPopulateTransitionPolylines(true)
           .setAllowLargeDeadlineDespiteInterruptionRisk(true)
           .setUseGeodesicDistances(true)
           .setGeodesicMetersPerSecond(-2129658905)
           .setLabel("label102727412")
           .setPopulateTravelStepPolylines(true)
           .build();
   OptimizeToursResponse response = fleetRoutingClient.optimizeTours(request);
 }

Note: close() needs to be called on the FleetRoutingClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of FleetRoutingSettings to create(). For example:

To customize credentials:


 // This snippet 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 as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 FleetRoutingSettings fleetRoutingSettings =
     FleetRoutingSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FleetRoutingClient fleetRoutingClient = FleetRoutingClient.create(fleetRoutingSettings);

To customize the endpoint:


 // This snippet 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 as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 FleetRoutingSettings fleetRoutingSettings =
     FleetRoutingSettings.newBuilder().setEndpoint(myEndpoint).build();
 FleetRoutingClient fleetRoutingClient = FleetRoutingClient.create(fleetRoutingSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet 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 as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 FleetRoutingSettings fleetRoutingSettings = FleetRoutingSettings.newHttpJsonBuilder().build();
 FleetRoutingClient fleetRoutingClient = FleetRoutingClient.create(fleetRoutingSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > FleetRoutingClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final FleetRoutingClient create()

Constructs an instance of FleetRoutingClient with default settings.

Returns

Type	Description
FleetRoutingClient

Exceptions

Type	Description
IOException

create(FleetRoutingSettings settings)

public static final FleetRoutingClient create(FleetRoutingSettings settings)

Constructs an instance of FleetRoutingClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter

Name	Description
settings	`FleetRoutingSettings`

Returns

Type	Description
FleetRoutingClient

Exceptions

Type	Description
IOException

create(FleetRoutingStub stub)

public static final FleetRoutingClient create(FleetRoutingStub stub)

Constructs an instance of FleetRoutingClient, using the given stub for making calls. This is for advanced usage - prefer using create(FleetRoutingSettings).

Parameter

Name	Description
stub	`FleetRoutingStub`

Returns

Type	Description
FleetRoutingClient

Constructors

FleetRoutingClient(FleetRoutingSettings settings)

protected FleetRoutingClient(FleetRoutingSettings settings)

Constructs an instance of FleetRoutingClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter

Name	Description
settings	`FleetRoutingSettings`

FleetRoutingClient(FleetRoutingStub stub)

protected FleetRoutingClient(FleetRoutingStub stub)

Parameter

Name	Description
stub	`FleetRoutingStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	`long`
unit	`TimeUnit`

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

batchOptimizeToursAsync(BatchOptimizeToursRequest request)

public final OperationFuture<BatchOptimizeToursResponse,AsyncModelMetadata> batchOptimizeToursAsync(BatchOptimizeToursRequest request)

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.

Sample code:


 // This snippet 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 as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FleetRoutingClient fleetRoutingClient = FleetRoutingClient.create()) {
   BatchOptimizeToursRequest request =
       BatchOptimizeToursRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllModelConfigs(new ArrayList<BatchOptimizeToursRequest.AsyncModelConfig>())
           .build();
   BatchOptimizeToursResponse response =
       fleetRoutingClient.batchOptimizeToursAsync(request).get();
 }

Parameter

Name	Description
request	`BatchOptimizeToursRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<BatchOptimizeToursResponse,AsyncModelMetadata>

batchOptimizeToursCallable()

public final UnaryCallable<BatchOptimizeToursRequest,Operation> batchOptimizeToursCallable()

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

Sample code:


 // This snippet 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 as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FleetRoutingClient fleetRoutingClient = FleetRoutingClient.create()) {
   BatchOptimizeToursRequest request =
       BatchOptimizeToursRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllModelConfigs(new ArrayList<BatchOptimizeToursRequest.AsyncModelConfig>())
           .build();
   ApiFuture<Operation> future =
       fleetRoutingClient.batchOptimizeToursCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<BatchOptimizeToursRequest,Operation>

batchOptimizeToursOperationCallable()

public final OperationCallable<BatchOptimizeToursRequest,BatchOptimizeToursResponse,AsyncModelMetadata> batchOptimizeToursOperationCallable()

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

Sample code:


 // This snippet 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 as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FleetRoutingClient fleetRoutingClient = FleetRoutingClient.create()) {
   BatchOptimizeToursRequest request =
       BatchOptimizeToursRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllModelConfigs(new ArrayList<BatchOptimizeToursRequest.AsyncModelConfig>())
           .build();
   OperationFuture<BatchOptimizeToursResponse, AsyncModelMetadata> future =
       fleetRoutingClient.batchOptimizeToursOperationCallable().futureCall(request);
   // Do something.
   BatchOptimizeToursResponse response = future.get();
 }

Returns

Type	Description
OperationCallable<BatchOptimizeToursRequest,BatchOptimizeToursResponse,AsyncModelMetadata>

close()

public final void close()

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getSettings()

public final FleetRoutingSettings getSettings()

Returns

Type	Description
FleetRoutingSettings

getStub()

public FleetRoutingStub getStub()

Returns

Type	Description
FleetRoutingStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

optimizeTours(OptimizeToursRequest request)

public final OptimizeToursResponse optimizeTours(OptimizeToursRequest request)

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.

Sample code:


 // This snippet 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 as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FleetRoutingClient fleetRoutingClient = FleetRoutingClient.create()) {
   OptimizeToursRequest request =
       OptimizeToursRequest.newBuilder()
           .setParent("parent-995424086")
           .setTimeout(Duration.newBuilder().build())
           .setModel(ShipmentModel.newBuilder().build())
           .setMaxValidationErrors(-1367418922)
           .addAllInjectedFirstSolutionRoutes(new ArrayList<ShipmentRoute>())
           .setInjectedSolutionConstraint(InjectedSolutionConstraint.newBuilder().build())
           .addAllRefreshDetailsRoutes(new ArrayList<ShipmentRoute>())
           .setInterpretInjectedSolutionsUsingLabels(true)
           .setConsiderRoadTraffic(true)
           .setPopulatePolylines(true)
           .setPopulateTransitionPolylines(true)
           .setAllowLargeDeadlineDespiteInterruptionRisk(true)
           .setUseGeodesicDistances(true)
           .setGeodesicMetersPerSecond(-2129658905)
           .setLabel("label102727412")
           .setPopulateTravelStepPolylines(true)
           .build();
   OptimizeToursResponse response = fleetRoutingClient.optimizeTours(request);
 }

Parameter

Name	Description
request	`OptimizeToursRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OptimizeToursResponse

optimizeToursCallable()

public final UnaryCallable<OptimizeToursRequest,OptimizeToursResponse> optimizeToursCallable()

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.

Sample code:


 // This snippet 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 as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FleetRoutingClient fleetRoutingClient = FleetRoutingClient.create()) {
   OptimizeToursRequest request =
       OptimizeToursRequest.newBuilder()
           .setParent("parent-995424086")
           .setTimeout(Duration.newBuilder().build())
           .setModel(ShipmentModel.newBuilder().build())
           .setMaxValidationErrors(-1367418922)
           .addAllInjectedFirstSolutionRoutes(new ArrayList<ShipmentRoute>())
           .setInjectedSolutionConstraint(InjectedSolutionConstraint.newBuilder().build())
           .addAllRefreshDetailsRoutes(new ArrayList<ShipmentRoute>())
           .setInterpretInjectedSolutionsUsingLabels(true)
           .setConsiderRoadTraffic(true)
           .setPopulatePolylines(true)
           .setPopulateTransitionPolylines(true)
           .setAllowLargeDeadlineDespiteInterruptionRisk(true)
           .setUseGeodesicDistances(true)
           .setGeodesicMetersPerSecond(-2129658905)
           .setLabel("label102727412")
           .setPopulateTravelStepPolylines(true)
           .build();
   ApiFuture<OptimizeToursResponse> future =
       fleetRoutingClient.optimizeToursCallable().futureCall(request);
   // Do something.
   OptimizeToursResponse response = future.get();
 }

Returns

Type	Description
UnaryCallable<OptimizeToursRequest,OptimizeToursResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()