Class ExternalVpnGatewaysClient
- java.lang.Object
-
- com.google.cloud.compute.v1.ExternalVpnGatewaysClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class ExternalVpnGatewaysClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: The ExternalVpnGateways API.This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { String project = "project-309310695"; String externalVpnGateway = "externalVpnGateway-1140582181"; ExternalVpnGateway response = externalVpnGatewaysClient.get(project, externalVpnGateway); }
Note: close() needs to be called on the ExternalVpnGatewaysClient 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:
- 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.
- 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.
- 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 ExternalVpnGatewaysSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library ExternalVpnGatewaysSettings externalVpnGatewaysSettings = ExternalVpnGatewaysSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create(externalVpnGatewaysSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library ExternalVpnGatewaysSettings externalVpnGatewaysSettings = ExternalVpnGatewaysSettings.newBuilder().setEndpoint(myEndpoint).build(); ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create(externalVpnGatewaysSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ExternalVpnGatewaysClient.ListFixedSizeCollection
static class
ExternalVpnGatewaysClient.ListPage
static class
ExternalVpnGatewaysClient.ListPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
ExternalVpnGatewaysClient(ExternalVpnGatewaysSettings settings)
Constructs an instance of ExternalVpnGatewaysClient, using the given settings.protected
ExternalVpnGatewaysClient(ExternalVpnGatewaysStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static ExternalVpnGatewaysClient
create()
Constructs an instance of ExternalVpnGatewaysClient with default settings.static ExternalVpnGatewaysClient
create(ExternalVpnGatewaysSettings settings)
Constructs an instance of ExternalVpnGatewaysClient, using the given settings.static ExternalVpnGatewaysClient
create(ExternalVpnGatewaysStub stub)
Constructs an instance of ExternalVpnGatewaysClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(DeleteExternalVpnGatewayRequest request)
Deletes the specified externalVpnGateway.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(String project, String externalVpnGateway)
Deletes the specified externalVpnGateway.com.google.api.gax.rpc.UnaryCallable<DeleteExternalVpnGatewayRequest,Operation>
deleteCallable()
Deletes the specified externalVpnGateway.com.google.api.gax.rpc.OperationCallable<DeleteExternalVpnGatewayRequest,Operation,Operation>
deleteOperationCallable()
Deletes the specified externalVpnGateway.ExternalVpnGateway
get(GetExternalVpnGatewayRequest request)
Returns the specified externalVpnGateway.ExternalVpnGateway
get(String project, String externalVpnGateway)
Returns the specified externalVpnGateway.com.google.api.gax.rpc.UnaryCallable<GetExternalVpnGatewayRequest,ExternalVpnGateway>
getCallable()
Returns the specified externalVpnGateway.ExternalVpnGatewaysSettings
getSettings()
ExternalVpnGatewaysStub
getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(InsertExternalVpnGatewayRequest request)
Creates a ExternalVpnGateway in the specified project using the data included in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(String project, ExternalVpnGateway externalVpnGatewayResource)
Creates a ExternalVpnGateway in the specified project using the data included in the request.com.google.api.gax.rpc.UnaryCallable<InsertExternalVpnGatewayRequest,Operation>
insertCallable()
Creates a ExternalVpnGateway in the specified project using the data included in the request.com.google.api.gax.rpc.OperationCallable<InsertExternalVpnGatewayRequest,Operation,Operation>
insertOperationCallable()
Creates a ExternalVpnGateway in the specified project using the data included in the request.boolean
isShutdown()
boolean
isTerminated()
ExternalVpnGatewaysClient.ListPagedResponse
list(ListExternalVpnGatewaysRequest request)
Retrieves the list of ExternalVpnGateway available to the specified project.ExternalVpnGatewaysClient.ListPagedResponse
list(String project)
Retrieves the list of ExternalVpnGateway available to the specified project.com.google.api.gax.rpc.UnaryCallable<ListExternalVpnGatewaysRequest,ExternalVpnGatewayList>
listCallable()
Retrieves the list of ExternalVpnGateway available to the specified project.com.google.api.gax.rpc.UnaryCallable<ListExternalVpnGatewaysRequest,ExternalVpnGatewaysClient.ListPagedResponse>
listPagedCallable()
Retrieves the list of ExternalVpnGateway available to the specified project.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
setLabelsAsync(SetLabelsExternalVpnGatewayRequest request)
Sets the labels on an ExternalVpnGateway.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
setLabelsAsync(String project, String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource)
Sets the labels on an ExternalVpnGateway.com.google.api.gax.rpc.UnaryCallable<SetLabelsExternalVpnGatewayRequest,Operation>
setLabelsCallable()
Sets the labels on an ExternalVpnGateway.com.google.api.gax.rpc.OperationCallable<SetLabelsExternalVpnGatewayRequest,Operation,Operation>
setLabelsOperationCallable()
Sets the labels on an ExternalVpnGateway.void
shutdown()
void
shutdownNow()
TestPermissionsResponse
testIamPermissions(TestIamPermissionsExternalVpnGatewayRequest request)
Returns permissions that a caller has on the specified resource.TestPermissionsResponse
testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource)
Returns permissions that a caller has on the specified resource.com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsExternalVpnGatewayRequest,TestPermissionsResponse>
testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.
-
-
-
Constructor Detail
-
ExternalVpnGatewaysClient
protected ExternalVpnGatewaysClient(ExternalVpnGatewaysSettings settings) throws IOException
Constructs an instance of ExternalVpnGatewaysClient, 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
-
ExternalVpnGatewaysClient
protected ExternalVpnGatewaysClient(ExternalVpnGatewaysStub stub)
-
-
Method Detail
-
create
public static final ExternalVpnGatewaysClient create() throws IOException
Constructs an instance of ExternalVpnGatewaysClient with default settings.- Throws:
IOException
-
create
public static final ExternalVpnGatewaysClient create(ExternalVpnGatewaysSettings settings) throws IOException
Constructs an instance of ExternalVpnGatewaysClient, 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
public static final ExternalVpnGatewaysClient create(ExternalVpnGatewaysStub stub)
Constructs an instance of ExternalVpnGatewaysClient, using the given stub for making calls. This is for advanced usage - prefer using create(ExternalVpnGatewaysSettings).
-
getSettings
public final ExternalVpnGatewaysSettings getSettings()
-
getStub
public ExternalVpnGatewaysStub getStub()
-
deleteAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(String project, String externalVpnGateway)
Deletes the specified externalVpnGateway.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { String project = "project-309310695"; String externalVpnGateway = "externalVpnGateway-1140582181"; Operation response = externalVpnGatewaysClient.deleteAsync(project, externalVpnGateway).get(); }
- Parameters:
project
- Project ID for this request.externalVpnGateway
- Name of the externalVpnGateways to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(DeleteExternalVpnGatewayRequest request)
Deletes the specified externalVpnGateway.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { DeleteExternalVpnGatewayRequest request = DeleteExternalVpnGatewayRequest.newBuilder() .setExternalVpnGateway("externalVpnGateway-1140582181") .setProject("project-309310695") .setRequestId("requestId693933066") .build(); Operation response = externalVpnGatewaysClient.deleteAsync(request).get(); }
- 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
-
deleteOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteExternalVpnGatewayRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified externalVpnGateway.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { DeleteExternalVpnGatewayRequest request = DeleteExternalVpnGatewayRequest.newBuilder() .setExternalVpnGateway("externalVpnGateway-1140582181") .setProject("project-309310695") .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = externalVpnGatewaysClient.deleteOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deleteCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteExternalVpnGatewayRequest,Operation> deleteCallable()
Deletes the specified externalVpnGateway.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { DeleteExternalVpnGatewayRequest request = DeleteExternalVpnGatewayRequest.newBuilder() .setExternalVpnGateway("externalVpnGateway-1140582181") .setProject("project-309310695") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = externalVpnGatewaysClient.deleteCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
get
public final ExternalVpnGateway get(String project, String externalVpnGateway)
Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { String project = "project-309310695"; String externalVpnGateway = "externalVpnGateway-1140582181"; ExternalVpnGateway response = externalVpnGatewaysClient.get(project, externalVpnGateway); }
- Parameters:
project
- Project ID for this request.externalVpnGateway
- Name of the externalVpnGateway to return.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
get
public final ExternalVpnGateway get(GetExternalVpnGatewayRequest request)
Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { GetExternalVpnGatewayRequest request = GetExternalVpnGatewayRequest.newBuilder() .setExternalVpnGateway("externalVpnGateway-1140582181") .setProject("project-309310695") .build(); ExternalVpnGateway response = externalVpnGatewaysClient.get(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
-
getCallable
public final com.google.api.gax.rpc.UnaryCallable<GetExternalVpnGatewayRequest,ExternalVpnGateway> getCallable()
Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { GetExternalVpnGatewayRequest request = GetExternalVpnGatewayRequest.newBuilder() .setExternalVpnGateway("externalVpnGateway-1140582181") .setProject("project-309310695") .build(); ApiFuture<ExternalVpnGateway> future = externalVpnGatewaysClient.getCallable().futureCall(request); // Do something. ExternalVpnGateway response = future.get(); }
-
insertAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project, ExternalVpnGateway externalVpnGatewayResource)
Creates a ExternalVpnGateway in the specified project using the data included in the request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { String project = "project-309310695"; ExternalVpnGateway externalVpnGatewayResource = ExternalVpnGateway.newBuilder().build(); Operation response = externalVpnGatewaysClient.insertAsync(project, externalVpnGatewayResource).get(); }
- Parameters:
project
- Project ID for this request.externalVpnGatewayResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(InsertExternalVpnGatewayRequest request)
Creates a ExternalVpnGateway in the specified project using the data included in the request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { InsertExternalVpnGatewayRequest request = InsertExternalVpnGatewayRequest.newBuilder() .setExternalVpnGatewayResource(ExternalVpnGateway.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .build(); Operation response = externalVpnGatewaysClient.insertAsync(request).get(); }
- 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
-
insertOperationCallable
public final com.google.api.gax.rpc.OperationCallable<InsertExternalVpnGatewayRequest,Operation,Operation> insertOperationCallable()
Creates a ExternalVpnGateway in the specified project using the data included in the request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { InsertExternalVpnGatewayRequest request = InsertExternalVpnGatewayRequest.newBuilder() .setExternalVpnGatewayResource(ExternalVpnGateway.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = externalVpnGatewaysClient.insertOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
insertCallable
public final com.google.api.gax.rpc.UnaryCallable<InsertExternalVpnGatewayRequest,Operation> insertCallable()
Creates a ExternalVpnGateway in the specified project using the data included in the request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { InsertExternalVpnGatewayRequest request = InsertExternalVpnGatewayRequest.newBuilder() .setExternalVpnGatewayResource(ExternalVpnGateway.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = externalVpnGatewaysClient.insertCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
list
public final ExternalVpnGatewaysClient.ListPagedResponse list(String project)
Retrieves the list of ExternalVpnGateway available to the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { String project = "project-309310695"; for (ExternalVpnGateway element : externalVpnGatewaysClient.list(project).iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
list
public final ExternalVpnGatewaysClient.ListPagedResponse list(ListExternalVpnGatewaysRequest request)
Retrieves the list of ExternalVpnGateway available to the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { ListExternalVpnGatewaysRequest request = ListExternalVpnGatewaysRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); for (ExternalVpnGateway element : externalVpnGatewaysClient.list(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
-
listPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListExternalVpnGatewaysRequest,ExternalVpnGatewaysClient.ListPagedResponse> listPagedCallable()
Retrieves the list of ExternalVpnGateway available to the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { ListExternalVpnGatewaysRequest request = ListExternalVpnGatewaysRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); ApiFuture<ExternalVpnGateway> future = externalVpnGatewaysClient.listPagedCallable().futureCall(request); // Do something. for (ExternalVpnGateway element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listCallable
public final com.google.api.gax.rpc.UnaryCallable<ListExternalVpnGatewaysRequest,ExternalVpnGatewayList> listCallable()
Retrieves the list of ExternalVpnGateway available to the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { ListExternalVpnGatewaysRequest request = ListExternalVpnGatewaysRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); while (true) { ExternalVpnGatewayList response = externalVpnGatewaysClient.listCallable().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; } } }
-
setLabelsAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setLabelsAsync(String project, String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource)
Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { String project = "project-309310695"; String resource = "resource-341064690"; GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build(); Operation response = externalVpnGatewaysClient .setLabelsAsync(project, resource, globalSetLabelsRequestResource) .get(); }
- Parameters:
project
- Project ID for this request.resource
- Name or id of the resource for this request.globalSetLabelsRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setLabelsAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsExternalVpnGatewayRequest request)
Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { SetLabelsExternalVpnGatewayRequest request = SetLabelsExternalVpnGatewayRequest.newBuilder() .setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build()) .setProject("project-309310695") .setResource("resource-341064690") .build(); Operation response = externalVpnGatewaysClient.setLabelsAsync(request).get(); }
- 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
-
setLabelsOperationCallable
public final com.google.api.gax.rpc.OperationCallable<SetLabelsExternalVpnGatewayRequest,Operation,Operation> setLabelsOperationCallable()
Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { SetLabelsExternalVpnGatewayRequest request = SetLabelsExternalVpnGatewayRequest.newBuilder() .setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build()) .setProject("project-309310695") .setResource("resource-341064690") .build(); OperationFuture<Operation, Operation> future = externalVpnGatewaysClient.setLabelsOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
setLabelsCallable
public final com.google.api.gax.rpc.UnaryCallable<SetLabelsExternalVpnGatewayRequest,Operation> setLabelsCallable()
Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { SetLabelsExternalVpnGatewayRequest request = SetLabelsExternalVpnGatewayRequest.newBuilder() .setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build()) .setProject("project-309310695") .setResource("resource-341064690") .build(); ApiFuture<Operation> future = externalVpnGatewaysClient.setLabelsCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
testIamPermissions
public final TestPermissionsResponse testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource)
Returns permissions that a caller has on the specified resource.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { String project = "project-309310695"; String resource = "resource-341064690"; TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build(); TestPermissionsResponse response = externalVpnGatewaysClient.testIamPermissions( project, resource, testPermissionsRequestResource); }
- Parameters:
project
- Project ID for this request.resource
- Name or id of the resource for this request.testPermissionsRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissions
public final TestPermissionsResponse testIamPermissions(TestIamPermissionsExternalVpnGatewayRequest request)
Returns permissions that a caller has on the specified resource.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { TestIamPermissionsExternalVpnGatewayRequest request = TestIamPermissionsExternalVpnGatewayRequest.newBuilder() .setProject("project-309310695") .setResource("resource-341064690") .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build()) .build(); TestPermissionsResponse response = externalVpnGatewaysClient.testIamPermissions(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
-
testIamPermissionsCallable
public final com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsExternalVpnGatewayRequest,TestPermissionsResponse> testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.create()) { TestIamPermissionsExternalVpnGatewayRequest request = TestIamPermissionsExternalVpnGatewayRequest.newBuilder() .setProject("project-309310695") .setResource("resource-341064690") .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build()) .build(); ApiFuture<TestPermissionsResponse> future = externalVpnGatewaysClient.testIamPermissionsCallable().futureCall(request); // Do something. TestPermissionsResponse response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-