com.google.cloud.compute.v1

Class TargetVpnGatewayClient

java.lang.Object

com.google.cloud.compute.v1.TargetVpnGatewayClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class TargetVpnGatewayClient
extends Object
implements com.google.api.gax.core.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 (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   ProjectRegionTargetVpnGatewayName targetVpnGateway = ProjectRegionTargetVpnGatewayName.of("[PROJECT]", "[REGION]", "[TARGET_VPN_GATEWAY]");
   Operation response = targetVpnGatewayClient.deleteTargetVpnGateway(targetVpnGateway);
 }
 
 

Note: close() needs to be called on the targetVpnGatewayClient 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 TargetVpnGatewaySettings to create(). For example:

To customize credentials:

 
 TargetVpnGatewaySettings targetVpnGatewaySettings =
     TargetVpnGatewaySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TargetVpnGatewayClient targetVpnGatewayClient =
     TargetVpnGatewayClient.create(targetVpnGatewaySettings);
 
 

To customize the endpoint:

 
 TargetVpnGatewaySettings targetVpnGatewaySettings =
     TargetVpnGatewaySettings.newBuilder().setEndpoint(myEndpoint).build();
 TargetVpnGatewayClient targetVpnGatewayClient =
     TargetVpnGatewayClient.create(targetVpnGatewaySettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TargetVpnGatewayClient.AggregatedListTargetVpnGatewaysFixedSizeCollection
static class	TargetVpnGatewayClient.AggregatedListTargetVpnGatewaysPage
static class	TargetVpnGatewayClient.AggregatedListTargetVpnGatewaysPagedResponse
static class	TargetVpnGatewayClient.ListTargetVpnGatewaysFixedSizeCollection
static class	TargetVpnGatewayClient.ListTargetVpnGatewaysPage
static class	TargetVpnGatewayClient.ListTargetVpnGatewaysPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TargetVpnGatewayClient(TargetVpnGatewaySettings settings) Constructs an instance of TargetVpnGatewayClient, using the given settings.
protected	TargetVpnGatewayClient(TargetVpnGatewayStub stub)

Method Summary

Modifier and Type	Method and Description
TargetVpnGatewayClient.AggregatedListTargetVpnGatewaysPagedResponse	aggregatedListTargetVpnGateways(AggregatedListTargetVpnGatewaysHttpRequest request) Retrieves an aggregated list of target VPN gateways.
TargetVpnGatewayClient.AggregatedListTargetVpnGatewaysPagedResponse	aggregatedListTargetVpnGateways(ProjectName project) Retrieves an aggregated list of target VPN gateways.
TargetVpnGatewayClient.AggregatedListTargetVpnGatewaysPagedResponse	aggregatedListTargetVpnGateways(String project) Retrieves an aggregated list of target VPN gateways.
com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetVpnGatewaysHttpRequest,TargetVpnGatewayAggregatedList>	aggregatedListTargetVpnGatewaysCallable() Retrieves an aggregated list of target VPN gateways.
com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetVpnGatewaysHttpRequest,TargetVpnGatewayClient.AggregatedListTargetVpnGatewaysPagedResponse>	aggregatedListTargetVpnGatewaysPagedCallable() Retrieves an aggregated list of target VPN gateways.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static TargetVpnGatewayClient	create() Constructs an instance of TargetVpnGatewayClient with default settings.
static TargetVpnGatewayClient	create(TargetVpnGatewaySettings settings) Constructs an instance of TargetVpnGatewayClient, using the given settings.
static TargetVpnGatewayClient	create(TargetVpnGatewayStub stub) Constructs an instance of TargetVpnGatewayClient, using the given stub for making calls.
Operation	deleteTargetVpnGateway(DeleteTargetVpnGatewayHttpRequest request) Deletes the specified target VPN gateway.
Operation	deleteTargetVpnGateway(ProjectRegionTargetVpnGatewayName targetVpnGateway) Deletes the specified target VPN gateway.
Operation	deleteTargetVpnGateway(String targetVpnGateway) Deletes the specified target VPN gateway.
com.google.api.gax.rpc.UnaryCallable<DeleteTargetVpnGatewayHttpRequest,Operation>	deleteTargetVpnGatewayCallable() Deletes the specified target VPN gateway.
TargetVpnGatewaySettings	getSettings()
TargetVpnGatewayStub	getStub()
TargetVpnGateway	getTargetVpnGateway(GetTargetVpnGatewayHttpRequest request) Returns the specified target VPN gateway.
TargetVpnGateway	getTargetVpnGateway(ProjectRegionTargetVpnGatewayName targetVpnGateway) Returns the specified target VPN gateway.
TargetVpnGateway	getTargetVpnGateway(String targetVpnGateway) Returns the specified target VPN gateway.
com.google.api.gax.rpc.UnaryCallable<GetTargetVpnGatewayHttpRequest,TargetVpnGateway>	getTargetVpnGatewayCallable() Returns the specified target VPN gateway.
Operation	insertTargetVpnGateway(InsertTargetVpnGatewayHttpRequest request) Creates a target VPN gateway in the specified project and region using the data included in the request.
Operation	insertTargetVpnGateway(ProjectRegionName region, TargetVpnGateway targetVpnGatewayResource) Creates a target VPN gateway in the specified project and region using the data included in the request.
Operation	insertTargetVpnGateway(String region, TargetVpnGateway targetVpnGatewayResource) Creates a target VPN gateway in the specified project and region using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertTargetVpnGatewayHttpRequest,Operation>	insertTargetVpnGatewayCallable() Creates a target VPN gateway in the specified project and region using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
TargetVpnGatewayClient.ListTargetVpnGatewaysPagedResponse	listTargetVpnGateways(ListTargetVpnGatewaysHttpRequest request) Retrieves a list of target VPN gateways available to the specified project and region.
TargetVpnGatewayClient.ListTargetVpnGatewaysPagedResponse	listTargetVpnGateways(ProjectRegionName region) Retrieves a list of target VPN gateways available to the specified project and region.
TargetVpnGatewayClient.ListTargetVpnGatewaysPagedResponse	listTargetVpnGateways(String region) Retrieves a list of target VPN gateways available to the specified project and region.
com.google.api.gax.rpc.UnaryCallable<ListTargetVpnGatewaysHttpRequest,TargetVpnGatewayList>	listTargetVpnGatewaysCallable() Retrieves a list of target VPN gateways available to the specified project and region.
com.google.api.gax.rpc.UnaryCallable<ListTargetVpnGatewaysHttpRequest,TargetVpnGatewayClient.ListTargetVpnGatewaysPagedResponse>	listTargetVpnGatewaysPagedCallable() Retrieves a list of target VPN gateways available to 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

TargetVpnGatewayClient

protected TargetVpnGatewayClient(TargetVpnGatewaySettings settings)
                          throws IOException

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

TargetVpnGatewayClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected TargetVpnGatewayClient(TargetVpnGatewayStub stub)

Method Detail

create

public static final TargetVpnGatewayClient create()
                                           throws IOException

Constructs an instance of TargetVpnGatewayClient with default settings.

Throws:

IOException

create

public static final TargetVpnGatewayClient create(TargetVpnGatewaySettings settings)
                                           throws IOException

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

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

getSettings

public final TargetVpnGatewaySettings getSettings()

getStub

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

aggregatedListTargetVpnGateways

@BetaApi
public final TargetVpnGatewayClient.AggregatedListTargetVpnGatewaysPagedResponse aggregatedListTargetVpnGateways(ProjectName project)

Retrieves an aggregated list of target VPN gateways.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (TargetVpnGatewaysScopedList element : targetVpnGatewayClient.aggregatedListTargetVpnGateways(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

aggregatedListTargetVpnGateways

@BetaApi
public final TargetVpnGatewayClient.AggregatedListTargetVpnGatewaysPagedResponse aggregatedListTargetVpnGateways(String project)

Retrieves an aggregated list of target VPN gateways.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (TargetVpnGatewaysScopedList element : targetVpnGatewayClient.aggregatedListTargetVpnGateways(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

aggregatedListTargetVpnGateways

@BetaApi
public final TargetVpnGatewayClient.AggregatedListTargetVpnGatewaysPagedResponse aggregatedListTargetVpnGateways(AggregatedListTargetVpnGatewaysHttpRequest request)

Retrieves an aggregated list of target VPN gateways.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListTargetVpnGatewaysHttpRequest request = AggregatedListTargetVpnGatewaysHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (TargetVpnGatewaysScopedList element : targetVpnGatewayClient.aggregatedListTargetVpnGateways(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

aggregatedListTargetVpnGatewaysPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetVpnGatewaysHttpRequest,TargetVpnGatewayClient.AggregatedListTargetVpnGatewaysPagedResponse> aggregatedListTargetVpnGatewaysPagedCallable()

Retrieves an aggregated list of target VPN gateways.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListTargetVpnGatewaysHttpRequest request = AggregatedListTargetVpnGatewaysHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListTargetVpnGatewaysPagedResponse> future = targetVpnGatewayClient.aggregatedListTargetVpnGatewaysPagedCallable().futureCall(request);
   // Do something
   for (TargetVpnGatewaysScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

aggregatedListTargetVpnGatewaysCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetVpnGatewaysHttpRequest,TargetVpnGatewayAggregatedList> aggregatedListTargetVpnGatewaysCallable()

Retrieves an aggregated list of target VPN gateways.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListTargetVpnGatewaysHttpRequest request = AggregatedListTargetVpnGatewaysHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     TargetVpnGatewayAggregatedList response = targetVpnGatewayClient.aggregatedListTargetVpnGatewaysCallable().call(request);
     for (TargetVpnGatewaysScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteTargetVpnGateway

@BetaApi
public final Operation deleteTargetVpnGateway(ProjectRegionTargetVpnGatewayName targetVpnGateway)

Deletes the specified target VPN gateway.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   ProjectRegionTargetVpnGatewayName targetVpnGateway = ProjectRegionTargetVpnGatewayName.of("[PROJECT]", "[REGION]", "[TARGET_VPN_GATEWAY]");
   Operation response = targetVpnGatewayClient.deleteTargetVpnGateway(targetVpnGateway);
 }
 

Parameters:

targetVpnGateway - Name of the target VPN gateway to delete.

Throws:

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

deleteTargetVpnGateway

@BetaApi
public final Operation deleteTargetVpnGateway(String targetVpnGateway)

Deletes the specified target VPN gateway.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   ProjectRegionTargetVpnGatewayName targetVpnGateway = ProjectRegionTargetVpnGatewayName.of("[PROJECT]", "[REGION]", "[TARGET_VPN_GATEWAY]");
   Operation response = targetVpnGatewayClient.deleteTargetVpnGateway(targetVpnGateway.toString());
 }
 

Parameters:

targetVpnGateway - Name of the target VPN gateway to delete.

Throws:

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

deleteTargetVpnGateway

@BetaApi
public final Operation deleteTargetVpnGateway(DeleteTargetVpnGatewayHttpRequest request)

Deletes the specified target VPN gateway.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   String formattedTargetVpnGateway = ProjectRegionTargetVpnGatewayName.format("[PROJECT]", "[REGION]", "[TARGET_VPN_GATEWAY]");
   DeleteTargetVpnGatewayHttpRequest request = DeleteTargetVpnGatewayHttpRequest.newBuilder()
     .setTargetVpnGateway(formattedTargetVpnGateway)
     .build();
   Operation response = targetVpnGatewayClient.deleteTargetVpnGateway(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

deleteTargetVpnGatewayCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteTargetVpnGatewayHttpRequest,Operation> deleteTargetVpnGatewayCallable()

Deletes the specified target VPN gateway.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   String formattedTargetVpnGateway = ProjectRegionTargetVpnGatewayName.format("[PROJECT]", "[REGION]", "[TARGET_VPN_GATEWAY]");
   DeleteTargetVpnGatewayHttpRequest request = DeleteTargetVpnGatewayHttpRequest.newBuilder()
     .setTargetVpnGateway(formattedTargetVpnGateway)
     .build();
   ApiFuture<Operation> future = targetVpnGatewayClient.deleteTargetVpnGatewayCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getTargetVpnGateway

@BetaApi
public final TargetVpnGateway getTargetVpnGateway(ProjectRegionTargetVpnGatewayName targetVpnGateway)

Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   ProjectRegionTargetVpnGatewayName targetVpnGateway = ProjectRegionTargetVpnGatewayName.of("[PROJECT]", "[REGION]", "[TARGET_VPN_GATEWAY]");
   TargetVpnGateway response = targetVpnGatewayClient.getTargetVpnGateway(targetVpnGateway);
 }
 

Parameters:

targetVpnGateway - Name of the target VPN gateway to return.

Throws:

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

getTargetVpnGateway

@BetaApi
public final TargetVpnGateway getTargetVpnGateway(String targetVpnGateway)

Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   ProjectRegionTargetVpnGatewayName targetVpnGateway = ProjectRegionTargetVpnGatewayName.of("[PROJECT]", "[REGION]", "[TARGET_VPN_GATEWAY]");
   TargetVpnGateway response = targetVpnGatewayClient.getTargetVpnGateway(targetVpnGateway.toString());
 }
 

Parameters:

targetVpnGateway - Name of the target VPN gateway to return.

Throws:

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

getTargetVpnGateway

@BetaApi
public final TargetVpnGateway getTargetVpnGateway(GetTargetVpnGatewayHttpRequest request)

Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   String formattedTargetVpnGateway = ProjectRegionTargetVpnGatewayName.format("[PROJECT]", "[REGION]", "[TARGET_VPN_GATEWAY]");
   GetTargetVpnGatewayHttpRequest request = GetTargetVpnGatewayHttpRequest.newBuilder()
     .setTargetVpnGateway(formattedTargetVpnGateway)
     .build();
   TargetVpnGateway response = targetVpnGatewayClient.getTargetVpnGateway(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

getTargetVpnGatewayCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetTargetVpnGatewayHttpRequest,TargetVpnGateway> getTargetVpnGatewayCallable()

Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   String formattedTargetVpnGateway = ProjectRegionTargetVpnGatewayName.format("[PROJECT]", "[REGION]", "[TARGET_VPN_GATEWAY]");
   GetTargetVpnGatewayHttpRequest request = GetTargetVpnGatewayHttpRequest.newBuilder()
     .setTargetVpnGateway(formattedTargetVpnGateway)
     .build();
   ApiFuture<TargetVpnGateway> future = targetVpnGatewayClient.getTargetVpnGatewayCallable().futureCall(request);
   // Do something
   TargetVpnGateway response = future.get();
 }
 

insertTargetVpnGateway

@BetaApi
public final Operation insertTargetVpnGateway(ProjectRegionName region,
                                                       TargetVpnGateway targetVpnGatewayResource)

Creates a target VPN gateway in the specified project and region using the data included in the request.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   TargetVpnGateway targetVpnGatewayResource = TargetVpnGateway.newBuilder().build();
   Operation response = targetVpnGatewayClient.insertTargetVpnGateway(region, targetVpnGatewayResource);
 }
 

Parameters:

region - Name of the region for this request.

targetVpnGatewayResource - Represents a Target VPN Gateway resource.

The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==)

Throws:

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

insertTargetVpnGateway

@BetaApi
public final Operation insertTargetVpnGateway(String region,
                                                       TargetVpnGateway targetVpnGatewayResource)

Creates a target VPN gateway in the specified project and region using the data included in the request.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   TargetVpnGateway targetVpnGatewayResource = TargetVpnGateway.newBuilder().build();
   Operation response = targetVpnGatewayClient.insertTargetVpnGateway(region.toString(), targetVpnGatewayResource);
 }
 

Parameters:

region - Name of the region for this request.

targetVpnGatewayResource - Represents a Target VPN Gateway resource.

The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==)

Throws:

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

insertTargetVpnGateway

@BetaApi
public final Operation insertTargetVpnGateway(InsertTargetVpnGatewayHttpRequest request)

Creates a target VPN gateway in the specified project and region using the data included in the request.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   TargetVpnGateway targetVpnGatewayResource = TargetVpnGateway.newBuilder().build();
   InsertTargetVpnGatewayHttpRequest request = InsertTargetVpnGatewayHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setTargetVpnGatewayResource(targetVpnGatewayResource)
     .build();
   Operation response = targetVpnGatewayClient.insertTargetVpnGateway(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

insertTargetVpnGatewayCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InsertTargetVpnGatewayHttpRequest,Operation> insertTargetVpnGatewayCallable()

Creates a target VPN gateway in the specified project and region using the data included in the request.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   TargetVpnGateway targetVpnGatewayResource = TargetVpnGateway.newBuilder().build();
   InsertTargetVpnGatewayHttpRequest request = InsertTargetVpnGatewayHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setTargetVpnGatewayResource(targetVpnGatewayResource)
     .build();
   ApiFuture<Operation> future = targetVpnGatewayClient.insertTargetVpnGatewayCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listTargetVpnGateways

@BetaApi
public final TargetVpnGatewayClient.ListTargetVpnGatewaysPagedResponse listTargetVpnGateways(ProjectRegionName region)

Retrieves a list of target VPN gateways available to the specified project and region.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (TargetVpnGateway element : targetVpnGatewayClient.listTargetVpnGateways(region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region for this request.

Throws:

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

listTargetVpnGateways

@BetaApi
public final TargetVpnGatewayClient.ListTargetVpnGatewaysPagedResponse listTargetVpnGateways(String region)

Retrieves a list of target VPN gateways available to the specified project and region.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (TargetVpnGateway element : targetVpnGatewayClient.listTargetVpnGateways(region.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region for this request.

Throws:

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

listTargetVpnGateways

@BetaApi
public final TargetVpnGatewayClient.ListTargetVpnGatewaysPagedResponse listTargetVpnGateways(ListTargetVpnGatewaysHttpRequest request)

Retrieves a list of target VPN gateways available to the specified project and region.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListTargetVpnGatewaysHttpRequest request = ListTargetVpnGatewaysHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   for (TargetVpnGateway element : targetVpnGatewayClient.listTargetVpnGateways(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

listTargetVpnGatewaysPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListTargetVpnGatewaysHttpRequest,TargetVpnGatewayClient.ListTargetVpnGatewaysPagedResponse> listTargetVpnGatewaysPagedCallable()

Retrieves a list of target VPN gateways available to the specified project and region.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListTargetVpnGatewaysHttpRequest request = ListTargetVpnGatewaysHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   ApiFuture<ListTargetVpnGatewaysPagedResponse> future = targetVpnGatewayClient.listTargetVpnGatewaysPagedCallable().futureCall(request);
   // Do something
   for (TargetVpnGateway element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTargetVpnGatewaysCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListTargetVpnGatewaysHttpRequest,TargetVpnGatewayList> listTargetVpnGatewaysCallable()

Retrieves a list of target VPN gateways available to the specified project and region.

Sample code:

 try (TargetVpnGatewayClient targetVpnGatewayClient = TargetVpnGatewayClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListTargetVpnGatewaysHttpRequest request = ListTargetVpnGatewaysHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   while (true) {
     TargetVpnGatewayList response = targetVpnGatewayClient.listTargetVpnGatewaysCallable().call(request);
     for (TargetVpnGateway element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException