RoutesClient (Google Routes API 1.48.0 API)

java.lang.Object
- com.google.maps.routing.v2.RoutesClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class RoutesClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The Routes API.

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 (RoutesClient routesClient = RoutesClient.create()) {
   ComputeRoutesRequest request =
       ComputeRoutesRequest.newBuilder()
           .setOrigin(Waypoint.newBuilder().build())
           .setDestination(Waypoint.newBuilder().build())
           .addAllIntermediates(new ArrayList<Waypoint>())
           .setTravelMode(RouteTravelMode.forNumber(0))
           .setRoutingPreference(RoutingPreference.forNumber(0))
           .setPolylineQuality(PolylineQuality.forNumber(0))
           .setPolylineEncoding(PolylineEncoding.forNumber(0))
           .setDepartureTime(Timestamp.newBuilder().build())
           .setArrivalTime(Timestamp.newBuilder().build())
           .setComputeAlternativeRoutes(true)
           .setRouteModifiers(RouteModifiers.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setRegionCode("regionCode-1991004415")
           .setUnits(Units.forNumber(0))
           .setOptimizeWaypointOrder(true)
           .addAllRequestedReferenceRoutes(new ArrayList<ComputeRoutesRequest.ReferenceRoute>())
           .addAllExtraComputations(new ArrayList<ComputeRoutesRequest.ExtraComputation>())
           .setTrafficModel(TrafficModel.forNumber(0))
           .setTransitPreferences(TransitPreferences.newBuilder().build())
           .build();
   ComputeRoutesResponse response = routesClient.computeRoutes(request);
 }

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

Methods
Method	Description	Method Variants
ComputeRoutes	Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints. NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using URL parameter `$fields` or `fields`, or by using an HTTP/gRPC header `X-Goog-FieldMask` (see the [available URL parameters and headers](https://cloud.google.com/apis/docs/system-parameters)). The value is a comma separated list of field paths. See detailed documentation about [how to construct the field paths](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto). For example, in this method: Field mask of all available fields (for manual inspection): `X-Goog-FieldMask: ` Field mask of Route-level duration, distance, and polyline (an example production setup): `X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline` Google discourage the use of the wildcard (``) response field mask, or specifying the field mask at the top level (`routes`), because: Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency. Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response. Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.	Request object method variants only take one parameter, a request object, which must be constructed before the call. computeRoutes(ComputeRoutesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. computeRoutesCallable()
ComputeRouteMatrix	Takes in a list of origins and destinations and returns a stream containing route information for each combination of origin and destination. NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using the URL parameter `$fields` or `fields`, or by using the HTTP/gRPC header `X-Goog-FieldMask` (see the [available URL parameters and headers](https://cloud.google.com/apis/docs/system-parameters)). The value is a comma separated list of field paths. See this detailed documentation about [how to construct the field paths](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto). For example, in this method: Field mask of all available fields (for manual inspection): `X-Goog-FieldMask: ` Field mask of route durations, distances, element status, condition, and element indices (an example production setup): `X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration` It is critical that you include `status` in your field mask as otherwise all messages will appear to be OK. Google discourages the use of the wildcard (``) response field mask, because: Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency. Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response. Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.	Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. computeRouteMatrixCallable()

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 RoutesSettings 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
 RoutesSettings routesSettings =
     RoutesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RoutesClient routesClient = RoutesClient.create(routesSettings);

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
 RoutesSettings routesSettings = RoutesSettings.newBuilder().setEndpoint(myEndpoint).build();
 RoutesClient routesClient = RoutesClient.create(routesSettings);

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
 RoutesSettings routesSettings = RoutesSettings.newHttpJsonBuilder().build();
 RoutesClient routesClient = RoutesClient.create(routesSettings);

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RoutesClient(RoutesSettings settings)` Constructs an instance of RoutesClient, using the given settings.
`protected`	`RoutesClient(RoutesStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`com.google.api.gax.rpc.ServerStreamingCallable<ComputeRouteMatrixRequest,RouteMatrixElement>`	`computeRouteMatrixCallable()` Takes in a list of origins and destinations and returns a stream containing route information for each combination of origin and destination.
`ComputeRoutesResponse`	`computeRoutes(ComputeRoutesRequest request)` Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints.
`com.google.api.gax.rpc.UnaryCallable<ComputeRoutesRequest,ComputeRoutesResponse>`	`computeRoutesCallable()` Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints.
`static RoutesClient`	`create()` Constructs an instance of RoutesClient with default settings.
`static RoutesClient`	`create(RoutesSettings settings)` Constructs an instance of RoutesClient, using the given settings.
`static RoutesClient`	`create(RoutesStub stub)` Constructs an instance of RoutesClient, using the given stub for making calls.
`RoutesSettings`	`getSettings()`
`RoutesStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RoutesClient
```
protected RoutesClient(RoutesSettings settings)
                throws IOException
```
    Constructs an instance of RoutesClient, 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.
    
    Throws:
    
    IOException
  - RoutesClient
```
protected RoutesClient(RoutesStub stub)
```
- Method Detail
  - create
```
public static final RoutesClient create()
                                 throws IOException
```
    Constructs an instance of RoutesClient with default settings.
    
    Throws:
    
    IOException
  - create
```
public static final RoutesClient create(RoutesSettings settings)
                                 throws IOException
```
    Constructs an instance of RoutesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
    
    Throws:
    
    IOException
  - create
```
public static final RoutesClient create(RoutesStub stub)
```
    Constructs an instance of RoutesClient, using the given stub for making calls. This is for advanced usage - prefer using create(RoutesSettings).
  - getSettings
```
public final RoutesSettings getSettings()
```
  - getStub
```
public RoutesStub getStub()
```
  - computeRoutes
```
public final ComputeRoutesResponse computeRoutes(ComputeRoutesRequest request)
```
    Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints.
    **NOTE:** This method requires that you specify a response field mask in the input. You can provide the response field mask by using URL parameter `$fields` or `fields`, or by using an HTTP/gRPC header `X-Goog-FieldMask` (see the [available URL parameters and headers](https://cloud.google.com/apis/docs/system-parameters)). The value is a comma separated list of field paths. See detailed documentation about [how to construct the field paths](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto).
    For example, in this method:
    - Field mask of all available fields (for manual inspection): `X-Goog-FieldMask: *`
    - Field mask of Route-level duration, distance, and polyline (an example production setup): `X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline`
    Google discourage the use of the wildcard (`*`) response field mask, or specifying the field mask at the top level (`routes`), because:
    - Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
    - Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
    - Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.
    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 (RoutesClient routesClient = RoutesClient.create()) {
   ComputeRoutesRequest request =
       ComputeRoutesRequest.newBuilder()
           .setOrigin(Waypoint.newBuilder().build())
           .setDestination(Waypoint.newBuilder().build())
           .addAllIntermediates(new ArrayList<Waypoint>())
           .setTravelMode(RouteTravelMode.forNumber(0))
           .setRoutingPreference(RoutingPreference.forNumber(0))
           .setPolylineQuality(PolylineQuality.forNumber(0))
           .setPolylineEncoding(PolylineEncoding.forNumber(0))
           .setDepartureTime(Timestamp.newBuilder().build())
           .setArrivalTime(Timestamp.newBuilder().build())
           .setComputeAlternativeRoutes(true)
           .setRouteModifiers(RouteModifiers.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setRegionCode("regionCode-1991004415")
           .setUnits(Units.forNumber(0))
           .setOptimizeWaypointOrder(true)
           .addAllRequestedReferenceRoutes(new ArrayList<ComputeRoutesRequest.ReferenceRoute>())
           .addAllExtraComputations(new ArrayList<ComputeRoutesRequest.ExtraComputation>())
           .setTrafficModel(TrafficModel.forNumber(0))
           .setTransitPreferences(TransitPreferences.newBuilder().build())
           .build();
   ComputeRoutesResponse response = routesClient.computeRoutes(request);
 }
 
```
    Parameters:
    
    request - The request object containing all of the parameters for the API call.
    
    Throws:
    
    com.google.api.gax.rpc.ApiException - if the remote call fails
  - computeRoutesCallable
```
public final com.google.api.gax.rpc.UnaryCallable<ComputeRoutesRequest,ComputeRoutesResponse> computeRoutesCallable()
```
    Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints.
    **NOTE:** This method requires that you specify a response field mask in the input. You can provide the response field mask by using URL parameter `$fields` or `fields`, or by using an HTTP/gRPC header `X-Goog-FieldMask` (see the [available URL parameters and headers](https://cloud.google.com/apis/docs/system-parameters)). The value is a comma separated list of field paths. See detailed documentation about [how to construct the field paths](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto).
    For example, in this method:
    - Field mask of all available fields (for manual inspection): `X-Goog-FieldMask: *`
    - Field mask of Route-level duration, distance, and polyline (an example production setup): `X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline`
    Google discourage the use of the wildcard (`*`) response field mask, or specifying the field mask at the top level (`routes`), because:
    - Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
    - Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
    - Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.
    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 (RoutesClient routesClient = RoutesClient.create()) {
   ComputeRoutesRequest request =
       ComputeRoutesRequest.newBuilder()
           .setOrigin(Waypoint.newBuilder().build())
           .setDestination(Waypoint.newBuilder().build())
           .addAllIntermediates(new ArrayList<Waypoint>())
           .setTravelMode(RouteTravelMode.forNumber(0))
           .setRoutingPreference(RoutingPreference.forNumber(0))
           .setPolylineQuality(PolylineQuality.forNumber(0))
           .setPolylineEncoding(PolylineEncoding.forNumber(0))
           .setDepartureTime(Timestamp.newBuilder().build())
           .setArrivalTime(Timestamp.newBuilder().build())
           .setComputeAlternativeRoutes(true)
           .setRouteModifiers(RouteModifiers.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setRegionCode("regionCode-1991004415")
           .setUnits(Units.forNumber(0))
           .setOptimizeWaypointOrder(true)
           .addAllRequestedReferenceRoutes(new ArrayList<ComputeRoutesRequest.ReferenceRoute>())
           .addAllExtraComputations(new ArrayList<ComputeRoutesRequest.ExtraComputation>())
           .setTrafficModel(TrafficModel.forNumber(0))
           .setTransitPreferences(TransitPreferences.newBuilder().build())
           .build();
   ApiFuture<ComputeRoutesResponse> future =
       routesClient.computeRoutesCallable().futureCall(request);
   // Do something.
   ComputeRoutesResponse response = future.get();
 }
 
```
  - computeRouteMatrixCallable
```
public final com.google.api.gax.rpc.ServerStreamingCallable<ComputeRouteMatrixRequest,RouteMatrixElement> computeRouteMatrixCallable()
```
    Takes in a list of origins and destinations and returns a stream containing route information for each combination of origin and destination.
    **NOTE:** This method requires that you specify a response field mask in the input. You can provide the response field mask by using the URL parameter `$fields` or `fields`, or by using the HTTP/gRPC header `X-Goog-FieldMask` (see the [available URL parameters and headers](https://cloud.google.com/apis/docs/system-parameters)). The value is a comma separated list of field paths. See this detailed documentation about [how to construct the field paths](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto).
    For example, in this method:
    - Field mask of all available fields (for manual inspection): `X-Goog-FieldMask: *`
    - Field mask of route durations, distances, element status, condition, and element indices (an example production setup): `X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration`
    It is critical that you include `status` in your field mask as otherwise all messages will appear to be OK. Google discourages the use of the wildcard (`*`) response field mask, because:
    - Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
    - Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
    - Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.
    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 (RoutesClient routesClient = RoutesClient.create()) {
   ComputeRouteMatrixRequest request =
       ComputeRouteMatrixRequest.newBuilder()
           .addAllOrigins(new ArrayList<RouteMatrixOrigin>())
           .addAllDestinations(new ArrayList<RouteMatrixDestination>())
           .setTravelMode(RouteTravelMode.forNumber(0))
           .setRoutingPreference(RoutingPreference.forNumber(0))
           .setDepartureTime(Timestamp.newBuilder().build())
           .setArrivalTime(Timestamp.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setRegionCode("regionCode-1991004415")
           .setUnits(Units.forNumber(0))
           .addAllExtraComputations(new ArrayList<ComputeRouteMatrixRequest.ExtraComputation>())
           .setTrafficModel(TrafficModel.forNumber(0))
           .setTransitPreferences(TransitPreferences.newBuilder().build())
           .build();
   ServerStream<RouteMatrixElement> stream =
       routesClient.computeRouteMatrixCallable().call(request);
   for (RouteMatrixElement response : stream) {
     // Do something when a response is received.
   }
 }
 
```
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - shutdown
```
public void shutdown()
```
    Specified by:
    
    shutdown in interface com.google.api.gax.core.BackgroundResource
  - isShutdown
```
public boolean isShutdown()
```
    Specified by:
    
    isShutdown in interface com.google.api.gax.core.BackgroundResource
  - isTerminated
```
public boolean isTerminated()
```
    Specified by:
    
    isTerminated in interface com.google.api.gax.core.BackgroundResource
  - shutdownNow
```
public void shutdownNow()
```
    Specified by:
    
    shutdownNow in interface com.google.api.gax.core.BackgroundResource
  - awaitTermination
```
public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException
```
    Specified by:
    
    awaitTermination in interface com.google.api.gax.core.BackgroundResource
    
    Throws:
    
    InterruptedException

Class RoutesClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RoutesClient

RoutesClient

Method Detail

create

create

create

getSettings

getStub

computeRoutes

computeRoutesCallable

computeRouteMatrixCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination