com.google.cloud.compute.v1

Class VpnGatewayClient

java.lang.Object

com.google.cloud.compute.v1.VpnGatewayClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class VpnGatewayClient
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 (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionVpnGatewayName vpnGateway = ProjectRegionVpnGatewayName.of("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   Operation response = vpnGatewayClient.deleteVpnGateway(vpnGateway);
 }
 
 

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

To customize credentials:

 
 VpnGatewaySettings vpnGatewaySettings =
     VpnGatewaySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VpnGatewayClient vpnGatewayClient =
     VpnGatewayClient.create(vpnGatewaySettings);
 
 

To customize the endpoint:

 
 VpnGatewaySettings vpnGatewaySettings =
     VpnGatewaySettings.newBuilder().setEndpoint(myEndpoint).build();
 VpnGatewayClient vpnGatewayClient =
     VpnGatewayClient.create(vpnGatewaySettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VpnGatewayClient.AggregatedListVpnGatewaysFixedSizeCollection
static class	VpnGatewayClient.AggregatedListVpnGatewaysPage
static class	VpnGatewayClient.AggregatedListVpnGatewaysPagedResponse
static class	VpnGatewayClient.ListVpnGatewaysFixedSizeCollection
static class	VpnGatewayClient.ListVpnGatewaysPage
static class	VpnGatewayClient.ListVpnGatewaysPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VpnGatewayClient(VpnGatewaySettings settings) Constructs an instance of VpnGatewayClient, using the given settings.
protected	VpnGatewayClient(VpnGatewayStub stub)

Method Summary

Modifier and Type	Method and Description
VpnGatewayClient.AggregatedListVpnGatewaysPagedResponse	aggregatedListVpnGateways(AggregatedListVpnGatewaysHttpRequest request) Retrieves an aggregated list of VPN gateways.
VpnGatewayClient.AggregatedListVpnGatewaysPagedResponse	aggregatedListVpnGateways(ProjectName project) Retrieves an aggregated list of VPN gateways.
VpnGatewayClient.AggregatedListVpnGatewaysPagedResponse	aggregatedListVpnGateways(String project) Retrieves an aggregated list of VPN gateways.
com.google.api.gax.rpc.UnaryCallable<AggregatedListVpnGatewaysHttpRequest,VpnGatewayAggregatedList>	aggregatedListVpnGatewaysCallable() Retrieves an aggregated list of VPN gateways.
com.google.api.gax.rpc.UnaryCallable<AggregatedListVpnGatewaysHttpRequest,VpnGatewayClient.AggregatedListVpnGatewaysPagedResponse>	aggregatedListVpnGatewaysPagedCallable() Retrieves an aggregated list of VPN gateways.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static VpnGatewayClient	create() Constructs an instance of VpnGatewayClient with default settings.
static VpnGatewayClient	create(VpnGatewaySettings settings) Constructs an instance of VpnGatewayClient, using the given settings.
static VpnGatewayClient	create(VpnGatewayStub stub) Constructs an instance of VpnGatewayClient, using the given stub for making calls.
Operation	deleteVpnGateway(DeleteVpnGatewayHttpRequest request) Deletes the specified VPN gateway.
Operation	deleteVpnGateway(ProjectRegionVpnGatewayName vpnGateway) Deletes the specified VPN gateway.
Operation	deleteVpnGateway(String vpnGateway) Deletes the specified VPN gateway.
com.google.api.gax.rpc.UnaryCallable<DeleteVpnGatewayHttpRequest,Operation>	deleteVpnGatewayCallable() Deletes the specified VPN gateway.
VpnGatewaySettings	getSettings()
VpnGatewaysGetStatusResponse	getStatusVpnGateway(GetStatusVpnGatewayHttpRequest request) Returns the status for the specified VPN gateway.
VpnGatewaysGetStatusResponse	getStatusVpnGateway(ProjectRegionVpnGatewayName vpnGateway) Returns the status for the specified VPN gateway.
VpnGatewaysGetStatusResponse	getStatusVpnGateway(String vpnGateway) Returns the status for the specified VPN gateway.
com.google.api.gax.rpc.UnaryCallable<GetStatusVpnGatewayHttpRequest,VpnGatewaysGetStatusResponse>	getStatusVpnGatewayCallable() Returns the status for the specified VPN gateway.
VpnGatewayStub	getStub()
VpnGateway	getVpnGateway(GetVpnGatewayHttpRequest request) Returns the specified VPN gateway.
VpnGateway	getVpnGateway(ProjectRegionVpnGatewayName vpnGateway) Returns the specified VPN gateway.
VpnGateway	getVpnGateway(String vpnGateway) Returns the specified VPN gateway.
com.google.api.gax.rpc.UnaryCallable<GetVpnGatewayHttpRequest,VpnGateway>	getVpnGatewayCallable() Returns the specified VPN gateway.
Operation	insertVpnGateway(InsertVpnGatewayHttpRequest request) Creates a VPN gateway in the specified project and region using the data included in the request.
Operation	insertVpnGateway(ProjectRegionName region, VpnGateway vpnGatewayResource) Creates a VPN gateway in the specified project and region using the data included in the request.
Operation	insertVpnGateway(String region, VpnGateway vpnGatewayResource) Creates a VPN gateway in the specified project and region using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertVpnGatewayHttpRequest,Operation>	insertVpnGatewayCallable() Creates a VPN gateway in the specified project and region using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
VpnGatewayClient.ListVpnGatewaysPagedResponse	listVpnGateways(ListVpnGatewaysHttpRequest request) Retrieves a list of VPN gateways available to the specified project and region.
VpnGatewayClient.ListVpnGatewaysPagedResponse	listVpnGateways(ProjectRegionName region) Retrieves a list of VPN gateways available to the specified project and region.
VpnGatewayClient.ListVpnGatewaysPagedResponse	listVpnGateways(String region) Retrieves a list of VPN gateways available to the specified project and region.
com.google.api.gax.rpc.UnaryCallable<ListVpnGatewaysHttpRequest,VpnGatewayList>	listVpnGatewaysCallable() Retrieves a list of VPN gateways available to the specified project and region.
com.google.api.gax.rpc.UnaryCallable<ListVpnGatewaysHttpRequest,VpnGatewayClient.ListVpnGatewaysPagedResponse>	listVpnGatewaysPagedCallable() Retrieves a list of VPN gateways available to the specified project and region.
Operation	setLabelsVpnGateway(ProjectRegionVpnGatewayResourceName resource, RegionSetLabelsRequest regionSetLabelsRequestResource) Sets the labels on a VpnGateway.
Operation	setLabelsVpnGateway(SetLabelsVpnGatewayHttpRequest request) Sets the labels on a VpnGateway.
Operation	setLabelsVpnGateway(String resource, RegionSetLabelsRequest regionSetLabelsRequestResource) Sets the labels on a VpnGateway.
com.google.api.gax.rpc.UnaryCallable<SetLabelsVpnGatewayHttpRequest,Operation>	setLabelsVpnGatewayCallable() Sets the labels on a VpnGateway.
void	shutdown()
void	shutdownNow()
TestPermissionsResponse	testIamPermissionsVpnGateway(ProjectRegionVpnGatewayResourceName resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsVpnGateway(String resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsVpnGateway(TestIamPermissionsVpnGatewayHttpRequest request) Returns permissions that a caller has on the specified resource.
com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsVpnGatewayHttpRequest,TestPermissionsResponse>	testIamPermissionsVpnGatewayCallable() Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

VpnGatewayClient

protected VpnGatewayClient(VpnGatewaySettings settings)
                    throws IOException

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

VpnGatewayClient

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

Method Detail

create

public static final VpnGatewayClient create()
                                     throws IOException

Constructs an instance of VpnGatewayClient with default settings.

Throws:

IOException

create

public static final VpnGatewayClient create(VpnGatewaySettings settings)
                                     throws IOException

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

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

getSettings

public final VpnGatewaySettings getSettings()

getStub

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

aggregatedListVpnGateways

@BetaApi
public final VpnGatewayClient.AggregatedListVpnGatewaysPagedResponse aggregatedListVpnGateways(ProjectName project)

Retrieves an aggregated list of VPN gateways.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (VpnGatewaysScopedList element : vpnGatewayClient.aggregatedListVpnGateways(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

aggregatedListVpnGateways

@BetaApi
public final VpnGatewayClient.AggregatedListVpnGatewaysPagedResponse aggregatedListVpnGateways(String project)

Retrieves an aggregated list of VPN gateways.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (VpnGatewaysScopedList element : vpnGatewayClient.aggregatedListVpnGateways(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

aggregatedListVpnGateways

@BetaApi
public final VpnGatewayClient.AggregatedListVpnGatewaysPagedResponse aggregatedListVpnGateways(AggregatedListVpnGatewaysHttpRequest request)

Retrieves an aggregated list of VPN gateways.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListVpnGatewaysHttpRequest request = AggregatedListVpnGatewaysHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (VpnGatewaysScopedList element : vpnGatewayClient.aggregatedListVpnGateways(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

aggregatedListVpnGatewaysPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListVpnGatewaysHttpRequest,VpnGatewayClient.AggregatedListVpnGatewaysPagedResponse> aggregatedListVpnGatewaysPagedCallable()

Retrieves an aggregated list of VPN gateways.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListVpnGatewaysHttpRequest request = AggregatedListVpnGatewaysHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListVpnGatewaysPagedResponse> future = vpnGatewayClient.aggregatedListVpnGatewaysPagedCallable().futureCall(request);
   // Do something
   for (VpnGatewaysScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

aggregatedListVpnGatewaysCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListVpnGatewaysHttpRequest,VpnGatewayAggregatedList> aggregatedListVpnGatewaysCallable()

Retrieves an aggregated list of VPN gateways.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListVpnGatewaysHttpRequest request = AggregatedListVpnGatewaysHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     VpnGatewayAggregatedList response = vpnGatewayClient.aggregatedListVpnGatewaysCallable().call(request);
     for (VpnGatewaysScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteVpnGateway

@BetaApi
public final Operation deleteVpnGateway(ProjectRegionVpnGatewayName vpnGateway)

Deletes the specified VPN gateway.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionVpnGatewayName vpnGateway = ProjectRegionVpnGatewayName.of("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   Operation response = vpnGatewayClient.deleteVpnGateway(vpnGateway);
 }
 

Parameters:

vpnGateway - Name of the VPN gateway to delete.

Throws:

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

deleteVpnGateway

@BetaApi
public final Operation deleteVpnGateway(String vpnGateway)

Deletes the specified VPN gateway.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionVpnGatewayName vpnGateway = ProjectRegionVpnGatewayName.of("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   Operation response = vpnGatewayClient.deleteVpnGateway(vpnGateway.toString());
 }
 

Parameters:

vpnGateway - Name of the VPN gateway to delete.

Throws:

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

deleteVpnGateway

@BetaApi
public final Operation deleteVpnGateway(DeleteVpnGatewayHttpRequest request)

Deletes the specified VPN gateway.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedVpnGateway = ProjectRegionVpnGatewayName.format("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   DeleteVpnGatewayHttpRequest request = DeleteVpnGatewayHttpRequest.newBuilder()
     .setVpnGateway(formattedVpnGateway)
     .build();
   Operation response = vpnGatewayClient.deleteVpnGateway(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

deleteVpnGatewayCallable

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

Deletes the specified VPN gateway.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedVpnGateway = ProjectRegionVpnGatewayName.format("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   DeleteVpnGatewayHttpRequest request = DeleteVpnGatewayHttpRequest.newBuilder()
     .setVpnGateway(formattedVpnGateway)
     .build();
   ApiFuture<Operation> future = vpnGatewayClient.deleteVpnGatewayCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getVpnGateway

@BetaApi
public final VpnGateway getVpnGateway(ProjectRegionVpnGatewayName vpnGateway)

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionVpnGatewayName vpnGateway = ProjectRegionVpnGatewayName.of("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   VpnGateway response = vpnGatewayClient.getVpnGateway(vpnGateway);
 }
 

Parameters:

vpnGateway - Name of the VPN gateway to return.

Throws:

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

getVpnGateway

@BetaApi
public final VpnGateway getVpnGateway(String vpnGateway)

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionVpnGatewayName vpnGateway = ProjectRegionVpnGatewayName.of("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   VpnGateway response = vpnGatewayClient.getVpnGateway(vpnGateway.toString());
 }
 

Parameters:

vpnGateway - Name of the VPN gateway to return.

Throws:

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

getVpnGateway

@BetaApi
public final VpnGateway getVpnGateway(GetVpnGatewayHttpRequest request)

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedVpnGateway = ProjectRegionVpnGatewayName.format("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   GetVpnGatewayHttpRequest request = GetVpnGatewayHttpRequest.newBuilder()
     .setVpnGateway(formattedVpnGateway)
     .build();
   VpnGateway response = vpnGatewayClient.getVpnGateway(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

getVpnGatewayCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetVpnGatewayHttpRequest,VpnGateway> getVpnGatewayCallable()

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedVpnGateway = ProjectRegionVpnGatewayName.format("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   GetVpnGatewayHttpRequest request = GetVpnGatewayHttpRequest.newBuilder()
     .setVpnGateway(formattedVpnGateway)
     .build();
   ApiFuture<VpnGateway> future = vpnGatewayClient.getVpnGatewayCallable().futureCall(request);
   // Do something
   VpnGateway response = future.get();
 }
 

getStatusVpnGateway

@BetaApi
public final VpnGatewaysGetStatusResponse getStatusVpnGateway(ProjectRegionVpnGatewayName vpnGateway)

Returns the status for the specified VPN gateway.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionVpnGatewayName vpnGateway = ProjectRegionVpnGatewayName.of("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   VpnGatewaysGetStatusResponse response = vpnGatewayClient.getStatusVpnGateway(vpnGateway);
 }
 

Parameters:

vpnGateway - Name of the VPN gateway to return.

Throws:

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

getStatusVpnGateway

@BetaApi
public final VpnGatewaysGetStatusResponse getStatusVpnGateway(String vpnGateway)

Returns the status for the specified VPN gateway.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionVpnGatewayName vpnGateway = ProjectRegionVpnGatewayName.of("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   VpnGatewaysGetStatusResponse response = vpnGatewayClient.getStatusVpnGateway(vpnGateway.toString());
 }
 

Parameters:

vpnGateway - Name of the VPN gateway to return.

Throws:

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

getStatusVpnGateway

@BetaApi
public final VpnGatewaysGetStatusResponse getStatusVpnGateway(GetStatusVpnGatewayHttpRequest request)

Returns the status for the specified VPN gateway.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedVpnGateway = ProjectRegionVpnGatewayName.format("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   GetStatusVpnGatewayHttpRequest request = GetStatusVpnGatewayHttpRequest.newBuilder()
     .setVpnGateway(formattedVpnGateway)
     .build();
   VpnGatewaysGetStatusResponse response = vpnGatewayClient.getStatusVpnGateway(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

getStatusVpnGatewayCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetStatusVpnGatewayHttpRequest,VpnGatewaysGetStatusResponse> getStatusVpnGatewayCallable()

Returns the status for the specified VPN gateway.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedVpnGateway = ProjectRegionVpnGatewayName.format("[PROJECT]", "[REGION]", "[VPN_GATEWAY]");
   GetStatusVpnGatewayHttpRequest request = GetStatusVpnGatewayHttpRequest.newBuilder()
     .setVpnGateway(formattedVpnGateway)
     .build();
   ApiFuture<VpnGatewaysGetStatusResponse> future = vpnGatewayClient.getStatusVpnGatewayCallable().futureCall(request);
   // Do something
   VpnGatewaysGetStatusResponse response = future.get();
 }
 

insertVpnGateway

@BetaApi
public final Operation insertVpnGateway(ProjectRegionName region,
                                                 VpnGateway vpnGatewayResource)

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   VpnGateway vpnGatewayResource = VpnGateway.newBuilder().build();
   Operation response = vpnGatewayClient.insertVpnGateway(region, vpnGatewayResource);
 }
 

Parameters:

region - Name of the region for this request.

vpnGatewayResource - Represents a VPN gateway resource.

Throws:

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

insertVpnGateway

@BetaApi
public final Operation insertVpnGateway(String region,
                                                 VpnGateway vpnGatewayResource)

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   VpnGateway vpnGatewayResource = VpnGateway.newBuilder().build();
   Operation response = vpnGatewayClient.insertVpnGateway(region.toString(), vpnGatewayResource);
 }
 

Parameters:

region - Name of the region for this request.

vpnGatewayResource - Represents a VPN gateway resource.

Throws:

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

insertVpnGateway

@BetaApi
public final Operation insertVpnGateway(InsertVpnGatewayHttpRequest request)

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   VpnGateway vpnGatewayResource = VpnGateway.newBuilder().build();
   InsertVpnGatewayHttpRequest request = InsertVpnGatewayHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setVpnGatewayResource(vpnGatewayResource)
     .build();
   Operation response = vpnGatewayClient.insertVpnGateway(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

insertVpnGatewayCallable

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

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   VpnGateway vpnGatewayResource = VpnGateway.newBuilder().build();
   InsertVpnGatewayHttpRequest request = InsertVpnGatewayHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setVpnGatewayResource(vpnGatewayResource)
     .build();
   ApiFuture<Operation> future = vpnGatewayClient.insertVpnGatewayCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listVpnGateways

@BetaApi
public final VpnGatewayClient.ListVpnGatewaysPagedResponse listVpnGateways(ProjectRegionName region)

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (VpnGateway element : vpnGatewayClient.listVpnGateways(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

listVpnGateways

@BetaApi
public final VpnGatewayClient.ListVpnGatewaysPagedResponse listVpnGateways(String region)

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (VpnGateway element : vpnGatewayClient.listVpnGateways(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

listVpnGateways

@BetaApi
public final VpnGatewayClient.ListVpnGatewaysPagedResponse listVpnGateways(ListVpnGatewaysHttpRequest request)

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListVpnGatewaysHttpRequest request = ListVpnGatewaysHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   for (VpnGateway element : vpnGatewayClient.listVpnGateways(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

listVpnGatewaysPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListVpnGatewaysHttpRequest,VpnGatewayClient.ListVpnGatewaysPagedResponse> listVpnGatewaysPagedCallable()

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListVpnGatewaysHttpRequest request = ListVpnGatewaysHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   ApiFuture<ListVpnGatewaysPagedResponse> future = vpnGatewayClient.listVpnGatewaysPagedCallable().futureCall(request);
   // Do something
   for (VpnGateway element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listVpnGatewaysCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListVpnGatewaysHttpRequest,VpnGatewayList> listVpnGatewaysCallable()

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListVpnGatewaysHttpRequest request = ListVpnGatewaysHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   while (true) {
     VpnGatewayList response = vpnGatewayClient.listVpnGatewaysCallable().call(request);
     for (VpnGateway element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

setLabelsVpnGateway

@BetaApi
public final Operation setLabelsVpnGateway(ProjectRegionVpnGatewayResourceName resource,
                                                    RegionSetLabelsRequest regionSetLabelsRequestResource)

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionVpnGatewayResourceName resource = ProjectRegionVpnGatewayResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   RegionSetLabelsRequest regionSetLabelsRequestResource = RegionSetLabelsRequest.newBuilder().build();
   Operation response = vpnGatewayClient.setLabelsVpnGateway(resource, regionSetLabelsRequestResource);
 }
 

Parameters:

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

regionSetLabelsRequestResource -

Throws:

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

setLabelsVpnGateway

@BetaApi
public final Operation setLabelsVpnGateway(String resource,
                                                    RegionSetLabelsRequest regionSetLabelsRequestResource)

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionVpnGatewayResourceName resource = ProjectRegionVpnGatewayResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   RegionSetLabelsRequest regionSetLabelsRequestResource = RegionSetLabelsRequest.newBuilder().build();
   Operation response = vpnGatewayClient.setLabelsVpnGateway(resource.toString(), regionSetLabelsRequestResource);
 }
 

Parameters:

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

regionSetLabelsRequestResource -

Throws:

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

setLabelsVpnGateway

@BetaApi
public final Operation setLabelsVpnGateway(SetLabelsVpnGatewayHttpRequest request)

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedResource = ProjectRegionVpnGatewayResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   RegionSetLabelsRequest regionSetLabelsRequestResource = RegionSetLabelsRequest.newBuilder().build();
   SetLabelsVpnGatewayHttpRequest request = SetLabelsVpnGatewayHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setRegionSetLabelsRequestResource(regionSetLabelsRequestResource)
     .build();
   Operation response = vpnGatewayClient.setLabelsVpnGateway(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

setLabelsVpnGatewayCallable

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

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

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedResource = ProjectRegionVpnGatewayResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   RegionSetLabelsRequest regionSetLabelsRequestResource = RegionSetLabelsRequest.newBuilder().build();
   SetLabelsVpnGatewayHttpRequest request = SetLabelsVpnGatewayHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setRegionSetLabelsRequestResource(regionSetLabelsRequestResource)
     .build();
   ApiFuture<Operation> future = vpnGatewayClient.setLabelsVpnGatewayCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

testIamPermissionsVpnGateway

@BetaApi
public final TestPermissionsResponse testIamPermissionsVpnGateway(ProjectRegionVpnGatewayResourceName resource,
                                                                           TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionVpnGatewayResourceName resource = ProjectRegionVpnGatewayResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = vpnGatewayClient.testIamPermissionsVpnGateway(resource, testPermissionsRequestResource);
 }
 

Parameters:

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

testPermissionsRequestResource -

Throws:

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

testIamPermissionsVpnGateway

@BetaApi
public final TestPermissionsResponse testIamPermissionsVpnGateway(String resource,
                                                                           TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   ProjectRegionVpnGatewayResourceName resource = ProjectRegionVpnGatewayResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = vpnGatewayClient.testIamPermissionsVpnGateway(resource.toString(), testPermissionsRequestResource);
 }
 

Parameters:

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

testPermissionsRequestResource -

Throws:

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

testIamPermissionsVpnGateway

@BetaApi
public final TestPermissionsResponse testIamPermissionsVpnGateway(TestIamPermissionsVpnGatewayHttpRequest request)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedResource = ProjectRegionVpnGatewayResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsVpnGatewayHttpRequest request = TestIamPermissionsVpnGatewayHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   TestPermissionsResponse response = vpnGatewayClient.testIamPermissionsVpnGateway(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

testIamPermissionsVpnGatewayCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsVpnGatewayHttpRequest,TestPermissionsResponse> testIamPermissionsVpnGatewayCallable()

Returns permissions that a caller has on the specified resource.

Sample code:

 try (VpnGatewayClient vpnGatewayClient = VpnGatewayClient.create()) {
   String formattedResource = ProjectRegionVpnGatewayResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsVpnGatewayHttpRequest request = TestIamPermissionsVpnGatewayHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   ApiFuture<TestPermissionsResponse> future = vpnGatewayClient.testIamPermissionsVpnGatewayCallable().futureCall(request);
   // Do something
   TestPermissionsResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

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

isShutdown

public boolean isShutdown()

Specified by:

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

isTerminated

public boolean isTerminated()

Specified by:

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

shutdownNow

public void shutdownNow()

Specified by:

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

awaitTermination

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

Specified by:

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

Throws:

InterruptedException