com.google.cloud.compute.v1

Class VpnTunnelsClient

java.lang.Object

com.google.cloud.compute.v1.VpnTunnelsClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Service Description: The VpnTunnels 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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String vpnTunnel = "vpnTunnel452443772";
   VpnTunnel response = vpnTunnelsClient.get(project, region, vpnTunnel);
 }
 

Note: close() needs to be called on the VpnTunnelsClient 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
AggregatedList	Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.	Request object method variants only take one parameter, a request object, which must be constructed before the call. aggregatedList(AggregatedListVpnTunnelsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. aggregatedList(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. aggregatedListPagedCallable() aggregatedListCallable()
Delete	Deletes the specified VpnTunnel resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteVpnTunnelRequest 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 region, String vpnTunnel) 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 VpnTunnel resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetVpnTunnelRequest 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 region, String vpnTunnel) 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 VpnTunnel resource in the specified project and region 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(InsertVpnTunnelRequest 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, String region, VpnTunnel vpnTunnelResource) 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 a list of VpnTunnel resources contained in the specified project and region.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListVpnTunnelsRequest 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, String region) 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()
SetLabels	Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setLabelsAsync(SetLabelsVpnTunnelRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. setLabelsAsync(String project, String region, String resource, RegionSetLabelsRequest regionSetLabelsRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setLabelsOperationCallable() setLabelsCallable()

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 VpnTunnelsSettings 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
 VpnTunnelsSettings vpnTunnelsSettings =
     VpnTunnelsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create(vpnTunnelsSettings);
 

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
 VpnTunnelsSettings vpnTunnelsSettings =
     VpnTunnelsSettings.newBuilder().setEndpoint(myEndpoint).build();
 VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create(vpnTunnelsSettings);
 

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	VpnTunnelsClient.AggregatedListFixedSizeCollection
static class	VpnTunnelsClient.AggregatedListPage
static class	VpnTunnelsClient.AggregatedListPagedResponse
static class	VpnTunnelsClient.ListFixedSizeCollection
static class	VpnTunnelsClient.ListPage
static class	VpnTunnelsClient.ListPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VpnTunnelsClient(VpnTunnelsSettings settings) Constructs an instance of VpnTunnelsClient, using the given settings.
protected	VpnTunnelsClient(VpnTunnelsStub stub)

Method Summary

Modifier and Type	Method and Description
VpnTunnelsClient.AggregatedListPagedResponse	aggregatedList(AggregatedListVpnTunnelsRequest request) Retrieves an aggregated list of VPN tunnels.
VpnTunnelsClient.AggregatedListPagedResponse	aggregatedList(String project) Retrieves an aggregated list of VPN tunnels.
com.google.api.gax.rpc.UnaryCallable<AggregatedListVpnTunnelsRequest,VpnTunnelAggregatedList>	aggregatedListCallable() Retrieves an aggregated list of VPN tunnels.
com.google.api.gax.rpc.UnaryCallable<AggregatedListVpnTunnelsRequest,VpnTunnelsClient.AggregatedListPagedResponse>	aggregatedListPagedCallable() Retrieves an aggregated list of VPN tunnels.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static VpnTunnelsClient	create() Constructs an instance of VpnTunnelsClient with default settings.
static VpnTunnelsClient	create(VpnTunnelsSettings settings) Constructs an instance of VpnTunnelsClient, using the given settings.
static VpnTunnelsClient	create(VpnTunnelsStub stub) Constructs an instance of VpnTunnelsClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	deleteAsync(DeleteVpnTunnelRequest request) Deletes the specified VpnTunnel resource.
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	deleteAsync(String project, String region, String vpnTunnel) Deletes the specified VpnTunnel resource.
com.google.api.gax.rpc.UnaryCallable<DeleteVpnTunnelRequest,Operation>	deleteCallable() Deletes the specified VpnTunnel resource.
com.google.api.gax.rpc.OperationCallable<DeleteVpnTunnelRequest,Operation,Operation>	deleteOperationCallable() Deletes the specified VpnTunnel resource.
VpnTunnel	get(GetVpnTunnelRequest request) Returns the specified VpnTunnel resource.
VpnTunnel	get(String project, String region, String vpnTunnel) Returns the specified VpnTunnel resource.
com.google.api.gax.rpc.UnaryCallable<GetVpnTunnelRequest,VpnTunnel>	getCallable() Returns the specified VpnTunnel resource.
VpnTunnelsSettings	getSettings()
VpnTunnelsStub	getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	insertAsync(InsertVpnTunnelRequest request) Creates a VpnTunnel resource in the specified project and region using the data included in the request.
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	insertAsync(String project, String region, VpnTunnel vpnTunnelResource) Creates a VpnTunnel resource in the specified project and region using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertVpnTunnelRequest,Operation>	insertCallable() Creates a VpnTunnel resource in the specified project and region using the data included in the request.
com.google.api.gax.rpc.OperationCallable<InsertVpnTunnelRequest,Operation,Operation>	insertOperationCallable() Creates a VpnTunnel resource in the specified project and region using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
VpnTunnelsClient.ListPagedResponse	list(ListVpnTunnelsRequest request) Retrieves a list of VpnTunnel resources contained in the specified project and region.
VpnTunnelsClient.ListPagedResponse	list(String project, String region) Retrieves a list of VpnTunnel resources contained in the specified project and region.
com.google.api.gax.rpc.UnaryCallable<ListVpnTunnelsRequest,VpnTunnelList>	listCallable() Retrieves a list of VpnTunnel resources contained in the specified project and region.
com.google.api.gax.rpc.UnaryCallable<ListVpnTunnelsRequest,VpnTunnelsClient.ListPagedResponse>	listPagedCallable() Retrieves a list of VpnTunnel resources contained in the specified project and region.
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	setLabelsAsync(SetLabelsVpnTunnelRequest request) Sets the labels on a VpnTunnel.
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	setLabelsAsync(String project, String region, String resource, RegionSetLabelsRequest regionSetLabelsRequestResource) Sets the labels on a VpnTunnel.
com.google.api.gax.rpc.UnaryCallable<SetLabelsVpnTunnelRequest,Operation>	setLabelsCallable() Sets the labels on a VpnTunnel.
com.google.api.gax.rpc.OperationCallable<SetLabelsVpnTunnelRequest,Operation,Operation>	setLabelsOperationCallable() Sets the labels on a VpnTunnel.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VpnTunnelsClient

protected VpnTunnelsClient(VpnTunnelsSettings settings)
                    throws IOException

Constructs an instance of VpnTunnelsClient, 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

VpnTunnelsClient

protected VpnTunnelsClient(VpnTunnelsStub stub)

Method Detail

create

public static final VpnTunnelsClient create()
                                     throws IOException

Constructs an instance of VpnTunnelsClient with default settings.

Throws:

IOException

create

public static final VpnTunnelsClient create(VpnTunnelsSettings settings)
                                     throws IOException

Constructs an instance of VpnTunnelsClient, 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 VpnTunnelsClient create(VpnTunnelsStub stub)

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

getSettings

public final VpnTunnelsSettings getSettings()

getStub

public VpnTunnelsStub getStub()

aggregatedList

public final VpnTunnelsClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.

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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, VpnTunnelsScopedList> element :
       vpnTunnelsClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

aggregatedList

public final VpnTunnelsClient.AggregatedListPagedResponse aggregatedList(AggregatedListVpnTunnelsRequest request)

Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.

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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   AggregatedListVpnTunnelsRequest request =
       AggregatedListVpnTunnelsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, VpnTunnelsScopedList> element :
       vpnTunnelsClient.aggregatedList(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

aggregatedListPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<AggregatedListVpnTunnelsRequest,VpnTunnelsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.

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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   AggregatedListVpnTunnelsRequest request =
       AggregatedListVpnTunnelsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   ApiFuture<Map.Entry<String, VpnTunnelsScopedList>> future =
       vpnTunnelsClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, VpnTunnelsScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

aggregatedListCallable

public final com.google.api.gax.rpc.UnaryCallable<AggregatedListVpnTunnelsRequest,VpnTunnelAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.

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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   AggregatedListVpnTunnelsRequest request =
       AggregatedListVpnTunnelsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     VpnTunnelAggregatedList response = vpnTunnelsClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, VpnTunnelsScopedList> element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(String project,
                                                                                             String region,
                                                                                             String vpnTunnel)

Deletes the specified VpnTunnel 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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String vpnTunnel = "vpnTunnel452443772";
   Operation response = vpnTunnelsClient.deleteAsync(project, region, vpnTunnel).get();
 }
 

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

vpnTunnel - Name of the VpnTunnel 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(DeleteVpnTunnelRequest request)

Deletes the specified VpnTunnel 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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   DeleteVpnTunnelRequest request =
       DeleteVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setVpnTunnel("vpnTunnel452443772")
           .build();
   Operation response = vpnTunnelsClient.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<DeleteVpnTunnelRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified VpnTunnel 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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   DeleteVpnTunnelRequest request =
       DeleteVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setVpnTunnel("vpnTunnel452443772")
           .build();
   OperationFuture<Operation, Operation> future =
       vpnTunnelsClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

deleteCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteVpnTunnelRequest,Operation> deleteCallable()

Deletes the specified VpnTunnel 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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   DeleteVpnTunnelRequest request =
       DeleteVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setVpnTunnel("vpnTunnel452443772")
           .build();
   ApiFuture<Operation> future = vpnTunnelsClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

get

public final VpnTunnel get(String project,
                           String region,
                           String vpnTunnel)

Returns the specified VpnTunnel 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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String vpnTunnel = "vpnTunnel452443772";
   VpnTunnel response = vpnTunnelsClient.get(project, region, vpnTunnel);
 }
 

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

vpnTunnel - Name of the VpnTunnel resource to return.

Throws:

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

get

public final VpnTunnel get(GetVpnTunnelRequest request)

Returns the specified VpnTunnel 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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   GetVpnTunnelRequest request =
       GetVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setVpnTunnel("vpnTunnel452443772")
           .build();
   VpnTunnel response = vpnTunnelsClient.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<GetVpnTunnelRequest,VpnTunnel> getCallable()

Returns the specified VpnTunnel 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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   GetVpnTunnelRequest request =
       GetVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setVpnTunnel("vpnTunnel452443772")
           .build();
   ApiFuture<VpnTunnel> future = vpnTunnelsClient.getCallable().futureCall(request);
   // Do something.
   VpnTunnel response = future.get();
 }
 

insertAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project,
                                                                                             String region,
                                                                                             VpnTunnel vpnTunnelResource)

Creates a VpnTunnel resource in the specified project and region 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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   VpnTunnel vpnTunnelResource = VpnTunnel.newBuilder().build();
   Operation response = vpnTunnelsClient.insertAsync(project, region, vpnTunnelResource).get();
 }
 

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

vpnTunnelResource - 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(InsertVpnTunnelRequest request)

Creates a VpnTunnel resource in the specified project and region 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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   InsertVpnTunnelRequest request =
       InsertVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setVpnTunnelResource(VpnTunnel.newBuilder().build())
           .build();
   Operation response = vpnTunnelsClient.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<InsertVpnTunnelRequest,Operation,Operation> insertOperationCallable()

Creates a VpnTunnel resource in the specified project and region 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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   InsertVpnTunnelRequest request =
       InsertVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setVpnTunnelResource(VpnTunnel.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       vpnTunnelsClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

insertCallable

public final com.google.api.gax.rpc.UnaryCallable<InsertVpnTunnelRequest,Operation> insertCallable()

Creates a VpnTunnel resource in the specified project and region 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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   InsertVpnTunnelRequest request =
       InsertVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setVpnTunnelResource(VpnTunnel.newBuilder().build())
           .build();
   ApiFuture<Operation> future = vpnTunnelsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

list

public final VpnTunnelsClient.ListPagedResponse list(String project,
                                                     String region)

Retrieves a list of VpnTunnel resources contained in the specified project and region.

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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (VpnTunnel element : vpnTunnelsClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

Throws:

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

list

public final VpnTunnelsClient.ListPagedResponse list(ListVpnTunnelsRequest request)

Retrieves a list of VpnTunnel resources contained in the specified project and region.

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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   ListVpnTunnelsRequest request =
       ListVpnTunnelsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (VpnTunnel element : vpnTunnelsClient.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<ListVpnTunnelsRequest,VpnTunnelsClient.ListPagedResponse> listPagedCallable()

Retrieves a list of VpnTunnel resources contained in the specified project and region.

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

listCallable

public final com.google.api.gax.rpc.UnaryCallable<ListVpnTunnelsRequest,VpnTunnelList> listCallable()

Retrieves a list of VpnTunnel resources contained in the specified project and region.

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

setLabelsAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setLabelsAsync(String project,
                                                                                                String region,
                                                                                                String resource,
                                                                                                RegionSetLabelsRequest regionSetLabelsRequestResource)

Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.

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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   RegionSetLabelsRequest regionSetLabelsRequestResource =
       RegionSetLabelsRequest.newBuilder().build();
   Operation response =
       vpnTunnelsClient
           .setLabelsAsync(project, region, resource, regionSetLabelsRequestResource)
           .get();
 }
 

Parameters:

project - Project ID for this request.

region - The region for this request.

resource - Name or id of the resource for this request.

regionSetLabelsRequestResource - The body resource for this request

Throws:

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

setLabelsAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsVpnTunnelRequest request)

Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.

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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   SetLabelsVpnTunnelRequest request =
       SetLabelsVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   Operation response = vpnTunnelsClient.setLabelsAsync(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

setLabelsOperationCallable

public final com.google.api.gax.rpc.OperationCallable<SetLabelsVpnTunnelRequest,Operation,Operation> setLabelsOperationCallable()

Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.

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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   SetLabelsVpnTunnelRequest request =
       SetLabelsVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   OperationFuture<Operation, Operation> future =
       vpnTunnelsClient.setLabelsOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

setLabelsCallable

public final com.google.api.gax.rpc.UnaryCallable<SetLabelsVpnTunnelRequest,Operation> setLabelsCallable()

Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.

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 (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   SetLabelsVpnTunnelRequest request =
       SetLabelsVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Operation> future = vpnTunnelsClient.setLabelsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

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