com.google.cloud.compute.v1

Class ExternalVpnGatewayClient

java.lang.Object

com.google.cloud.compute.v1.ExternalVpnGatewayClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class ExternalVpnGatewayClient
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 (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectGlobalExternalVpnGatewayName externalVpnGateway = ProjectGlobalExternalVpnGatewayName.of("[PROJECT]", "[EXTERNAL_VPN_GATEWAY]");
   Operation response = externalVpnGatewayClient.deleteExternalVpnGateway(externalVpnGateway);
 }
 
 

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

To customize credentials:

 
 ExternalVpnGatewaySettings externalVpnGatewaySettings =
     ExternalVpnGatewaySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ExternalVpnGatewayClient externalVpnGatewayClient =
     ExternalVpnGatewayClient.create(externalVpnGatewaySettings);
 
 

To customize the endpoint:

 
 ExternalVpnGatewaySettings externalVpnGatewaySettings =
     ExternalVpnGatewaySettings.newBuilder().setEndpoint(myEndpoint).build();
 ExternalVpnGatewayClient externalVpnGatewayClient =
     ExternalVpnGatewayClient.create(externalVpnGatewaySettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalVpnGatewayClient.ListExternalVpnGatewaysFixedSizeCollection
static class	ExternalVpnGatewayClient.ListExternalVpnGatewaysPage
static class	ExternalVpnGatewayClient.ListExternalVpnGatewaysPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExternalVpnGatewayClient(ExternalVpnGatewaySettings settings) Constructs an instance of ExternalVpnGatewayClient, using the given settings.
protected	ExternalVpnGatewayClient(ExternalVpnGatewayStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ExternalVpnGatewayClient	create() Constructs an instance of ExternalVpnGatewayClient with default settings.
static ExternalVpnGatewayClient	create(ExternalVpnGatewaySettings settings) Constructs an instance of ExternalVpnGatewayClient, using the given settings.
static ExternalVpnGatewayClient	create(ExternalVpnGatewayStub stub) Constructs an instance of ExternalVpnGatewayClient, using the given stub for making calls.
Operation	deleteExternalVpnGateway(DeleteExternalVpnGatewayHttpRequest request) Deletes the specified externalVpnGateway.
Operation	deleteExternalVpnGateway(ProjectGlobalExternalVpnGatewayName externalVpnGateway) Deletes the specified externalVpnGateway.
Operation	deleteExternalVpnGateway(String externalVpnGateway) Deletes the specified externalVpnGateway.
com.google.api.gax.rpc.UnaryCallable<DeleteExternalVpnGatewayHttpRequest,Operation>	deleteExternalVpnGatewayCallable() Deletes the specified externalVpnGateway.
ExternalVpnGateway	getExternalVpnGateway(GetExternalVpnGatewayHttpRequest request) Returns the specified externalVpnGateway.
ExternalVpnGateway	getExternalVpnGateway(ProjectGlobalExternalVpnGatewayName externalVpnGateway) Returns the specified externalVpnGateway.
ExternalVpnGateway	getExternalVpnGateway(String externalVpnGateway) Returns the specified externalVpnGateway.
com.google.api.gax.rpc.UnaryCallable<GetExternalVpnGatewayHttpRequest,ExternalVpnGateway>	getExternalVpnGatewayCallable() Returns the specified externalVpnGateway.
ExternalVpnGatewaySettings	getSettings()
ExternalVpnGatewayStub	getStub()
Operation	insertExternalVpnGateway(InsertExternalVpnGatewayHttpRequest request) Creates a ExternalVpnGateway in the specified project using the data included in the request.
Operation	insertExternalVpnGateway(ProjectName project, ExternalVpnGateway externalVpnGatewayResource) Creates a ExternalVpnGateway in the specified project using the data included in the request.
Operation	insertExternalVpnGateway(String project, ExternalVpnGateway externalVpnGatewayResource) Creates a ExternalVpnGateway in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertExternalVpnGatewayHttpRequest,Operation>	insertExternalVpnGatewayCallable() Creates a ExternalVpnGateway in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
ExternalVpnGatewayClient.ListExternalVpnGatewaysPagedResponse	listExternalVpnGateways(ListExternalVpnGatewaysHttpRequest request) Retrieves the list of ExternalVpnGateway available to the specified project.
ExternalVpnGatewayClient.ListExternalVpnGatewaysPagedResponse	listExternalVpnGateways(ProjectName project) Retrieves the list of ExternalVpnGateway available to the specified project.
ExternalVpnGatewayClient.ListExternalVpnGatewaysPagedResponse	listExternalVpnGateways(String project) Retrieves the list of ExternalVpnGateway available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListExternalVpnGatewaysHttpRequest,ExternalVpnGatewayList>	listExternalVpnGatewaysCallable() Retrieves the list of ExternalVpnGateway available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListExternalVpnGatewaysHttpRequest,ExternalVpnGatewayClient.ListExternalVpnGatewaysPagedResponse>	listExternalVpnGatewaysPagedCallable() Retrieves the list of ExternalVpnGateway available to the specified project.
Operation	setLabelsExternalVpnGateway(ProjectGlobalExternalVpnGatewayResourceName resource, GlobalSetLabelsRequest globalSetLabelsRequestResource) Sets the labels on an ExternalVpnGateway.
Operation	setLabelsExternalVpnGateway(SetLabelsExternalVpnGatewayHttpRequest request) Sets the labels on an ExternalVpnGateway.
Operation	setLabelsExternalVpnGateway(String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource) Sets the labels on an ExternalVpnGateway.
com.google.api.gax.rpc.UnaryCallable<SetLabelsExternalVpnGatewayHttpRequest,Operation>	setLabelsExternalVpnGatewayCallable() Sets the labels on an ExternalVpnGateway.
void	shutdown()
void	shutdownNow()
TestPermissionsResponse	testIamPermissionsExternalVpnGateway(ProjectGlobalExternalVpnGatewayResourceName resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsExternalVpnGateway(String resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsExternalVpnGateway(TestIamPermissionsExternalVpnGatewayHttpRequest request) Returns permissions that a caller has on the specified resource.
com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsExternalVpnGatewayHttpRequest,TestPermissionsResponse>	testIamPermissionsExternalVpnGatewayCallable() 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

ExternalVpnGatewayClient

protected ExternalVpnGatewayClient(ExternalVpnGatewaySettings settings)
                            throws IOException

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

ExternalVpnGatewayClient

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

Method Detail

create

public static final ExternalVpnGatewayClient create()
                                             throws IOException

Constructs an instance of ExternalVpnGatewayClient with default settings.

Throws:

IOException

create

public static final ExternalVpnGatewayClient create(ExternalVpnGatewaySettings settings)
                                             throws IOException

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

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

getSettings

public final ExternalVpnGatewaySettings getSettings()

getStub

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

deleteExternalVpnGateway

@BetaApi
public final Operation deleteExternalVpnGateway(ProjectGlobalExternalVpnGatewayName externalVpnGateway)

Deletes the specified externalVpnGateway.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectGlobalExternalVpnGatewayName externalVpnGateway = ProjectGlobalExternalVpnGatewayName.of("[PROJECT]", "[EXTERNAL_VPN_GATEWAY]");
   Operation response = externalVpnGatewayClient.deleteExternalVpnGateway(externalVpnGateway);
 }
 

Parameters:

externalVpnGateway - Name of the externalVpnGateways to delete.

Throws:

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

deleteExternalVpnGateway

@BetaApi
public final Operation deleteExternalVpnGateway(String externalVpnGateway)

Deletes the specified externalVpnGateway.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectGlobalExternalVpnGatewayName externalVpnGateway = ProjectGlobalExternalVpnGatewayName.of("[PROJECT]", "[EXTERNAL_VPN_GATEWAY]");
   Operation response = externalVpnGatewayClient.deleteExternalVpnGateway(externalVpnGateway.toString());
 }
 

Parameters:

externalVpnGateway - Name of the externalVpnGateways to delete.

Throws:

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

deleteExternalVpnGateway

@BetaApi
public final Operation deleteExternalVpnGateway(DeleteExternalVpnGatewayHttpRequest request)

Deletes the specified externalVpnGateway.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedExternalVpnGateway = ProjectGlobalExternalVpnGatewayName.format("[PROJECT]", "[EXTERNAL_VPN_GATEWAY]");
   DeleteExternalVpnGatewayHttpRequest request = DeleteExternalVpnGatewayHttpRequest.newBuilder()
     .setExternalVpnGateway(formattedExternalVpnGateway)
     .build();
   Operation response = externalVpnGatewayClient.deleteExternalVpnGateway(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

deleteExternalVpnGatewayCallable

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

Deletes the specified externalVpnGateway.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedExternalVpnGateway = ProjectGlobalExternalVpnGatewayName.format("[PROJECT]", "[EXTERNAL_VPN_GATEWAY]");
   DeleteExternalVpnGatewayHttpRequest request = DeleteExternalVpnGatewayHttpRequest.newBuilder()
     .setExternalVpnGateway(formattedExternalVpnGateway)
     .build();
   ApiFuture<Operation> future = externalVpnGatewayClient.deleteExternalVpnGatewayCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getExternalVpnGateway

@BetaApi
public final ExternalVpnGateway getExternalVpnGateway(ProjectGlobalExternalVpnGatewayName externalVpnGateway)

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectGlobalExternalVpnGatewayName externalVpnGateway = ProjectGlobalExternalVpnGatewayName.of("[PROJECT]", "[EXTERNAL_VPN_GATEWAY]");
   ExternalVpnGateway response = externalVpnGatewayClient.getExternalVpnGateway(externalVpnGateway);
 }
 

Parameters:

externalVpnGateway - Name of the externalVpnGateway to return.

Throws:

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

getExternalVpnGateway

@BetaApi
public final ExternalVpnGateway getExternalVpnGateway(String externalVpnGateway)

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectGlobalExternalVpnGatewayName externalVpnGateway = ProjectGlobalExternalVpnGatewayName.of("[PROJECT]", "[EXTERNAL_VPN_GATEWAY]");
   ExternalVpnGateway response = externalVpnGatewayClient.getExternalVpnGateway(externalVpnGateway.toString());
 }
 

Parameters:

externalVpnGateway - Name of the externalVpnGateway to return.

Throws:

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

getExternalVpnGateway

@BetaApi
public final ExternalVpnGateway getExternalVpnGateway(GetExternalVpnGatewayHttpRequest request)

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedExternalVpnGateway = ProjectGlobalExternalVpnGatewayName.format("[PROJECT]", "[EXTERNAL_VPN_GATEWAY]");
   GetExternalVpnGatewayHttpRequest request = GetExternalVpnGatewayHttpRequest.newBuilder()
     .setExternalVpnGateway(formattedExternalVpnGateway)
     .build();
   ExternalVpnGateway response = externalVpnGatewayClient.getExternalVpnGateway(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

getExternalVpnGatewayCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetExternalVpnGatewayHttpRequest,ExternalVpnGateway> getExternalVpnGatewayCallable()

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedExternalVpnGateway = ProjectGlobalExternalVpnGatewayName.format("[PROJECT]", "[EXTERNAL_VPN_GATEWAY]");
   GetExternalVpnGatewayHttpRequest request = GetExternalVpnGatewayHttpRequest.newBuilder()
     .setExternalVpnGateway(formattedExternalVpnGateway)
     .build();
   ApiFuture<ExternalVpnGateway> future = externalVpnGatewayClient.getExternalVpnGatewayCallable().futureCall(request);
   // Do something
   ExternalVpnGateway response = future.get();
 }
 

insertExternalVpnGateway

@BetaApi
public final Operation insertExternalVpnGateway(ProjectName project,
                                                         ExternalVpnGateway externalVpnGatewayResource)

Creates a ExternalVpnGateway in the specified project using the data included in the request.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   ExternalVpnGateway externalVpnGatewayResource = ExternalVpnGateway.newBuilder().build();
   Operation response = externalVpnGatewayClient.insertExternalVpnGateway(project, externalVpnGatewayResource);
 }
 

Parameters:

project - Project ID for this request.

externalVpnGatewayResource - External VPN gateway is the on-premises VPN gateway(s) or another cloud provider?s VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway.

Throws:

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

insertExternalVpnGateway

@BetaApi
public final Operation insertExternalVpnGateway(String project,
                                                         ExternalVpnGateway externalVpnGatewayResource)

Creates a ExternalVpnGateway in the specified project using the data included in the request.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   ExternalVpnGateway externalVpnGatewayResource = ExternalVpnGateway.newBuilder().build();
   Operation response = externalVpnGatewayClient.insertExternalVpnGateway(project.toString(), externalVpnGatewayResource);
 }
 

Parameters:

project - Project ID for this request.

externalVpnGatewayResource - External VPN gateway is the on-premises VPN gateway(s) or another cloud provider?s VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway.

Throws:

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

insertExternalVpnGateway

@BetaApi
public final Operation insertExternalVpnGateway(InsertExternalVpnGatewayHttpRequest request)

Creates a ExternalVpnGateway in the specified project using the data included in the request.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ExternalVpnGateway externalVpnGatewayResource = ExternalVpnGateway.newBuilder().build();
   InsertExternalVpnGatewayHttpRequest request = InsertExternalVpnGatewayHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setExternalVpnGatewayResource(externalVpnGatewayResource)
     .build();
   Operation response = externalVpnGatewayClient.insertExternalVpnGateway(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

insertExternalVpnGatewayCallable

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

Creates a ExternalVpnGateway in the specified project using the data included in the request.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ExternalVpnGateway externalVpnGatewayResource = ExternalVpnGateway.newBuilder().build();
   InsertExternalVpnGatewayHttpRequest request = InsertExternalVpnGatewayHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setExternalVpnGatewayResource(externalVpnGatewayResource)
     .build();
   ApiFuture<Operation> future = externalVpnGatewayClient.insertExternalVpnGatewayCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listExternalVpnGateways

@BetaApi
public final ExternalVpnGatewayClient.ListExternalVpnGatewaysPagedResponse listExternalVpnGateways(ProjectName project)

Retrieves the list of ExternalVpnGateway available to the specified project.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (ExternalVpnGateway element : externalVpnGatewayClient.listExternalVpnGateways(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listExternalVpnGateways

@BetaApi
public final ExternalVpnGatewayClient.ListExternalVpnGatewaysPagedResponse listExternalVpnGateways(String project)

Retrieves the list of ExternalVpnGateway available to the specified project.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (ExternalVpnGateway element : externalVpnGatewayClient.listExternalVpnGateways(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listExternalVpnGateways

@BetaApi
public final ExternalVpnGatewayClient.ListExternalVpnGatewaysPagedResponse listExternalVpnGateways(ListExternalVpnGatewaysHttpRequest request)

Retrieves the list of ExternalVpnGateway available to the specified project.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListExternalVpnGatewaysHttpRequest request = ListExternalVpnGatewaysHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (ExternalVpnGateway element : externalVpnGatewayClient.listExternalVpnGateways(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

listExternalVpnGatewaysPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListExternalVpnGatewaysHttpRequest,ExternalVpnGatewayClient.ListExternalVpnGatewaysPagedResponse> listExternalVpnGatewaysPagedCallable()

Retrieves the list of ExternalVpnGateway available to the specified project.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListExternalVpnGatewaysHttpRequest request = ListExternalVpnGatewaysHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListExternalVpnGatewaysPagedResponse> future = externalVpnGatewayClient.listExternalVpnGatewaysPagedCallable().futureCall(request);
   // Do something
   for (ExternalVpnGateway element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listExternalVpnGatewaysCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListExternalVpnGatewaysHttpRequest,ExternalVpnGatewayList> listExternalVpnGatewaysCallable()

Retrieves the list of ExternalVpnGateway available to the specified project.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListExternalVpnGatewaysHttpRequest request = ListExternalVpnGatewaysHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     ExternalVpnGatewayList response = externalVpnGatewayClient.listExternalVpnGatewaysCallable().call(request);
     for (ExternalVpnGateway element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

setLabelsExternalVpnGateway

@BetaApi
public final Operation setLabelsExternalVpnGateway(ProjectGlobalExternalVpnGatewayResourceName resource,
                                                            GlobalSetLabelsRequest globalSetLabelsRequestResource)

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectGlobalExternalVpnGatewayResourceName resource = ProjectGlobalExternalVpnGatewayResourceName.of("[PROJECT]", "[RESOURCE]");
   GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build();
   Operation response = externalVpnGatewayClient.setLabelsExternalVpnGateway(resource, globalSetLabelsRequestResource);
 }
 

Parameters:

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

globalSetLabelsRequestResource -

Throws:

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

setLabelsExternalVpnGateway

@BetaApi
public final Operation setLabelsExternalVpnGateway(String resource,
                                                            GlobalSetLabelsRequest globalSetLabelsRequestResource)

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectGlobalExternalVpnGatewayResourceName resource = ProjectGlobalExternalVpnGatewayResourceName.of("[PROJECT]", "[RESOURCE]");
   GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build();
   Operation response = externalVpnGatewayClient.setLabelsExternalVpnGateway(resource.toString(), globalSetLabelsRequestResource);
 }
 

Parameters:

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

globalSetLabelsRequestResource -

Throws:

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

setLabelsExternalVpnGateway

@BetaApi
public final Operation setLabelsExternalVpnGateway(SetLabelsExternalVpnGatewayHttpRequest request)

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedResource = ProjectGlobalExternalVpnGatewayResourceName.format("[PROJECT]", "[RESOURCE]");
   GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build();
   SetLabelsExternalVpnGatewayHttpRequest request = SetLabelsExternalVpnGatewayHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setGlobalSetLabelsRequestResource(globalSetLabelsRequestResource)
     .build();
   Operation response = externalVpnGatewayClient.setLabelsExternalVpnGateway(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

setLabelsExternalVpnGatewayCallable

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

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedResource = ProjectGlobalExternalVpnGatewayResourceName.format("[PROJECT]", "[RESOURCE]");
   GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build();
   SetLabelsExternalVpnGatewayHttpRequest request = SetLabelsExternalVpnGatewayHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setGlobalSetLabelsRequestResource(globalSetLabelsRequestResource)
     .build();
   ApiFuture<Operation> future = externalVpnGatewayClient.setLabelsExternalVpnGatewayCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

testIamPermissionsExternalVpnGateway

@BetaApi
public final TestPermissionsResponse testIamPermissionsExternalVpnGateway(ProjectGlobalExternalVpnGatewayResourceName resource,
                                                                                   TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectGlobalExternalVpnGatewayResourceName resource = ProjectGlobalExternalVpnGatewayResourceName.of("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = externalVpnGatewayClient.testIamPermissionsExternalVpnGateway(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

testIamPermissionsExternalVpnGateway

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

Returns permissions that a caller has on the specified resource.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   ProjectGlobalExternalVpnGatewayResourceName resource = ProjectGlobalExternalVpnGatewayResourceName.of("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = externalVpnGatewayClient.testIamPermissionsExternalVpnGateway(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

testIamPermissionsExternalVpnGateway

@BetaApi
public final TestPermissionsResponse testIamPermissionsExternalVpnGateway(TestIamPermissionsExternalVpnGatewayHttpRequest request)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedResource = ProjectGlobalExternalVpnGatewayResourceName.format("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsExternalVpnGatewayHttpRequest request = TestIamPermissionsExternalVpnGatewayHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   TestPermissionsResponse response = externalVpnGatewayClient.testIamPermissionsExternalVpnGateway(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

testIamPermissionsExternalVpnGatewayCallable

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

Returns permissions that a caller has on the specified resource.

Sample code:

 try (ExternalVpnGatewayClient externalVpnGatewayClient = ExternalVpnGatewayClient.create()) {
   String formattedResource = ProjectGlobalExternalVpnGatewayResourceName.format("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsExternalVpnGatewayHttpRequest request = TestIamPermissionsExternalVpnGatewayHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   ApiFuture<TestPermissionsResponse> future = externalVpnGatewayClient.testIamPermissionsExternalVpnGatewayCallable().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