Class RoutesClient (1.40.0)

Version 1.40.0

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

GitHub Repository

Product Reference

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()) {
   String project = "project-309310695";
   String route = "route108704329";
   Route response = routesClient.get(project, route);
 }
 

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().

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

1. 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.
2. 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.
3. 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 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);
 

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

Inheritance

java.lang.Object > RoutesClient

Static Methods

create()

public static final RoutesClient create()

Constructs an instance of RoutesClient with default settings.

Returns
Type	Description
RoutesClient

Exceptions
Type	Description
IOException

create(RoutesSettings settings)

public static final RoutesClient create(RoutesSettings settings)

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.

Parameter
Name	Description
settings	RoutesSettings

Returns
Type	Description
RoutesClient

Exceptions
Type	Description
IOException

create(RoutesStub stub)

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).

Parameter
Name	Description
stub	RoutesStub

Returns
Type	Description
RoutesClient

Constructors

RoutesClient(RoutesSettings settings)

protected RoutesClient(RoutesSettings settings)

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.

Parameter
Name	Description
settings	RoutesSettings

RoutesClient(RoutesStub stub)

protected RoutesClient(RoutesStub stub)

Parameter
Name	Description
stub	RoutesStub

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

close()

public final void close()

deleteAsync(DeleteRouteRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteRouteRequest request)

Deletes the specified Route resource.

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()) {
   DeleteRouteRequest request =
       DeleteRouteRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setRoute("route108704329")
           .build();
   Operation response = routesClient.deleteAsync(request).get();
 }
 

Parameter
Name	Description
request	DeleteRouteRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String route)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String route)

Deletes the specified Route resource.

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()) {
   String project = "project-309310695";
   String route = "route108704329";
   Operation response = routesClient.deleteAsync(project, route).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
route	String Name of the Route resource to delete.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteRouteRequest,Operation> deleteCallable()

Deletes the specified Route resource.

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()) {
   DeleteRouteRequest request =
       DeleteRouteRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setRoute("route108704329")
           .build();
   ApiFuture<Operation> future = routesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteRouteRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteRouteRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified Route resource.

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()) {
   DeleteRouteRequest request =
       DeleteRouteRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setRoute("route108704329")
           .build();
   OperationFuture<Operation, Operation> future =
       routesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<DeleteRouteRequest,Operation,Operation>

get(GetRouteRequest request)

public final Route get(GetRouteRequest request)

Returns the specified Route resource.

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()) {
   GetRouteRequest request =
       GetRouteRequest.newBuilder()
           .setProject("project-309310695")
           .setRoute("route108704329")
           .build();
   Route response = routesClient.get(request);
 }
 

Parameter
Name	Description
request	GetRouteRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Route

get(String project, String route)

public final Route get(String project, String route)

Returns the specified Route resource.

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()) {
   String project = "project-309310695";
   String route = "route108704329";
   Route response = routesClient.get(project, route);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
route	String Name of the Route resource to return.

Returns
Type	Description
Route

getCallable()

public final UnaryCallable<GetRouteRequest,Route> getCallable()

Returns the specified Route resource.

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()) {
   GetRouteRequest request =
       GetRouteRequest.newBuilder()
           .setProject("project-309310695")
           .setRoute("route108704329")
           .build();
   ApiFuture<Route> future = routesClient.getCallable().futureCall(request);
   // Do something.
   Route response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetRouteRequest,Route>

getSettings()

public final RoutesSettings getSettings()

Returns
Type	Description
RoutesSettings

getStub()

public RoutesStub getStub()

Returns
Type	Description
RoutesStub

insertAsync(InsertRouteRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertRouteRequest request)

Creates a Route resource in the specified project using the data included in the request.

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()) {
   InsertRouteRequest request =
       InsertRouteRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setRouteResource(Route.newBuilder().build())
           .build();
   Operation response = routesClient.insertAsync(request).get();
 }
 

Parameter
Name	Description
request	InsertRouteRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, Route routeResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, Route routeResource)

Creates a Route resource in the specified project using the data included in the request.

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()) {
   String project = "project-309310695";
   Route routeResource = Route.newBuilder().build();
   Operation response = routesClient.insertAsync(project, routeResource).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
routeResource	Route The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertRouteRequest,Operation> insertCallable()

Creates a Route resource in the specified project using the data included in the request.

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()) {
   InsertRouteRequest request =
       InsertRouteRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setRouteResource(Route.newBuilder().build())
           .build();
   ApiFuture<Operation> future = routesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<InsertRouteRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertRouteRequest,Operation,Operation> insertOperationCallable()

Creates a Route resource in the specified project using the data included in the request.

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()) {
   InsertRouteRequest request =
       InsertRouteRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setRouteResource(Route.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       routesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<InsertRouteRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

list(ListRoutesRequest request)

public final RoutesClient.ListPagedResponse list(ListRoutesRequest request)

Retrieves the list of Route resources available to the specified project.

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()) {
   ListRoutesRequest request =
       ListRoutesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Route element : routesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	ListRoutesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
RoutesClient.ListPagedResponse

list(String project)

public final RoutesClient.ListPagedResponse list(String project)

Retrieves the list of Route resources available to the specified project.

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()) {
   String project = "project-309310695";
   for (Route element : routesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
project	String Project ID for this request.

Returns
Type	Description
RoutesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRoutesRequest,RouteList> listCallable()

Retrieves the list of Route resources available to the specified project.

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()) {
   ListRoutesRequest request =
       ListRoutesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     RouteList response = routesClient.listCallable().call(request);
     for (Route element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListRoutesRequest,RouteList>

listPagedCallable()

public final UnaryCallable<ListRoutesRequest,RoutesClient.ListPagedResponse> listPagedCallable()

Retrieves the list of Route resources available to the specified project.

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()) {
   ListRoutesRequest request =
       ListRoutesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Route> future = routesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (Route element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListRoutesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()