Package com.google.cloud.compute.v1

Class TargetVpnGatewaysClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class TargetVpnGatewaysClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: The TargetVpnGateways 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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetVpnGateway = "targetVpnGateway935274273";
   TargetVpnGateway response = targetVpnGatewaysClient.get(project, region, targetVpnGateway);
 }

    Note: close() needs to be called on the TargetVpnGatewaysClient 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 TargetVpnGatewaysSettings 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
 TargetVpnGatewaysSettings targetVpnGatewaysSettings =
     TargetVpnGatewaysSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TargetVpnGatewaysClient targetVpnGatewaysClient =
     TargetVpnGatewaysClient.create(targetVpnGatewaysSettings);

    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
 TargetVpnGatewaysSettings targetVpnGatewaysSettings =
     TargetVpnGatewaysSettings.newBuilder().setEndpoint(myEndpoint).build();
 TargetVpnGatewaysClient targetVpnGatewaysClient =
     TargetVpnGatewaysClient.create(targetVpnGatewaysSettings);

    Please refer to the GitHub repository's samples for more quickstart code snippets.

    • Constructor Detail

      • TargetVpnGatewaysClient

        protected TargetVpnGatewaysClient​(TargetVpnGatewaysSettings settings)
                           throws IOException
        Constructs an instance of TargetVpnGatewaysClient, 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

    • Method Detail

      • create

        public static final TargetVpnGatewaysClient create​(TargetVpnGatewaysStub stub)
        Constructs an instance of TargetVpnGatewaysClient, using the given stub for making calls. This is for advanced usage - prefer using create(TargetVpnGatewaysSettings).

      • aggregatedList

        public final TargetVpnGatewaysClient.AggregatedListPagedResponse aggregatedList​(String project)
        Retrieves an aggregated list of target VPN gateways.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, TargetVpnGatewaysScopedList> element :
       targetVpnGatewaysClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        project - Project ID for this request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • aggregatedList

        public final TargetVpnGatewaysClient.AggregatedListPagedResponse aggregatedList​(AggregatedListTargetVpnGatewaysRequest request)
        Retrieves an aggregated list of target VPN gateways.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   AggregatedListTargetVpnGatewaysRequest request =
       AggregatedListTargetVpnGatewaysRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Map.Entry<String, TargetVpnGatewaysScopedList> element :
       targetVpnGatewaysClient.aggregatedList(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

      • aggregatedListPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetVpnGatewaysRequest,​TargetVpnGatewaysClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
        Retrieves an aggregated list of target VPN gateways.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   AggregatedListTargetVpnGatewaysRequest request =
       AggregatedListTargetVpnGatewaysRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Map.Entry<String, TargetVpnGatewaysScopedList>> future =
       targetVpnGatewaysClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, TargetVpnGatewaysScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • aggregatedListCallable

        public final com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetVpnGatewaysRequest,​TargetVpnGatewayAggregatedList> aggregatedListCallable()
        Retrieves an aggregated list of target VPN gateways.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   AggregatedListTargetVpnGatewaysRequest request =
       AggregatedListTargetVpnGatewaysRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     TargetVpnGatewayAggregatedList response =
         targetVpnGatewaysClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, TargetVpnGatewaysScopedList> element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • deleteAsync

        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> deleteAsync​(String project,
                                                                                                   String region,
                                                                                                   String targetVpnGateway)
        Deletes the specified target VPN gateway.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetVpnGateway = "targetVpnGateway935274273";
   Operation response =
       targetVpnGatewaysClient.deleteAsync(project, region, targetVpnGateway).get();
 }
        Parameters:
        project - Project ID for this request.
        region - Name of the region for this request.
        targetVpnGateway - Name of the target VPN gateway 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​(DeleteTargetVpnGatewayRequest request)
        Deletes the specified target VPN gateway.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   DeleteTargetVpnGatewayRequest request =
       DeleteTargetVpnGatewayRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetVpnGateway("targetVpnGateway935274273")
           .build();
   Operation response = targetVpnGatewaysClient.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<DeleteTargetVpnGatewayRequest,​Operation,​Operation> deleteOperationCallable()
        Deletes the specified target VPN gateway.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   DeleteTargetVpnGatewayRequest request =
       DeleteTargetVpnGatewayRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetVpnGateway("targetVpnGateway935274273")
           .build();
   OperationFuture<Operation, Operation> future =
       targetVpnGatewaysClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • deleteCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteTargetVpnGatewayRequest,​Operation> deleteCallable()
        Deletes the specified target VPN gateway.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   DeleteTargetVpnGatewayRequest request =
       DeleteTargetVpnGatewayRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetVpnGateway("targetVpnGateway935274273")
           .build();
   ApiFuture<Operation> future = targetVpnGatewaysClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • get

        public final TargetVpnGateway get​(String project,
                                  String region,
                                  String targetVpnGateway)
        Returns the specified target VPN gateway.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetVpnGateway = "targetVpnGateway935274273";
   TargetVpnGateway response = targetVpnGatewaysClient.get(project, region, targetVpnGateway);
 }
        Parameters:
        project - Project ID for this request.
        region - Name of the region for this request.
        targetVpnGateway - Name of the target VPN gateway to return.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • get

        public final TargetVpnGateway get​(GetTargetVpnGatewayRequest request)
        Returns the specified target VPN gateway.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   GetTargetVpnGatewayRequest request =
       GetTargetVpnGatewayRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setTargetVpnGateway("targetVpnGateway935274273")
           .build();
   TargetVpnGateway response = targetVpnGatewaysClient.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<GetTargetVpnGatewayRequest,​TargetVpnGateway> getCallable()
        Returns the specified target VPN gateway.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   GetTargetVpnGatewayRequest request =
       GetTargetVpnGatewayRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setTargetVpnGateway("targetVpnGateway935274273")
           .build();
   ApiFuture<TargetVpnGateway> future =
       targetVpnGatewaysClient.getCallable().futureCall(request);
   // Do something.
   TargetVpnGateway response = future.get();
 }

      • insertAsync

        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> insertAsync​(String project,
                                                                                                   String region,
                                                                                                   TargetVpnGateway targetVpnGatewayResource)
        Creates a target VPN gateway in the specified project and region 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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   TargetVpnGateway targetVpnGatewayResource = TargetVpnGateway.newBuilder().build();
   Operation response =
       targetVpnGatewaysClient.insertAsync(project, region, targetVpnGatewayResource).get();
 }
        Parameters:
        project - Project ID for this request.
        region - Name of the region for this request.
        targetVpnGatewayResource - 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​(InsertTargetVpnGatewayRequest request)
        Creates a target VPN gateway in the specified project and region 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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   InsertTargetVpnGatewayRequest request =
       InsertTargetVpnGatewayRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetVpnGatewayResource(TargetVpnGateway.newBuilder().build())
           .build();
   Operation response = targetVpnGatewaysClient.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<InsertTargetVpnGatewayRequest,​Operation,​Operation> insertOperationCallable()
        Creates a target VPN gateway in the specified project and region 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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   InsertTargetVpnGatewayRequest request =
       InsertTargetVpnGatewayRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetVpnGatewayResource(TargetVpnGateway.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       targetVpnGatewaysClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • insertCallable

        public final com.google.api.gax.rpc.UnaryCallable<InsertTargetVpnGatewayRequest,​Operation> insertCallable()
        Creates a target VPN gateway in the specified project and region 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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   InsertTargetVpnGatewayRequest request =
       InsertTargetVpnGatewayRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetVpnGatewayResource(TargetVpnGateway.newBuilder().build())
           .build();
   ApiFuture<Operation> future = targetVpnGatewaysClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • list

        public final TargetVpnGatewaysClient.ListPagedResponse list​(String project,
                                                            String region)
        Retrieves a list of target VPN gateways available to the specified project and region.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (TargetVpnGateway element : targetVpnGatewaysClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        project - Project ID for this request.
        region - Name of the region for this request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • list

        public final TargetVpnGatewaysClient.ListPagedResponse list​(ListTargetVpnGatewaysRequest request)
        Retrieves a list of target VPN gateways available to the specified project and region.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   ListTargetVpnGatewaysRequest request =
       ListTargetVpnGatewaysRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (TargetVpnGateway element : targetVpnGatewaysClient.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<ListTargetVpnGatewaysRequest,​TargetVpnGatewaysClient.ListPagedResponse> listPagedCallable()
        Retrieves a list of target VPN gateways available to the specified project and region.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   ListTargetVpnGatewaysRequest request =
       ListTargetVpnGatewaysRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<TargetVpnGateway> future =
       targetVpnGatewaysClient.listPagedCallable().futureCall(request);
   // Do something.
   for (TargetVpnGateway element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • listCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListTargetVpnGatewaysRequest,​TargetVpnGatewayList> listCallable()
        Retrieves a list of target VPN gateways available to the specified project and region.

        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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   ListTargetVpnGatewaysRequest request =
       ListTargetVpnGatewaysRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     TargetVpnGatewayList response = targetVpnGatewaysClient.listCallable().call(request);
     for (TargetVpnGateway element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • setLabelsAsync

        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> setLabelsAsync​(String project,
                                                                                                      String region,
                                                                                                      String resource,
                                                                                                      RegionSetLabelsRequest regionSetLabelsRequestResource)
        Sets the labels on a TargetVpnGateway. 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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   RegionSetLabelsRequest regionSetLabelsRequestResource =
       RegionSetLabelsRequest.newBuilder().build();
   Operation response =
       targetVpnGatewaysClient
           .setLabelsAsync(project, region, resource, regionSetLabelsRequestResource)
           .get();
 }
        Parameters:
        project - Project ID for this request.
        region - The region for this request.
        resource - Name or id of the resource for this request.
        regionSetLabelsRequestResource - 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​(SetLabelsTargetVpnGatewayRequest request)
        Sets the labels on a TargetVpnGateway. 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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   SetLabelsTargetVpnGatewayRequest request =
       SetLabelsTargetVpnGatewayRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   Operation response = targetVpnGatewaysClient.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<SetLabelsTargetVpnGatewayRequest,​Operation,​Operation> setLabelsOperationCallable()
        Sets the labels on a TargetVpnGateway. 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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   SetLabelsTargetVpnGatewayRequest request =
       SetLabelsTargetVpnGatewayRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   OperationFuture<Operation, Operation> future =
       targetVpnGatewaysClient.setLabelsOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • setLabelsCallable

        public final com.google.api.gax.rpc.UnaryCallable<SetLabelsTargetVpnGatewayRequest,​Operation> setLabelsCallable()
        Sets the labels on a TargetVpnGateway. 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 (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
   SetLabelsTargetVpnGatewayRequest request =
       SetLabelsTargetVpnGatewayRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Operation> future = targetVpnGatewaysClient.setLabelsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • 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