Class PersistentResourceServiceClient

java.lang.Object
com.google.cloud.aiplatform.v1beta1.PersistentResourceServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable

@BetaApi @Generated("by gapic-generator-java") public class PersistentResourceServiceClient extends Object implements BackgroundResource
Service Description: A service for managing Vertex AI's machine learning PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   PersistentResourceName name =
       PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]");
   PersistentResource response = persistentResourceServiceClient.getPersistentResource(name);
 }
 

Note: close() needs to be called on the PersistentResourceServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

CreatePersistentResource

Creates a PersistentResource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createPersistentResourceAsync(CreatePersistentResourceRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • createPersistentResourceAsync(LocationName parent, PersistentResource persistentResource, String persistentResourceId)

  • createPersistentResourceAsync(String parent, PersistentResource persistentResource, String persistentResourceId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createPersistentResourceOperationCallable()

  • createPersistentResourceCallable()

GetPersistentResource

Gets a PersistentResource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getPersistentResource(GetPersistentResourceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getPersistentResource(PersistentResourceName name)

  • getPersistentResource(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getPersistentResourceCallable()

ListPersistentResources

Lists PersistentResources in a Location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listPersistentResources(ListPersistentResourcesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPersistentResources(LocationName parent)

  • listPersistentResources(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPersistentResourcesPagedCallable()

  • listPersistentResourcesCallable()

DeletePersistentResource

Deletes a PersistentResource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deletePersistentResourceAsync(DeletePersistentResourceRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • deletePersistentResourceAsync(PersistentResourceName name)

  • deletePersistentResourceAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deletePersistentResourceOperationCallable()

  • deletePersistentResourceCallable()

UpdatePersistentResource

Updates a PersistentResource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updatePersistentResourceAsync(UpdatePersistentResourceRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • updatePersistentResourceAsync(PersistentResource persistentResource, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updatePersistentResourceOperationCallable()

  • updatePersistentResourceCallable()

RebootPersistentResource

Reboots a PersistentResource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • rebootPersistentResourceAsync(RebootPersistentResourceRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • rebootPersistentResourceAsync(PersistentResourceName name)

  • rebootPersistentResourceAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • rebootPersistentResourceOperationCallable()

  • rebootPersistentResourceCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy.

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

TestIamPermissions

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

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 PersistentResourceServiceSettings 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
 PersistentResourceServiceSettings persistentResourceServiceSettings =
     PersistentResourceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create(persistentResourceServiceSettings);
 

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
 PersistentResourceServiceSettings persistentResourceServiceSettings =
     PersistentResourceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create(persistentResourceServiceSettings);
 

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

  • Constructor Details

    • PersistentResourceServiceClient

      protected PersistentResourceServiceClient(PersistentResourceServiceSettings settings) throws IOException
      Constructs an instance of PersistentResourceServiceClient, 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
    • PersistentResourceServiceClient

      protected PersistentResourceServiceClient(PersistentResourceServiceStub stub)
  • Method Details

    • create

      public static final PersistentResourceServiceClient create() throws IOException
      Constructs an instance of PersistentResourceServiceClient with default settings.
      Throws:
      IOException
    • create

      Constructs an instance of PersistentResourceServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
      Throws:
      IOException
    • create

      Constructs an instance of PersistentResourceServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(PersistentResourceServiceSettings).
    • getSettings

      public final PersistentResourceServiceSettings getSettings()
    • getStub

    • getOperationsClient

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

      public final OperationFuture<PersistentResource,CreatePersistentResourceOperationMetadata> createPersistentResourceAsync(LocationName parent, PersistentResource persistentResource, String persistentResourceId)
      Creates a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
         PersistentResource persistentResource = PersistentResource.newBuilder().build();
         String persistentResourceId = "persistentResourceId-2123080768";
         PersistentResource response =
             persistentResourceServiceClient
                 .createPersistentResourceAsync(parent, persistentResource, persistentResourceId)
                 .get();
       }
       
      Parameters:
      parent - Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`
      persistentResource - Required. The PersistentResource to create.
      persistentResourceId - Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name.

      The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.

      Throws:
      ApiException - if the remote call fails
    • createPersistentResourceAsync

      public final OperationFuture<PersistentResource,CreatePersistentResourceOperationMetadata> createPersistentResourceAsync(String parent, PersistentResource persistentResource, String persistentResourceId)
      Creates a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
         PersistentResource persistentResource = PersistentResource.newBuilder().build();
         String persistentResourceId = "persistentResourceId-2123080768";
         PersistentResource response =
             persistentResourceServiceClient
                 .createPersistentResourceAsync(parent, persistentResource, persistentResourceId)
                 .get();
       }
       
      Parameters:
      parent - Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`
      persistentResource - Required. The PersistentResource to create.
      persistentResourceId - Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name.

      The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.

      Throws:
      ApiException - if the remote call fails
    • createPersistentResourceAsync

      Creates a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         CreatePersistentResourceRequest request =
             CreatePersistentResourceRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setPersistentResource(PersistentResource.newBuilder().build())
                 .setPersistentResourceId("persistentResourceId-2123080768")
                 .build();
         PersistentResource response =
             persistentResourceServiceClient.createPersistentResourceAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • createPersistentResourceOperationCallable

      Creates a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         CreatePersistentResourceRequest request =
             CreatePersistentResourceRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setPersistentResource(PersistentResource.newBuilder().build())
                 .setPersistentResourceId("persistentResourceId-2123080768")
                 .build();
         OperationFuture<PersistentResource, CreatePersistentResourceOperationMetadata> future =
             persistentResourceServiceClient
                 .createPersistentResourceOperationCallable()
                 .futureCall(request);
         // Do something.
         PersistentResource response = future.get();
       }
       
    • createPersistentResourceCallable

      public final UnaryCallable<CreatePersistentResourceRequest,Operation> createPersistentResourceCallable()
      Creates a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         CreatePersistentResourceRequest request =
             CreatePersistentResourceRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setPersistentResource(PersistentResource.newBuilder().build())
                 .setPersistentResourceId("persistentResourceId-2123080768")
                 .build();
         ApiFuture<Operation> future =
             persistentResourceServiceClient.createPersistentResourceCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • getPersistentResource

      public final PersistentResource getPersistentResource(PersistentResourceName name)
      Gets a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         PersistentResourceName name =
             PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]");
         PersistentResource response = persistentResourceServiceClient.getPersistentResource(name);
       }
       
      Parameters:
      name - Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
      Throws:
      ApiException - if the remote call fails
    • getPersistentResource

      public final PersistentResource getPersistentResource(String name)
      Gets a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         String name =
             PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]").toString();
         PersistentResource response = persistentResourceServiceClient.getPersistentResource(name);
       }
       
      Parameters:
      name - Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
      Throws:
      ApiException - if the remote call fails
    • getPersistentResource

      public final PersistentResource getPersistentResource(GetPersistentResourceRequest request)
      Gets a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         GetPersistentResourceRequest request =
             GetPersistentResourceRequest.newBuilder()
                 .setName(
                     PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                         .toString())
                 .build();
         PersistentResource response = persistentResourceServiceClient.getPersistentResource(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • getPersistentResourceCallable

      public final UnaryCallable<GetPersistentResourceRequest,PersistentResource> getPersistentResourceCallable()
      Gets a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         GetPersistentResourceRequest request =
             GetPersistentResourceRequest.newBuilder()
                 .setName(
                     PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                         .toString())
                 .build();
         ApiFuture<PersistentResource> future =
             persistentResourceServiceClient.getPersistentResourceCallable().futureCall(request);
         // Do something.
         PersistentResource response = future.get();
       }
       
    • listPersistentResources

      Lists PersistentResources in 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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
         for (PersistentResource element :
             persistentResourceServiceClient.listPersistentResources(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails
    • listPersistentResources

      Lists PersistentResources in 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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
         for (PersistentResource element :
             persistentResourceServiceClient.listPersistentResources(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails
    • listPersistentResources

      Lists PersistentResources in 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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         ListPersistentResourcesRequest request =
             ListPersistentResourcesRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         for (PersistentResource element :
             persistentResourceServiceClient.listPersistentResources(request).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • listPersistentResourcesPagedCallable

      Lists PersistentResources in 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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         ListPersistentResourcesRequest request =
             ListPersistentResourcesRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         ApiFuture<PersistentResource> future =
             persistentResourceServiceClient
                 .listPersistentResourcesPagedCallable()
                 .futureCall(request);
         // Do something.
         for (PersistentResource element : future.get().iterateAll()) {
           // doThingsWith(element);
         }
       }
       
    • listPersistentResourcesCallable

      public final UnaryCallable<ListPersistentResourcesRequest,ListPersistentResourcesResponse> listPersistentResourcesCallable()
      Lists PersistentResources in 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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         ListPersistentResourcesRequest request =
             ListPersistentResourcesRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         while (true) {
           ListPersistentResourcesResponse response =
               persistentResourceServiceClient.listPersistentResourcesCallable().call(request);
           for (PersistentResource element : response.getPersistentResourcesList()) {
             // doThingsWith(element);
           }
           String nextPageToken = response.getNextPageToken();
           if (!Strings.isNullOrEmpty(nextPageToken)) {
             request = request.toBuilder().setPageToken(nextPageToken).build();
           } else {
             break;
           }
         }
       }
       
    • deletePersistentResourceAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deletePersistentResourceAsync(PersistentResourceName name)
      Deletes a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         PersistentResourceName name =
             PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]");
         persistentResourceServiceClient.deletePersistentResourceAsync(name).get();
       }
       
      Parameters:
      name - Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
      Throws:
      ApiException - if the remote call fails
    • deletePersistentResourceAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deletePersistentResourceAsync(String name)
      Deletes a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         String name =
             PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]").toString();
         persistentResourceServiceClient.deletePersistentResourceAsync(name).get();
       }
       
      Parameters:
      name - Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
      Throws:
      ApiException - if the remote call fails
    • deletePersistentResourceAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deletePersistentResourceAsync(DeletePersistentResourceRequest request)
      Deletes a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         DeletePersistentResourceRequest request =
             DeletePersistentResourceRequest.newBuilder()
                 .setName(
                     PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                         .toString())
                 .build();
         persistentResourceServiceClient.deletePersistentResourceAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • deletePersistentResourceOperationCallable

      public final OperationCallable<DeletePersistentResourceRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deletePersistentResourceOperationCallable()
      Deletes a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         DeletePersistentResourceRequest request =
             DeletePersistentResourceRequest.newBuilder()
                 .setName(
                     PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                         .toString())
                 .build();
         OperationFuture<Empty, DeleteOperationMetadata> future =
             persistentResourceServiceClient
                 .deletePersistentResourceOperationCallable()
                 .futureCall(request);
         // Do something.
         future.get();
       }
       
    • deletePersistentResourceCallable

      public final UnaryCallable<DeletePersistentResourceRequest,Operation> deletePersistentResourceCallable()
      Deletes a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         DeletePersistentResourceRequest request =
             DeletePersistentResourceRequest.newBuilder()
                 .setName(
                     PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                         .toString())
                 .build();
         ApiFuture<Operation> future =
             persistentResourceServiceClient.deletePersistentResourceCallable().futureCall(request);
         // Do something.
         future.get();
       }
       
    • updatePersistentResourceAsync

      public final OperationFuture<PersistentResource,UpdatePersistentResourceOperationMetadata> updatePersistentResourceAsync(PersistentResource persistentResource, com.google.protobuf.FieldMask updateMask)
      Updates a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         PersistentResource persistentResource = PersistentResource.newBuilder().build();
         FieldMask updateMask = FieldMask.newBuilder().build();
         PersistentResource response =
             persistentResourceServiceClient
                 .updatePersistentResourceAsync(persistentResource, updateMask)
                 .get();
       }
       
      Parameters:
      persistentResource - Required. The PersistentResource to update.

      The PersistentResource's `name` field is used to identify the PersistentResource to update. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`

      updateMask - Required. Specify the fields to be overwritten in the PersistentResource by the update method.
      Throws:
      ApiException - if the remote call fails
    • updatePersistentResourceAsync

      Updates a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         UpdatePersistentResourceRequest request =
             UpdatePersistentResourceRequest.newBuilder()
                 .setPersistentResource(PersistentResource.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         PersistentResource response =
             persistentResourceServiceClient.updatePersistentResourceAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • updatePersistentResourceOperationCallable

      Updates a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         UpdatePersistentResourceRequest request =
             UpdatePersistentResourceRequest.newBuilder()
                 .setPersistentResource(PersistentResource.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         OperationFuture<PersistentResource, UpdatePersistentResourceOperationMetadata> future =
             persistentResourceServiceClient
                 .updatePersistentResourceOperationCallable()
                 .futureCall(request);
         // Do something.
         PersistentResource response = future.get();
       }
       
    • updatePersistentResourceCallable

      public final UnaryCallable<UpdatePersistentResourceRequest,Operation> updatePersistentResourceCallable()
      Updates a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         UpdatePersistentResourceRequest request =
             UpdatePersistentResourceRequest.newBuilder()
                 .setPersistentResource(PersistentResource.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         ApiFuture<Operation> future =
             persistentResourceServiceClient.updatePersistentResourceCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • rebootPersistentResourceAsync

      Reboots a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         PersistentResourceName name =
             PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]");
         PersistentResource response =
             persistentResourceServiceClient.rebootPersistentResourceAsync(name).get();
       }
       
      Parameters:
      name - Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
      Throws:
      ApiException - if the remote call fails
    • rebootPersistentResourceAsync

      public final OperationFuture<PersistentResource,RebootPersistentResourceOperationMetadata> rebootPersistentResourceAsync(String name)
      Reboots a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         String name =
             PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]").toString();
         PersistentResource response =
             persistentResourceServiceClient.rebootPersistentResourceAsync(name).get();
       }
       
      Parameters:
      name - Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
      Throws:
      ApiException - if the remote call fails
    • rebootPersistentResourceAsync

      Reboots a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         RebootPersistentResourceRequest request =
             RebootPersistentResourceRequest.newBuilder()
                 .setName(
                     PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                         .toString())
                 .build();
         PersistentResource response =
             persistentResourceServiceClient.rebootPersistentResourceAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • rebootPersistentResourceOperationCallable

      Reboots a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         RebootPersistentResourceRequest request =
             RebootPersistentResourceRequest.newBuilder()
                 .setName(
                     PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                         .toString())
                 .build();
         OperationFuture<PersistentResource, RebootPersistentResourceOperationMetadata> future =
             persistentResourceServiceClient
                 .rebootPersistentResourceOperationCallable()
                 .futureCall(request);
         // Do something.
         PersistentResource response = future.get();
       }
       
    • rebootPersistentResourceCallable

      public final UnaryCallable<RebootPersistentResourceRequest,Operation> rebootPersistentResourceCallable()
      Reboots a PersistentResource.

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         RebootPersistentResourceRequest request =
             RebootPersistentResourceRequest.newBuilder()
                 .setName(
                     PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                         .toString())
                 .build();
         ApiFuture<Operation> future =
             persistentResourceServiceClient.rebootPersistentResourceCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • listLocations

      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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         ListLocationsRequest request =
             ListLocationsRequest.newBuilder()
                 .setName("name3373707")
                 .setFilter("filter-1274492040")
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         for (Location element : persistentResourceServiceClient.listLocations(request).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • 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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         ListLocationsRequest request =
             ListLocationsRequest.newBuilder()
                 .setName("name3373707")
                 .setFilter("filter-1274492040")
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         ApiFuture<Location> future =
             persistentResourceServiceClient.listLocationsPagedCallable().futureCall(request);
         // Do something.
         for (Location element : future.get().iterateAll()) {
           // doThingsWith(element);
         }
       }
       
    • listLocationsCallable

      public final UnaryCallable<ListLocationsRequest,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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         ListLocationsRequest request =
             ListLocationsRequest.newBuilder()
                 .setName("name3373707")
                 .setFilter("filter-1274492040")
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         while (true) {
           ListLocationsResponse response =
               persistentResourceServiceClient.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 Location getLocation(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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
         Location response = persistentResourceServiceClient.getLocation(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • getLocationCallable

      public final UnaryCallable<GetLocationRequest,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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
         ApiFuture<Location> future =
             persistentResourceServiceClient.getLocationCallable().futureCall(request);
         // Do something.
         Location response = future.get();
       }
       
    • setIamPolicy

      public final Policy setIamPolicy(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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         SetIamPolicyRequest request =
             SetIamPolicyRequest.newBuilder()
                 .setResource(
                     EndpointName.ofProjectLocationEndpointName(
                             "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                         .toString())
                 .setPolicy(Policy.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         Policy response = persistentResourceServiceClient.setIamPolicy(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • setIamPolicyCallable

      public final UnaryCallable<SetIamPolicyRequest,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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         SetIamPolicyRequest request =
             SetIamPolicyRequest.newBuilder()
                 .setResource(
                     EndpointName.ofProjectLocationEndpointName(
                             "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                         .toString())
                 .setPolicy(Policy.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         ApiFuture<Policy> future =
             persistentResourceServiceClient.setIamPolicyCallable().futureCall(request);
         // Do something.
         Policy response = future.get();
       }
       
    • getIamPolicy

      public final Policy getIamPolicy(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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         GetIamPolicyRequest request =
             GetIamPolicyRequest.newBuilder()
                 .setResource(
                     EndpointName.ofProjectLocationEndpointName(
                             "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                         .toString())
                 .setOptions(GetPolicyOptions.newBuilder().build())
                 .build();
         Policy response = persistentResourceServiceClient.getIamPolicy(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • getIamPolicyCallable

      public final UnaryCallable<GetIamPolicyRequest,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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         GetIamPolicyRequest request =
             GetIamPolicyRequest.newBuilder()
                 .setResource(
                     EndpointName.ofProjectLocationEndpointName(
                             "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                         .toString())
                 .setOptions(GetPolicyOptions.newBuilder().build())
                 .build();
         ApiFuture<Policy> future =
             persistentResourceServiceClient.getIamPolicyCallable().futureCall(request);
         // Do something.
         Policy response = future.get();
       }
       
    • testIamPermissions

      public final TestIamPermissionsResponse testIamPermissions(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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         TestIamPermissionsRequest request =
             TestIamPermissionsRequest.newBuilder()
                 .setResource(
                     EndpointName.ofProjectLocationEndpointName(
                             "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                         .toString())
                 .addAllPermissions(new ArrayList<String>())
                 .build();
         TestIamPermissionsResponse response =
             persistentResourceServiceClient.testIamPermissions(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • testIamPermissionsCallable

      public final UnaryCallable<TestIamPermissionsRequest,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 (PersistentResourceServiceClient persistentResourceServiceClient =
           PersistentResourceServiceClient.create()) {
         TestIamPermissionsRequest request =
             TestIamPermissionsRequest.newBuilder()
                 .setResource(
                     EndpointName.ofProjectLocationEndpointName(
                             "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                         .toString())
                 .addAllPermissions(new ArrayList<String>())
                 .build();
         ApiFuture<TestIamPermissionsResponse> future =
             persistentResourceServiceClient.testIamPermissionsCallable().futureCall(request);
         // Do something.
         TestIamPermissionsResponse response = future.get();
       }
       
    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable
    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource
    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource
    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource
    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource
    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException