Class VpnTunnelsClient (1.13.0)

Version 1.13.0

• 1.62.0 (latest)
• 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

public class VpnTunnelsClient implements 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().

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

Inheritance

java.lang.Object > VpnTunnelsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final VpnTunnelsClient create()

Constructs an instance of VpnTunnelsClient with default settings.

Returns

Type	Description
VpnTunnelsClient

Exceptions

Type	Description
IOException

create(VpnTunnelsSettings settings)

public static final VpnTunnelsClient create(VpnTunnelsSettings settings)

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.

Parameter

Name	Description
settings	VpnTunnelsSettings

Returns

Type	Description
VpnTunnelsClient

Exceptions

Type	Description
IOException

create(VpnTunnelsStub stub)

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

Parameter

Name	Description
stub	VpnTunnelsStub

Returns

Type	Description
VpnTunnelsClient

Constructors

VpnTunnelsClient(VpnTunnelsSettings settings)

protected VpnTunnelsClient(VpnTunnelsSettings settings)

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.

Parameter

Name	Description
settings	VpnTunnelsSettings

VpnTunnelsClient(VpnTunnelsStub stub)

protected VpnTunnelsClient(VpnTunnelsStub stub)

Parameter

Name	Description
stub	VpnTunnelsStub

Methods

aggregatedList(AggregatedListVpnTunnelsRequest request)

public final VpnTunnelsClient.AggregatedListPagedResponse aggregatedList(AggregatedListVpnTunnelsRequest request)

Retrieves an aggregated list of VPN tunnels.

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)
           .build();
   for (Map.Entry<String, VpnTunnelsScopedList> element :
       vpnTunnelsClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
VpnTunnelsClient.AggregatedListPagedResponse

aggregatedList(String project)

public final VpnTunnelsClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of VPN tunnels.

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

Parameter

Name	Description
project	String Project ID for this request.

Returns

Type	Description
VpnTunnelsClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListVpnTunnelsRequest,VpnTunnelAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of VPN tunnels.

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

Returns

Type	Description
UnaryCallable<AggregatedListVpnTunnelsRequest,VpnTunnelAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListVpnTunnelsRequest,VpnTunnelsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of VPN tunnels.

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)
           .build();
   ApiFuture<Map.Entry<String, VpnTunnelsScopedList>> future =
       vpnTunnelsClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, VpnTunnelsScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<AggregatedListVpnTunnelsRequest,AggregatedListPagedResponse>

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(DeleteVpnTunnelRequest request)

public final 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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String vpnTunnel)

public final 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

Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
vpnTunnel	String Name of the VpnTunnel resource to delete.

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final 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();
 }
 

Returns

Type	Description
UnaryCallable<DeleteVpnTunnelRequest,Operation>

deleteOperationCallable()

public final 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();
 }
 

Returns

Type	Description
OperationCallable<DeleteVpnTunnelRequest,Operation,Operation>

get(GetVpnTunnelRequest request)

public final VpnTunnel get(GetVpnTunnelRequest request)

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() 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()) {
   GetVpnTunnelRequest request =
       GetVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setVpnTunnel("vpnTunnel452443772")
           .build();
   VpnTunnel response = vpnTunnelsClient.get(request);
 }
 

Parameter

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

Returns

Type	Description
VpnTunnel

get(String project, String region, String vpnTunnel)

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

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() 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";
   String vpnTunnel = "vpnTunnel452443772";
   VpnTunnel response = vpnTunnelsClient.get(project, region, vpnTunnel);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
vpnTunnel	String Name of the VpnTunnel resource to return.

Returns

Type	Description
VpnTunnel

getCallable()

public final UnaryCallable<GetVpnTunnelRequest,VpnTunnel> getCallable()

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() 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()) {
   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();
 }
 

Returns

Type	Description
UnaryCallable<GetVpnTunnelRequest,VpnTunnel>

getSettings()

public final VpnTunnelsSettings getSettings()

Returns

Type	Description
VpnTunnelsSettings

getStub()

public VpnTunnelsStub getStub()

Returns

Type	Description
VpnTunnelsStub

insertAsync(InsertVpnTunnelRequest request)

public final 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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, VpnTunnel vpnTunnelResource)

public final 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

Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
vpnTunnelResource	VpnTunnel The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final 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();
 }
 

Returns

Type	Description
UnaryCallable<InsertVpnTunnelRequest,Operation>

insertOperationCallable()

public final 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();
 }
 

Returns

Type	Description
OperationCallable<InsertVpnTunnelRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListVpnTunnelsRequest request)

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

Parameter

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

Returns

Type	Description
VpnTunnelsClient.ListPagedResponse

list(String project, String region)

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

Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.

Returns

Type	Description
VpnTunnelsClient.ListPagedResponse

listCallable()

public final 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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListVpnTunnelsRequest,VpnTunnelList>

listPagedCallable()

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

Returns

Type	Description
UnaryCallable<ListVpnTunnelsRequest,ListPagedResponse>

setLabelsAsync(SetLabelsVpnTunnelRequest request)

public final 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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

setLabelsAsync(String project, String region, String resource, RegionSetLabelsRequest regionSetLabelsRequestResource)

public final 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

Name	Description
project	String Project ID for this request.
region	String The region for this request.
resource	String Name or id of the resource for this request.
regionSetLabelsRequestResource	RegionSetLabelsRequest The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

setLabelsCallable()

public final 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();
 }
 

Returns

Type	Description
UnaryCallable<SetLabelsVpnTunnelRequest,Operation>

setLabelsOperationCallable()

public final 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();
 }
 

Returns

Type	Description
OperationCallable<SetLabelsVpnTunnelRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()