Class VpnTunnelsClient (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:


 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:


 VpnTunnelsSettings vpnTunnelsSettings =
     VpnTunnelsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create(vpnTunnelsSettings);
 

To customize the endpoint:


 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

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
NameDescription
settingsVpnTunnelsSettings

VpnTunnelsClient(VpnTunnelsStub stub)

protected VpnTunnelsClient(VpnTunnelsStub stub)
Parameter
NameDescription
stubVpnTunnelsStub

Methods

aggregatedList(AggregatedListVpnTunnelsRequest request)

public final VpnTunnelsClient.AggregatedListPagedResponse aggregatedList(AggregatedListVpnTunnelsRequest request)

Retrieves an aggregated list of VPN tunnels.

Sample code:


 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
Parameter
NameDescription
requestAggregatedListVpnTunnelsRequest

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

Returns
TypeDescription
VpnTunnelsClient.AggregatedListPagedResponse

aggregatedList(String project)

public final VpnTunnelsClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of VPN tunnels.

Sample code:


 try (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   String project = "project-309310695";
   for (Map.Entry
Parameter
NameDescription
projectString

Project ID for this request.

Returns
TypeDescription
VpnTunnelsClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListVpnTunnelsRequest,VpnTunnelAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of VPN tunnels.

Sample code:


 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
Returns
TypeDescription
UnaryCallable<AggregatedListVpnTunnelsRequest,VpnTunnelAggregatedList>

aggregatedListPagedCallable()

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

Retrieves an aggregated list of VPN tunnels.

Sample code:


 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<>
Returns
TypeDescription
UnaryCallable<AggregatedListVpnTunnelsRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

create()

public static final VpnTunnelsClient create()

Constructs an instance of VpnTunnelsClient with default settings.

Returns
TypeDescription
VpnTunnelsClient
Exceptions
TypeDescription
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
NameDescription
settingsVpnTunnelsSettings
Returns
TypeDescription
VpnTunnelsClient
Exceptions
TypeDescription
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
NameDescription
stubVpnTunnelsStub
Returns
TypeDescription
VpnTunnelsClient

deleteAsync(DeleteVpnTunnelRequest request)

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

Deletes the specified VpnTunnel resource.

Sample code:


 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
NameDescription
requestDeleteVpnTunnelRequest

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

Returns
TypeDescription
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:


 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
NameDescription
projectString

Project ID for this request.

regionString

Name of the region for this request.

vpnTunnelString

Name of the VpnTunnel resource to delete.

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteVpnTunnelRequest,Operation> deleteCallable()

Deletes the specified VpnTunnel resource.

Sample code:


 try (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   DeleteVpnTunnelRequest request =
       DeleteVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setVpnTunnel("vpnTunnel452443772")
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<DeleteVpnTunnelRequest,Operation>

deleteOperationCallable()

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

Deletes the specified VpnTunnel resource.

Sample code:


 try (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   DeleteVpnTunnelRequest request =
       DeleteVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setVpnTunnel("vpnTunnel452443772")
           .build();
   OperationFuture
Returns
TypeDescription
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:


 try (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   GetVpnTunnelRequest request =
       GetVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setVpnTunnel("vpnTunnel452443772")
           .build();
   VpnTunnel response = vpnTunnelsClient.get(request);
 }
 
Parameter
NameDescription
requestGetVpnTunnelRequest

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

Returns
TypeDescription
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:


 try (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String vpnTunnel = "vpnTunnel452443772";
   VpnTunnel response = vpnTunnelsClient.get(project, region, vpnTunnel);
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region for this request.

vpnTunnelString

Name of the VpnTunnel resource to return.

Returns
TypeDescription
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:


 try (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   GetVpnTunnelRequest request =
       GetVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setVpnTunnel("vpnTunnel452443772")
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<GetVpnTunnelRequest,VpnTunnel>

getSettings()

public final VpnTunnelsSettings getSettings()
Returns
TypeDescription
VpnTunnelsSettings

getStub()

public VpnTunnelsStub getStub()
Returns
TypeDescription
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:


 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
NameDescription
requestInsertVpnTunnelRequest

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

Returns
TypeDescription
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:


 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
NameDescription
projectString

Project ID for this request.

regionString

Name of the region for this request.

vpnTunnelResourceVpnTunnel

The body resource for this request

Returns
TypeDescription
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:


 try (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   InsertVpnTunnelRequest request =
       InsertVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setVpnTunnelResource(VpnTunnel.newBuilder().build())
           .build();
   ApiFuture
Returns
TypeDescription
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:


 try (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   InsertVpnTunnelRequest request =
       InsertVpnTunnelRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setVpnTunnelResource(VpnTunnel.newBuilder().build())
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<InsertVpnTunnelRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
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:


 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
NameDescription
requestListVpnTunnelsRequest

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

Returns
TypeDescription
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:


 try (VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (VpnTunnel element : vpnTunnelsClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region for this request.

Returns
TypeDescription
VpnTunnelsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListVpnTunnelsRequest,VpnTunnelList> listCallable()

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

Sample code:


 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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
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:


 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
Returns
TypeDescription
UnaryCallable<ListVpnTunnelsRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()