VpnTunnelClient (Google Cloud 0.89.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.VpnTunnelClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class VpnTunnelClient
extends Object
implements BackgroundResource
```
Service Description: Creates and runs virtual machines on Google Cloud Platform.
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 (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   ProjectRegionVpnTunnelName vpnTunnel = ProjectRegionVpnTunnelName.of("[PROJECT]", "[REGION]", "[VPN_TUNNEL]");
   Operation response = vpnTunnelClient.deleteVpnTunnel(vpnTunnel);
 }
 
 
```
Note: close() needs to be called on the vpnTunnelClient 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 VpnTunnelSettings to create(). For example:
To customize credentials:
```
 
 VpnTunnelSettings vpnTunnelSettings =
     VpnTunnelSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VpnTunnelClient vpnTunnelClient =
     VpnTunnelClient.create(vpnTunnelSettings);
 
 
```
To customize the endpoint:
```
 
 VpnTunnelSettings vpnTunnelSettings =
     VpnTunnelSettings.newBuilder().setEndpoint(myEndpoint).build();
 VpnTunnelClient vpnTunnelClient =
     VpnTunnelClient.create(vpnTunnelSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`VpnTunnelClient.AggregatedListVpnTunnelsFixedSizeCollection`
`static class`	`VpnTunnelClient.AggregatedListVpnTunnelsPage`
`static class`	`VpnTunnelClient.AggregatedListVpnTunnelsPagedResponse`
`static class`	`VpnTunnelClient.ListVpnTunnelsFixedSizeCollection`
`static class`	`VpnTunnelClient.ListVpnTunnelsPage`
`static class`	`VpnTunnelClient.ListVpnTunnelsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`VpnTunnelClient(VpnTunnelSettings settings)` Constructs an instance of VpnTunnelClient, using the given settings.
`protected`	`VpnTunnelClient(VpnTunnelStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VpnTunnelClient.AggregatedListVpnTunnelsPagedResponse`	`aggregatedListVpnTunnels(AggregatedListVpnTunnelsHttpRequest request)` Retrieves an aggregated list of VPN tunnels.
`VpnTunnelClient.AggregatedListVpnTunnelsPagedResponse`	`aggregatedListVpnTunnels(ProjectName project)` Retrieves an aggregated list of VPN tunnels.
`VpnTunnelClient.AggregatedListVpnTunnelsPagedResponse`	`aggregatedListVpnTunnels(String project)` Retrieves an aggregated list of VPN tunnels.
`UnaryCallable<AggregatedListVpnTunnelsHttpRequest,VpnTunnelAggregatedList>`	`aggregatedListVpnTunnelsCallable()` Retrieves an aggregated list of VPN tunnels.
`UnaryCallable<AggregatedListVpnTunnelsHttpRequest,VpnTunnelClient.AggregatedListVpnTunnelsPagedResponse>`	`aggregatedListVpnTunnelsPagedCallable()` Retrieves an aggregated list of VPN tunnels.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static VpnTunnelClient`	`create()` Constructs an instance of VpnTunnelClient with default settings.
`static VpnTunnelClient`	`create(VpnTunnelSettings settings)` Constructs an instance of VpnTunnelClient, using the given settings.
`static VpnTunnelClient`	`create(VpnTunnelStub stub)` Constructs an instance of VpnTunnelClient, using the given stub for making calls.
`Operation`	`deleteVpnTunnel(DeleteVpnTunnelHttpRequest request)` Deletes the specified VpnTunnel resource.
`Operation`	`deleteVpnTunnel(ProjectRegionVpnTunnelName vpnTunnel)` Deletes the specified VpnTunnel resource.
`Operation`	`deleteVpnTunnel(String vpnTunnel)` Deletes the specified VpnTunnel resource.
`UnaryCallable<DeleteVpnTunnelHttpRequest,Operation>`	`deleteVpnTunnelCallable()` Deletes the specified VpnTunnel resource.
`VpnTunnelSettings`	`getSettings()`
`VpnTunnelStub`	`getStub()`
`VpnTunnel`	`getVpnTunnel(GetVpnTunnelHttpRequest request)` Returns the specified VpnTunnel resource.
`VpnTunnel`	`getVpnTunnel(ProjectRegionVpnTunnelName vpnTunnel)` Returns the specified VpnTunnel resource.
`VpnTunnel`	`getVpnTunnel(String vpnTunnel)` Returns the specified VpnTunnel resource.
`UnaryCallable<GetVpnTunnelHttpRequest,VpnTunnel>`	`getVpnTunnelCallable()` Returns the specified VpnTunnel resource.
`Operation`	`insertVpnTunnel(InsertVpnTunnelHttpRequest request)` Creates a VpnTunnel resource in the specified project and region using the data included in the request.
`Operation`	`insertVpnTunnel(ProjectRegionName region, VpnTunnel vpnTunnelResource)` Creates a VpnTunnel resource in the specified project and region using the data included in the request.
`Operation`	`insertVpnTunnel(String region, VpnTunnel vpnTunnelResource)` Creates a VpnTunnel resource in the specified project and region using the data included in the request.
`UnaryCallable<InsertVpnTunnelHttpRequest,Operation>`	`insertVpnTunnelCallable()` Creates a VpnTunnel resource in the specified project and region using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`VpnTunnelClient.ListVpnTunnelsPagedResponse`	`listVpnTunnels(ListVpnTunnelsHttpRequest request)` Retrieves a list of VpnTunnel resources contained in the specified project and region.
`VpnTunnelClient.ListVpnTunnelsPagedResponse`	`listVpnTunnels(ProjectRegionName region)` Retrieves a list of VpnTunnel resources contained in the specified project and region.
`VpnTunnelClient.ListVpnTunnelsPagedResponse`	`listVpnTunnels(String region)` Retrieves a list of VpnTunnel resources contained in the specified project and region.
`UnaryCallable<ListVpnTunnelsHttpRequest,VpnTunnelList>`	`listVpnTunnelsCallable()` Retrieves a list of VpnTunnel resources contained in the specified project and region.
`UnaryCallable<ListVpnTunnelsHttpRequest,VpnTunnelClient.ListVpnTunnelsPagedResponse>`	`listVpnTunnelsPagedCallable()` Retrieves a list of VpnTunnel resources contained in the specified project and region.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- VpnTunnelClient
```
protected VpnTunnelClient(VpnTunnelSettings settings)
                   throws IOException
```
  Constructs an instance of VpnTunnelClient, 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
- VpnTunnelClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected VpnTunnelClient(VpnTunnelStub stub)
```

Method Detail

create

public static final VpnTunnelClient create()
                                    throws IOException

Constructs an instance of VpnTunnelClient with default settings.

Throws:: IOException

create
```
public static final VpnTunnelClient create(VpnTunnelSettings settings)
                                    throws IOException
```
Constructs an instance of VpnTunnelClient, 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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final VpnTunnelClient create(VpnTunnelStub stub)

Constructs an instance of VpnTunnelClient, using the given stub for making calls. This is for advanced usage - prefer to use VpnTunnelSettings}.

getSettings

public final VpnTunnelSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public VpnTunnelStub getStub()

aggregatedListVpnTunnels

@BetaApi
public final VpnTunnelClient.AggregatedListVpnTunnelsPagedResponse aggregatedListVpnTunnels(ProjectName project)

Retrieves an aggregated list of VPN tunnels.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (VpnTunnelsScopedList element : vpnTunnelClient.aggregatedListVpnTunnels(project).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: ApiException - if the remote call fails

aggregatedListVpnTunnels

@BetaApi
public final VpnTunnelClient.AggregatedListVpnTunnelsPagedResponse aggregatedListVpnTunnels(String project)

Retrieves an aggregated list of VPN tunnels.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (VpnTunnelsScopedList element : vpnTunnelClient.aggregatedListVpnTunnels(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: ApiException - if the remote call fails

aggregatedListVpnTunnels

@BetaApi
public final VpnTunnelClient.AggregatedListVpnTunnelsPagedResponse aggregatedListVpnTunnels(AggregatedListVpnTunnelsHttpRequest request)

Retrieves an aggregated list of VPN tunnels.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListVpnTunnelsHttpRequest request = AggregatedListVpnTunnelsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (VpnTunnelsScopedList element : vpnTunnelClient.aggregatedListVpnTunnels(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

aggregatedListVpnTunnelsPagedCallable

@BetaApi
public final UnaryCallable<AggregatedListVpnTunnelsHttpRequest,VpnTunnelClient.AggregatedListVpnTunnelsPagedResponse> aggregatedListVpnTunnelsPagedCallable()

Retrieves an aggregated list of VPN tunnels.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListVpnTunnelsHttpRequest request = AggregatedListVpnTunnelsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListVpnTunnelsPagedResponse> future = vpnTunnelClient.aggregatedListVpnTunnelsPagedCallable().futureCall(request);
   // Do something
   for (VpnTunnelsScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

aggregatedListVpnTunnelsCallable

@BetaApi
public final UnaryCallable<AggregatedListVpnTunnelsHttpRequest,VpnTunnelAggregatedList> aggregatedListVpnTunnelsCallable()

Retrieves an aggregated list of VPN tunnels.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListVpnTunnelsHttpRequest request = AggregatedListVpnTunnelsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     VpnTunnelAggregatedList response = vpnTunnelClient.aggregatedListVpnTunnelsCallable().call(request);
     for (VpnTunnelsScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

deleteVpnTunnel

@BetaApi
public final Operation deleteVpnTunnel(ProjectRegionVpnTunnelName vpnTunnel)

Deletes the specified VpnTunnel resource.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   ProjectRegionVpnTunnelName vpnTunnel = ProjectRegionVpnTunnelName.of("[PROJECT]", "[REGION]", "[VPN_TUNNEL]");
   Operation response = vpnTunnelClient.deleteVpnTunnel(vpnTunnel);
 }

Parameters:: vpnTunnel - Name of the VpnTunnel resource to delete.
Throws:: ApiException - if the remote call fails

deleteVpnTunnel

@BetaApi
public final Operation deleteVpnTunnel(String vpnTunnel)

Deletes the specified VpnTunnel resource.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   ProjectRegionVpnTunnelName vpnTunnel = ProjectRegionVpnTunnelName.of("[PROJECT]", "[REGION]", "[VPN_TUNNEL]");
   Operation response = vpnTunnelClient.deleteVpnTunnel(vpnTunnel.toString());
 }

Parameters:: vpnTunnel - Name of the VpnTunnel resource to delete.
Throws:: ApiException - if the remote call fails

deleteVpnTunnel

@BetaApi
public final Operation deleteVpnTunnel(DeleteVpnTunnelHttpRequest request)

Deletes the specified VpnTunnel resource.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   String formattedVpnTunnel = ProjectRegionVpnTunnelName.format("[PROJECT]", "[REGION]", "[VPN_TUNNEL]");
   DeleteVpnTunnelHttpRequest request = DeleteVpnTunnelHttpRequest.newBuilder()
     .setVpnTunnel(formattedVpnTunnel)
     .build();
   Operation response = vpnTunnelClient.deleteVpnTunnel(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

deleteVpnTunnelCallable

@BetaApi
public final UnaryCallable<DeleteVpnTunnelHttpRequest,Operation> deleteVpnTunnelCallable()

Deletes the specified VpnTunnel resource.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   String formattedVpnTunnel = ProjectRegionVpnTunnelName.format("[PROJECT]", "[REGION]", "[VPN_TUNNEL]");
   DeleteVpnTunnelHttpRequest request = DeleteVpnTunnelHttpRequest.newBuilder()
     .setVpnTunnel(formattedVpnTunnel)
     .build();
   ApiFuture<Operation> future = vpnTunnelClient.deleteVpnTunnelCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getVpnTunnel

@BetaApi
public final VpnTunnel getVpnTunnel(ProjectRegionVpnTunnelName vpnTunnel)

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   ProjectRegionVpnTunnelName vpnTunnel = ProjectRegionVpnTunnelName.of("[PROJECT]", "[REGION]", "[VPN_TUNNEL]");
   VpnTunnel response = vpnTunnelClient.getVpnTunnel(vpnTunnel);
 }

Parameters:: vpnTunnel - Name of the VpnTunnel resource to return.
Throws:: ApiException - if the remote call fails

getVpnTunnel

@BetaApi
public final VpnTunnel getVpnTunnel(String vpnTunnel)

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   ProjectRegionVpnTunnelName vpnTunnel = ProjectRegionVpnTunnelName.of("[PROJECT]", "[REGION]", "[VPN_TUNNEL]");
   VpnTunnel response = vpnTunnelClient.getVpnTunnel(vpnTunnel.toString());
 }

Parameters:: vpnTunnel - Name of the VpnTunnel resource to return.
Throws:: ApiException - if the remote call fails

getVpnTunnel

@BetaApi
public final VpnTunnel getVpnTunnel(GetVpnTunnelHttpRequest request)

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   String formattedVpnTunnel = ProjectRegionVpnTunnelName.format("[PROJECT]", "[REGION]", "[VPN_TUNNEL]");
   GetVpnTunnelHttpRequest request = GetVpnTunnelHttpRequest.newBuilder()
     .setVpnTunnel(formattedVpnTunnel)
     .build();
   VpnTunnel response = vpnTunnelClient.getVpnTunnel(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getVpnTunnelCallable

@BetaApi
public final UnaryCallable<GetVpnTunnelHttpRequest,VpnTunnel> getVpnTunnelCallable()

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   String formattedVpnTunnel = ProjectRegionVpnTunnelName.format("[PROJECT]", "[REGION]", "[VPN_TUNNEL]");
   GetVpnTunnelHttpRequest request = GetVpnTunnelHttpRequest.newBuilder()
     .setVpnTunnel(formattedVpnTunnel)
     .build();
   ApiFuture<VpnTunnel> future = vpnTunnelClient.getVpnTunnelCallable().futureCall(request);
   // Do something
   VpnTunnel response = future.get();
 }

insertVpnTunnel

@BetaApi
public final Operation insertVpnTunnel(ProjectRegionName region,
                                                VpnTunnel vpnTunnelResource)

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   VpnTunnel vpnTunnelResource = VpnTunnel.newBuilder().build();
   Operation response = vpnTunnelClient.insertVpnTunnel(region, vpnTunnelResource);
 }

Parameters:: region - Name of the region for this request.; vpnTunnelResource - VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==)
Throws:: ApiException - if the remote call fails

insertVpnTunnel

@BetaApi
public final Operation insertVpnTunnel(String region,
                                                VpnTunnel vpnTunnelResource)

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   VpnTunnel vpnTunnelResource = VpnTunnel.newBuilder().build();
   Operation response = vpnTunnelClient.insertVpnTunnel(region.toString(), vpnTunnelResource);
 }

Parameters:: region - Name of the region for this request.; vpnTunnelResource - VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==)
Throws:: ApiException - if the remote call fails

insertVpnTunnel

@BetaApi
public final Operation insertVpnTunnel(InsertVpnTunnelHttpRequest request)

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   VpnTunnel vpnTunnelResource = VpnTunnel.newBuilder().build();
   InsertVpnTunnelHttpRequest request = InsertVpnTunnelHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setVpnTunnelResource(vpnTunnelResource)
     .build();
   Operation response = vpnTunnelClient.insertVpnTunnel(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

insertVpnTunnelCallable

@BetaApi
public final UnaryCallable<InsertVpnTunnelHttpRequest,Operation> insertVpnTunnelCallable()

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Sample code:


 try (VpnTunnelClient vpnTunnelClient = VpnTunnelClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   VpnTunnel vpnTunnelResource = VpnTunnel.newBuilder().build();
   InsertVpnTunnelHttpRequest request = InsertVpnTunnelHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setVpnTunnelResource(vpnTunnelResource)
     .build();
   ApiFuture<Operation> future = vpnTunnelClient.insertVpnTunnelCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }