com.google.cloud.compute.v1

Class RoutesClient

java.lang.Object

com.google.cloud.compute.v1.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()) {
   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().

Methods

Method	Description	Method Variants
Delete	Deletes the specified Route resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteRouteRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteAsync(String project, String route) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteOperationCallable() deleteCallable()
Get	Returns the specified Route resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetRouteRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String route) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
Insert	Creates a Route resource in the specified project using the data included in the request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertRouteRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. insertAsync(String project, Route routeResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. insertOperationCallable() insertCallable()
List	Retrieves the list of Route resources available to the specified project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListRoutesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list(String project) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoutesClient.ListFixedSizeCollection
static class	RoutesClient.ListPage
static class	RoutesClient.ListPagedResponse

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

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
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.
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	deleteAsync(DeleteRouteRequest request) Deletes the specified Route resource.
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	deleteAsync(String project, String route) Deletes the specified Route resource.
com.google.api.gax.rpc.UnaryCallable<DeleteRouteRequest,Operation>	deleteCallable() Deletes the specified Route resource.
com.google.api.gax.rpc.OperationCallable<DeleteRouteRequest,Operation,Operation>	deleteOperationCallable() Deletes the specified Route resource.
Route	get(GetRouteRequest request) Returns the specified Route resource.
Route	get(String project, String route) Returns the specified Route resource.
com.google.api.gax.rpc.UnaryCallable<GetRouteRequest,Route>	getCallable() Returns the specified Route resource.
RoutesSettings	getSettings()
RoutesStub	getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	insertAsync(InsertRouteRequest request) Creates a Route resource in the specified project using the data included in the request.
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	insertAsync(String project, Route routeResource) Creates a Route resource in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertRouteRequest,Operation>	insertCallable() Creates a Route resource in the specified project using the data included in the request.
com.google.api.gax.rpc.OperationCallable<InsertRouteRequest,Operation,Operation>	insertOperationCallable() Creates a Route resource in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
RoutesClient.ListPagedResponse	list(ListRoutesRequest request) Retrieves the list of Route resources available to the specified project.
RoutesClient.ListPagedResponse	list(String project) Retrieves the list of Route resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListRoutesRequest,RouteList>	listCallable() Retrieves the list of Route resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListRoutesRequest,RoutesClient.ListPagedResponse>	listPagedCallable() Retrieves the list of Route resources available to the specified project.
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()

deleteAsync

public final com.google.api.gax.longrunning.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:

project - Project ID for this request.

route - Name of the Route resource to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAsync

public final com.google.api.gax.longrunning.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();
 }
 

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

deleteOperationCallable

public final com.google.api.gax.rpc.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();
 }
 

deleteCallable

public final com.google.api.gax.rpc.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();
 }
 

get

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:

project - Project ID for this request.

route - Name of the Route resource to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

get

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);
 }
 

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

getCallable

public final com.google.api.gax.rpc.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();
 }
 

insertAsync

public final com.google.api.gax.longrunning.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:

project - Project ID for this request.

routeResource - The body resource for this request

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertAsync

public final com.google.api.gax.longrunning.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();
 }
 

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

insertOperationCallable

public final com.google.api.gax.rpc.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();
 }
 

insertCallable

public final com.google.api.gax.rpc.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();
 }
 

list

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);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

list

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);
   }
 }
 

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

listPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }
 

listCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }
 

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