Package com.google.cloud.beyondcorp.clientgateways.v1

Class ClientGatewaysServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class ClientGatewaysServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: API Overview:

    The `beyondcorp.googleapis.com` service implements the Google Cloud BeyondCorp API.

    Data Model:

    The ClientGatewaysService exposes the following resources:

    • Client Gateways, named as follows: `projects/{project_id}/locations/{location_id}/clientGateways/{client_gateway_id}`.

    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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   ClientGatewayName name = ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]");
   ClientGateway response = clientGatewaysServiceClient.getClientGateway(name);
 }

    Note: close() needs to be called on the ClientGatewaysServiceClient 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 ClientGatewaysServiceSettings 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
 ClientGatewaysServiceSettings clientGatewaysServiceSettings =
     ClientGatewaysServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create(clientGatewaysServiceSettings);

    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
 ClientGatewaysServiceSettings clientGatewaysServiceSettings =
     ClientGatewaysServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create(clientGatewaysServiceSettings);

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

    • Constructor Detail

      • ClientGatewaysServiceClient

        protected ClientGatewaysServiceClient​(ClientGatewaysServiceSettings settings)
                               throws IOException
        Constructs an instance of ClientGatewaysServiceClient, 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 ClientGatewaysServiceClient create​(ClientGatewaysServiceStub stub)
        Constructs an instance of ClientGatewaysServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ClientGatewaysServiceSettings).

      • getOperationsClient

        public final com.google.longrunning.OperationsClient getOperationsClient()
        Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

      • listClientGateways

        public final ClientGatewaysServiceClient.ListClientGatewaysPagedResponse listClientGateways​(LocationName parent)
        Lists ClientGateways in a given project and location.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ClientGateway element :
       clientGatewaysServiceClient.listClientGateways(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. Parent value for ListClientGatewaysRequest.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listClientGateways

        public final ClientGatewaysServiceClient.ListClientGatewaysPagedResponse listClientGateways​(String parent)
        Lists ClientGateways in a given project and location.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (ClientGateway element :
       clientGatewaysServiceClient.listClientGateways(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. Parent value for ListClientGatewaysRequest.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listClientGateways

        public final ClientGatewaysServiceClient.ListClientGatewaysPagedResponse listClientGateways​(ListClientGatewaysRequest request)
        Lists ClientGateways in a given project and location.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   ListClientGatewaysRequest request =
       ListClientGatewaysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (ClientGateway element :
       clientGatewaysServiceClient.listClientGateways(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

      • listClientGatewaysPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListClientGatewaysRequest,​ClientGatewaysServiceClient.ListClientGatewaysPagedResponse> listClientGatewaysPagedCallable()
        Lists ClientGateways in a given project and location.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   ListClientGatewaysRequest request =
       ListClientGatewaysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<ClientGateway> future =
       clientGatewaysServiceClient.listClientGatewaysPagedCallable().futureCall(request);
   // Do something.
   for (ClientGateway element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • listClientGatewaysCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListClientGatewaysRequest,​ListClientGatewaysResponse> listClientGatewaysCallable()
        Lists ClientGateways in a given project and location.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   ListClientGatewaysRequest request =
       ListClientGatewaysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListClientGatewaysResponse response =
         clientGatewaysServiceClient.listClientGatewaysCallable().call(request);
     for (ClientGateway element : response.getClientGatewaysList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • getClientGateway

        public final ClientGateway getClientGateway​(ClientGatewayName name)
        Gets details of a single ClientGateway.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   ClientGatewayName name = ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]");
   ClientGateway response = clientGatewaysServiceClient.getClientGateway(name);
 }
        Parameters:
        name - Required. Name of the resource
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getClientGateway

        public final ClientGateway getClientGateway​(String name)
        Gets details of a single ClientGateway.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   String name = ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString();
   ClientGateway response = clientGatewaysServiceClient.getClientGateway(name);
 }
        Parameters:
        name - Required. Name of the resource
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getClientGateway

        public final ClientGateway getClientGateway​(GetClientGatewayRequest request)
        Gets details of a single ClientGateway.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   GetClientGatewayRequest request =
       GetClientGatewayRequest.newBuilder()
           .setName(
               ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString())
           .build();
   ClientGateway response = clientGatewaysServiceClient.getClientGateway(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

      • getClientGatewayCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetClientGatewayRequest,​ClientGateway> getClientGatewayCallable()
        Gets details of a single ClientGateway.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   GetClientGatewayRequest request =
       GetClientGatewayRequest.newBuilder()
           .setName(
               ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString())
           .build();
   ApiFuture<ClientGateway> future =
       clientGatewaysServiceClient.getClientGatewayCallable().futureCall(request);
   // Do something.
   ClientGateway response = future.get();
 }

      • createClientGatewayAsync

        public final com.google.api.gax.longrunning.OperationFuture<ClientGateway,​ClientGatewayOperationMetadata> createClientGatewayAsync​(LocationName parent,
                                                                                                                                         ClientGateway clientGateway,
                                                                                                                                         String clientGatewayId)
        Creates a new ClientGateway in a given project and location.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ClientGateway clientGateway = ClientGateway.newBuilder().build();
   String clientGatewayId = "clientGatewayId-1199632652";
   ClientGateway response =
       clientGatewaysServiceClient
           .createClientGatewayAsync(parent, clientGateway, clientGatewayId)
           .get();
 }
        Parameters:
        parent - Required. Value for parent.
        clientGateway - Required. The resource being created.
        clientGatewayId - Optional. User-settable client gateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/[a-z][0-9]-/`. * Must end with a number or a letter.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createClientGatewayAsync

        public final com.google.api.gax.longrunning.OperationFuture<ClientGateway,​ClientGatewayOperationMetadata> createClientGatewayAsync​(String parent,
                                                                                                                                         ClientGateway clientGateway,
                                                                                                                                         String clientGatewayId)
        Creates a new ClientGateway in a given project and location.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ClientGateway clientGateway = ClientGateway.newBuilder().build();
   String clientGatewayId = "clientGatewayId-1199632652";
   ClientGateway response =
       clientGatewaysServiceClient
           .createClientGatewayAsync(parent, clientGateway, clientGatewayId)
           .get();
 }
        Parameters:
        parent - Required. Value for parent.
        clientGateway - Required. The resource being created.
        clientGatewayId - Optional. User-settable client gateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/[a-z][0-9]-/`. * Must end with a number or a letter.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createClientGatewayAsync

        public final com.google.api.gax.longrunning.OperationFuture<ClientGateway,​ClientGatewayOperationMetadata> createClientGatewayAsync​(CreateClientGatewayRequest request)
        Creates a new ClientGateway in a given project and location.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   CreateClientGatewayRequest request =
       CreateClientGatewayRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClientGatewayId("clientGatewayId-1199632652")
           .setClientGateway(ClientGateway.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ClientGateway response = clientGatewaysServiceClient.createClientGatewayAsync(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

      • createClientGatewayOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<CreateClientGatewayRequest,​ClientGateway,​ClientGatewayOperationMetadata> createClientGatewayOperationCallable()
        Creates a new ClientGateway in a given project and location.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   CreateClientGatewayRequest request =
       CreateClientGatewayRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClientGatewayId("clientGatewayId-1199632652")
           .setClientGateway(ClientGateway.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<ClientGateway, ClientGatewayOperationMetadata> future =
       clientGatewaysServiceClient.createClientGatewayOperationCallable().futureCall(request);
   // Do something.
   ClientGateway response = future.get();
 }

      • createClientGatewayCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateClientGatewayRequest,​com.google.longrunning.Operation> createClientGatewayCallable()
        Creates a new ClientGateway in a given project and location.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   CreateClientGatewayRequest request =
       CreateClientGatewayRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClientGatewayId("clientGatewayId-1199632652")
           .setClientGateway(ClientGateway.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       clientGatewaysServiceClient.createClientGatewayCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • deleteClientGatewayAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​ClientGatewayOperationMetadata> deleteClientGatewayAsync​(ClientGatewayName name)
        Deletes a single ClientGateway.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   ClientGatewayName name = ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]");
   clientGatewaysServiceClient.deleteClientGatewayAsync(name).get();
 }
        Parameters:
        name - Required. Name of the resource
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteClientGatewayAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​ClientGatewayOperationMetadata> deleteClientGatewayAsync​(String name)
        Deletes a single ClientGateway.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   String name = ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString();
   clientGatewaysServiceClient.deleteClientGatewayAsync(name).get();
 }
        Parameters:
        name - Required. Name of the resource
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteClientGatewayAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​ClientGatewayOperationMetadata> deleteClientGatewayAsync​(DeleteClientGatewayRequest request)
        Deletes a single ClientGateway.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   DeleteClientGatewayRequest request =
       DeleteClientGatewayRequest.newBuilder()
           .setName(
               ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   clientGatewaysServiceClient.deleteClientGatewayAsync(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

      • deleteClientGatewayOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<DeleteClientGatewayRequest,​com.google.protobuf.Empty,​ClientGatewayOperationMetadata> deleteClientGatewayOperationCallable()
        Deletes a single ClientGateway.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   DeleteClientGatewayRequest request =
       DeleteClientGatewayRequest.newBuilder()
           .setName(
               ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<Empty, ClientGatewayOperationMetadata> future =
       clientGatewaysServiceClient.deleteClientGatewayOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

      • deleteClientGatewayCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteClientGatewayRequest,​com.google.longrunning.Operation> deleteClientGatewayCallable()
        Deletes a single ClientGateway.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   DeleteClientGatewayRequest request =
       DeleteClientGatewayRequest.newBuilder()
           .setName(
               ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       clientGatewaysServiceClient.deleteClientGatewayCallable().futureCall(request);
   // Do something.
   future.get();
 }

      • listLocations

        public final ClientGatewaysServiceClient.ListLocationsPagedResponse listLocations​(com.google.cloud.location.ListLocationsRequest request)
        Lists information about the supported locations for this service.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : clientGatewaysServiceClient.listLocations(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

      • listLocationsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,​ClientGatewaysServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
        Lists information about the supported locations for this service.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       clientGatewaysServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • listLocationsCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,​com.google.cloud.location.ListLocationsResponse> listLocationsCallable()
        Lists information about the supported locations for this service.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         clientGatewaysServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • getLocation

        public final com.google.cloud.location.Location getLocation​(com.google.cloud.location.GetLocationRequest request)
        Gets information about a location.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = clientGatewaysServiceClient.getLocation(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

      • getLocationCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,​com.google.cloud.location.Location> getLocationCallable()
        Gets information about a location.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       clientGatewaysServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

      • setIamPolicy

        public final com.google.iam.v1.Policy setIamPolicy​(com.google.iam.v1.SetIamPolicyRequest request)
        Sets the access control policy on the specified resource. Replacesany existing policy.

        Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = clientGatewaysServiceClient.setIamPolicy(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

      • setIamPolicyCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,​com.google.iam.v1.Policy> setIamPolicyCallable()
        Sets the access control policy on the specified resource. Replacesany existing policy.

        Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       clientGatewaysServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

      • getIamPolicy

        public final com.google.iam.v1.Policy getIamPolicy​(com.google.iam.v1.GetIamPolicyRequest request)
        Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = clientGatewaysServiceClient.getIamPolicy(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

      • getIamPolicyCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,​com.google.iam.v1.Policy> getIamPolicyCallable()
        Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       clientGatewaysServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

      • testIamPermissions

        public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions​(com.google.iam.v1.TestIamPermissionsRequest request)
        Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

        Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = clientGatewaysServiceClient.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<com.google.iam.v1.TestIamPermissionsRequest,​com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()
        Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

        Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

        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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       clientGatewaysServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse 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