Package com.google.cloud.beyondcorp.appgateways.v1

Class AppGatewaysServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class AppGatewaysServiceClient
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 AppGatewaysService exposes the following resources:

    • AppGateways, named as follows: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`.

    The AppGatewaysService service provides methods to manage (create/read/update/delete) BeyondCorp AppGateways.

    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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   AppGatewayName name = AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]");
   AppGateway response = appGatewaysServiceClient.getAppGateway(name);
 }

    Note: close() needs to be called on the AppGatewaysServiceClient 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 AppGatewaysServiceSettings 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
 AppGatewaysServiceSettings appGatewaysServiceSettings =
     AppGatewaysServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AppGatewaysServiceClient appGatewaysServiceClient =
     AppGatewaysServiceClient.create(appGatewaysServiceSettings);

    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
 AppGatewaysServiceSettings appGatewaysServiceSettings =
     AppGatewaysServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AppGatewaysServiceClient appGatewaysServiceClient =
     AppGatewaysServiceClient.create(appGatewaysServiceSettings);

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

    • Constructor Detail

      • AppGatewaysServiceClient

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

      • 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.

      • listAppGateways

        public final AppGatewaysServiceClient.ListAppGatewaysPagedResponse listAppGateways​(LocationName parent)
        Lists AppGateways 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (AppGateway element : appGatewaysServiceClient.listAppGateways(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. The resource name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listAppGateways

        public final AppGatewaysServiceClient.ListAppGatewaysPagedResponse listAppGateways​(String parent)
        Lists AppGateways 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (AppGateway element : appGatewaysServiceClient.listAppGateways(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. The resource name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listAppGateways

        public final AppGatewaysServiceClient.ListAppGatewaysPagedResponse listAppGateways​(ListAppGatewaysRequest request)
        Lists AppGateways 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   ListAppGatewaysRequest request =
       ListAppGatewaysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (AppGateway element : appGatewaysServiceClient.listAppGateways(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

      • listAppGatewaysPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListAppGatewaysRequest,​AppGatewaysServiceClient.ListAppGatewaysPagedResponse> listAppGatewaysPagedCallable()
        Lists AppGateways 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   ListAppGatewaysRequest request =
       ListAppGatewaysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<AppGateway> future =
       appGatewaysServiceClient.listAppGatewaysPagedCallable().futureCall(request);
   // Do something.
   for (AppGateway element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • listAppGatewaysCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListAppGatewaysRequest,​ListAppGatewaysResponse> listAppGatewaysCallable()
        Lists AppGateways 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   ListAppGatewaysRequest request =
       ListAppGatewaysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListAppGatewaysResponse response =
         appGatewaysServiceClient.listAppGatewaysCallable().call(request);
     for (AppGateway element : response.getAppGatewaysList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • getAppGateway

        public final AppGateway getAppGateway​(AppGatewayName name)
        Gets details of a single AppGateway.

        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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   AppGatewayName name = AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]");
   AppGateway response = appGatewaysServiceClient.getAppGateway(name);
 }
        Parameters:
        name - Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getAppGateway

        public final AppGateway getAppGateway​(String name)
        Gets details of a single AppGateway.

        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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   String name = AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString();
   AppGateway response = appGatewaysServiceClient.getAppGateway(name);
 }
        Parameters:
        name - Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getAppGateway

        public final AppGateway getAppGateway​(GetAppGatewayRequest request)
        Gets details of a single AppGateway.

        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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   GetAppGatewayRequest request =
       GetAppGatewayRequest.newBuilder()
           .setName(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .build();
   AppGateway response = appGatewaysServiceClient.getAppGateway(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

      • getAppGatewayCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetAppGatewayRequest,​AppGateway> getAppGatewayCallable()
        Gets details of a single AppGateway.

        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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   GetAppGatewayRequest request =
       GetAppGatewayRequest.newBuilder()
           .setName(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .build();
   ApiFuture<AppGateway> future =
       appGatewaysServiceClient.getAppGatewayCallable().futureCall(request);
   // Do something.
   AppGateway response = future.get();
 }

      • createAppGatewayAsync

        public final com.google.api.gax.longrunning.OperationFuture<AppGateway,​AppGatewayOperationMetadata> createAppGatewayAsync​(LocationName parent,
                                                                                                                                AppGateway appGateway,
                                                                                                                                String appGatewayId)
        Creates a new AppGateway 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   AppGateway appGateway = AppGateway.newBuilder().build();
   String appGatewayId = "appGatewayId355682654";
   AppGateway response =
       appGatewaysServiceClient.createAppGatewayAsync(parent, appGateway, appGatewayId).get();
 }
        Parameters:
        parent - Required. The resource project name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
        appGateway - Required. A BeyondCorp AppGateway resource.
        appGatewayId - Optional. User-settable AppGateway 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

      • createAppGatewayAsync

        public final com.google.api.gax.longrunning.OperationFuture<AppGateway,​AppGatewayOperationMetadata> createAppGatewayAsync​(String parent,
                                                                                                                                AppGateway appGateway,
                                                                                                                                String appGatewayId)
        Creates a new AppGateway 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   AppGateway appGateway = AppGateway.newBuilder().build();
   String appGatewayId = "appGatewayId355682654";
   AppGateway response =
       appGatewaysServiceClient.createAppGatewayAsync(parent, appGateway, appGatewayId).get();
 }
        Parameters:
        parent - Required. The resource project name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
        appGateway - Required. A BeyondCorp AppGateway resource.
        appGatewayId - Optional. User-settable AppGateway 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

      • createAppGatewayAsync

        public final com.google.api.gax.longrunning.OperationFuture<AppGateway,​AppGatewayOperationMetadata> createAppGatewayAsync​(CreateAppGatewayRequest request)
        Creates a new AppGateway 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   CreateAppGatewayRequest request =
       CreateAppGatewayRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAppGatewayId("appGatewayId355682654")
           .setAppGateway(AppGateway.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   AppGateway response = appGatewaysServiceClient.createAppGatewayAsync(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

      • createAppGatewayOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<CreateAppGatewayRequest,​AppGateway,​AppGatewayOperationMetadata> createAppGatewayOperationCallable()
        Creates a new AppGateway 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   CreateAppGatewayRequest request =
       CreateAppGatewayRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAppGatewayId("appGatewayId355682654")
           .setAppGateway(AppGateway.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<AppGateway, AppGatewayOperationMetadata> future =
       appGatewaysServiceClient.createAppGatewayOperationCallable().futureCall(request);
   // Do something.
   AppGateway response = future.get();
 }

      • createAppGatewayCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateAppGatewayRequest,​com.google.longrunning.Operation> createAppGatewayCallable()
        Creates a new AppGateway 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   CreateAppGatewayRequest request =
       CreateAppGatewayRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAppGatewayId("appGatewayId355682654")
           .setAppGateway(AppGateway.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       appGatewaysServiceClient.createAppGatewayCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • deleteAppGatewayAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​AppGatewayOperationMetadata> deleteAppGatewayAsync​(AppGatewayName name)
        Deletes a single AppGateway.

        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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   AppGatewayName name = AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]");
   appGatewaysServiceClient.deleteAppGatewayAsync(name).get();
 }
        Parameters:
        name - Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteAppGatewayAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​AppGatewayOperationMetadata> deleteAppGatewayAsync​(String name)
        Deletes a single AppGateway.

        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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   String name = AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString();
   appGatewaysServiceClient.deleteAppGatewayAsync(name).get();
 }
        Parameters:
        name - Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteAppGatewayAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​AppGatewayOperationMetadata> deleteAppGatewayAsync​(DeleteAppGatewayRequest request)
        Deletes a single AppGateway.

        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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   DeleteAppGatewayRequest request =
       DeleteAppGatewayRequest.newBuilder()
           .setName(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   appGatewaysServiceClient.deleteAppGatewayAsync(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

      • deleteAppGatewayOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<DeleteAppGatewayRequest,​com.google.protobuf.Empty,​AppGatewayOperationMetadata> deleteAppGatewayOperationCallable()
        Deletes a single AppGateway.

        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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   DeleteAppGatewayRequest request =
       DeleteAppGatewayRequest.newBuilder()
           .setName(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<Empty, AppGatewayOperationMetadata> future =
       appGatewaysServiceClient.deleteAppGatewayOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

      • deleteAppGatewayCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteAppGatewayRequest,​com.google.longrunning.Operation> deleteAppGatewayCallable()
        Deletes a single AppGateway.

        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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   DeleteAppGatewayRequest request =
       DeleteAppGatewayRequest.newBuilder()
           .setName(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       appGatewaysServiceClient.deleteAppGatewayCallable().futureCall(request);
   // Do something.
   future.get();
 }

      • listLocations

        public final AppGatewaysServiceClient.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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : appGatewaysServiceClient.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,​AppGatewaysServiceClient.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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       appGatewaysServiceClient.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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         appGatewaysServiceClient.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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = appGatewaysServiceClient.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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       appGatewaysServiceClient.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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = appGatewaysServiceClient.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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       appGatewaysServiceClient.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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = appGatewaysServiceClient.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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       appGatewaysServiceClient.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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = appGatewaysServiceClient.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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       appGatewaysServiceClient.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