Package com.google.cloud.aiplatform.v1beta1

Class DeploymentResourcePoolServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @BetaApi
@Generated("by gapic-generator-java")
public class DeploymentResourcePoolServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: A service that manages the DeploymentResourcePool resource.

    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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   DeploymentResourcePoolName name =
       DeploymentResourcePoolName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]");
   DeploymentResourcePool response =
       deploymentResourcePoolServiceClient.getDeploymentResourcePool(name);
 }

    Note: close() needs to be called on the DeploymentResourcePoolServiceClient 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 DeploymentResourcePoolServiceSettings 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
 DeploymentResourcePoolServiceSettings deploymentResourcePoolServiceSettings =
     DeploymentResourcePoolServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create(deploymentResourcePoolServiceSettings);

    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
 DeploymentResourcePoolServiceSettings deploymentResourcePoolServiceSettings =
     DeploymentResourcePoolServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create(deploymentResourcePoolServiceSettings);

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

    • Constructor Detail

      • DeploymentResourcePoolServiceClient

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

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

      • createDeploymentResourcePoolAsync

        public final com.google.api.gax.longrunning.OperationFuture<DeploymentResourcePool,​CreateDeploymentResourcePoolOperationMetadata> createDeploymentResourcePoolAsync​(LocationName parent,
                                                                                                                                                                          DeploymentResourcePool deploymentResourcePool,
                                                                                                                                                                          String deploymentResourcePoolId)
        Create a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DeploymentResourcePool deploymentResourcePool = DeploymentResourcePool.newBuilder().build();
   String deploymentResourcePoolId = "deploymentResourcePoolId1805697578";
   DeploymentResourcePool response =
       deploymentResourcePoolServiceClient
           .createDeploymentResourcePoolAsync(
               parent, deploymentResourcePool, deploymentResourcePoolId)
           .get();
 }
        Parameters:
        parent - Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`
        deploymentResourcePool - Required. The DeploymentResourcePool to create.
        deploymentResourcePoolId - Required. The ID to use for the DeploymentResourcePool, which will become the final component of the DeploymentResourcePool's resource name.

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

        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createDeploymentResourcePoolAsync

        public final com.google.api.gax.longrunning.OperationFuture<DeploymentResourcePool,​CreateDeploymentResourcePoolOperationMetadata> createDeploymentResourcePoolAsync​(String parent,
                                                                                                                                                                          DeploymentResourcePool deploymentResourcePool,
                                                                                                                                                                          String deploymentResourcePoolId)
        Create a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   DeploymentResourcePool deploymentResourcePool = DeploymentResourcePool.newBuilder().build();
   String deploymentResourcePoolId = "deploymentResourcePoolId1805697578";
   DeploymentResourcePool response =
       deploymentResourcePoolServiceClient
           .createDeploymentResourcePoolAsync(
               parent, deploymentResourcePool, deploymentResourcePoolId)
           .get();
 }
        Parameters:
        parent - Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`
        deploymentResourcePool - Required. The DeploymentResourcePool to create.
        deploymentResourcePoolId - Required. The ID to use for the DeploymentResourcePool, which will become the final component of the DeploymentResourcePool's resource name.

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

        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createDeploymentResourcePoolAsync

        public final com.google.api.gax.longrunning.OperationFuture<DeploymentResourcePool,​CreateDeploymentResourcePoolOperationMetadata> createDeploymentResourcePoolAsync​(CreateDeploymentResourcePoolRequest request)
        Create a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   CreateDeploymentResourcePoolRequest request =
       CreateDeploymentResourcePoolRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDeploymentResourcePool(DeploymentResourcePool.newBuilder().build())
           .setDeploymentResourcePoolId("deploymentResourcePoolId1805697578")
           .build();
   DeploymentResourcePool response =
       deploymentResourcePoolServiceClient.createDeploymentResourcePoolAsync(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

      • createDeploymentResourcePoolOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<CreateDeploymentResourcePoolRequest,​DeploymentResourcePool,​CreateDeploymentResourcePoolOperationMetadata> createDeploymentResourcePoolOperationCallable()
        Create a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   CreateDeploymentResourcePoolRequest request =
       CreateDeploymentResourcePoolRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDeploymentResourcePool(DeploymentResourcePool.newBuilder().build())
           .setDeploymentResourcePoolId("deploymentResourcePoolId1805697578")
           .build();
   OperationFuture<DeploymentResourcePool, CreateDeploymentResourcePoolOperationMetadata>
       future =
           deploymentResourcePoolServiceClient
               .createDeploymentResourcePoolOperationCallable()
               .futureCall(request);
   // Do something.
   DeploymentResourcePool response = future.get();
 }

      • createDeploymentResourcePoolCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateDeploymentResourcePoolRequest,​com.google.longrunning.Operation> createDeploymentResourcePoolCallable()
        Create a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   CreateDeploymentResourcePoolRequest request =
       CreateDeploymentResourcePoolRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDeploymentResourcePool(DeploymentResourcePool.newBuilder().build())
           .setDeploymentResourcePoolId("deploymentResourcePoolId1805697578")
           .build();
   ApiFuture<Operation> future =
       deploymentResourcePoolServiceClient
           .createDeploymentResourcePoolCallable()
           .futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • getDeploymentResourcePool

        public final DeploymentResourcePool getDeploymentResourcePool​(DeploymentResourcePoolName name)
        Get a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   DeploymentResourcePoolName name =
       DeploymentResourcePoolName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]");
   DeploymentResourcePool response =
       deploymentResourcePoolServiceClient.getDeploymentResourcePool(name);
 }
        Parameters:
        name - Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getDeploymentResourcePool

        public final DeploymentResourcePool getDeploymentResourcePool​(String name)
        Get a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   String name =
       DeploymentResourcePoolName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]")
           .toString();
   DeploymentResourcePool response =
       deploymentResourcePoolServiceClient.getDeploymentResourcePool(name);
 }
        Parameters:
        name - Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getDeploymentResourcePool

        public final DeploymentResourcePool getDeploymentResourcePool​(GetDeploymentResourcePoolRequest request)
        Get a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   GetDeploymentResourcePoolRequest request =
       GetDeploymentResourcePoolRequest.newBuilder()
           .setName(
               DeploymentResourcePoolName.of(
                       "[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]")
                   .toString())
           .build();
   DeploymentResourcePool response =
       deploymentResourcePoolServiceClient.getDeploymentResourcePool(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

      • getDeploymentResourcePoolCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetDeploymentResourcePoolRequest,​DeploymentResourcePool> getDeploymentResourcePoolCallable()
        Get a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   GetDeploymentResourcePoolRequest request =
       GetDeploymentResourcePoolRequest.newBuilder()
           .setName(
               DeploymentResourcePoolName.of(
                       "[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]")
                   .toString())
           .build();
   ApiFuture<DeploymentResourcePool> future =
       deploymentResourcePoolServiceClient
           .getDeploymentResourcePoolCallable()
           .futureCall(request);
   // Do something.
   DeploymentResourcePool response = future.get();
 }

      • listDeploymentResourcePools

        public final DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse listDeploymentResourcePools​(ProjectName parent)
        List DeploymentResourcePools 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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (DeploymentResourcePool element :
       deploymentResourcePoolServiceClient.listDeploymentResourcePools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listDeploymentResourcePools

        public final DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse listDeploymentResourcePools​(String parent)
        List DeploymentResourcePools 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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (DeploymentResourcePool element :
       deploymentResourcePoolServiceClient.listDeploymentResourcePools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listDeploymentResourcePools

        public final DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse listDeploymentResourcePools​(ListDeploymentResourcePoolsRequest request)
        List DeploymentResourcePools 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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   ListDeploymentResourcePoolsRequest request =
       ListDeploymentResourcePoolsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DeploymentResourcePool element :
       deploymentResourcePoolServiceClient.listDeploymentResourcePools(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

      • listDeploymentResourcePoolsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListDeploymentResourcePoolsRequest,​DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse> listDeploymentResourcePoolsPagedCallable()
        List DeploymentResourcePools 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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   ListDeploymentResourcePoolsRequest request =
       ListDeploymentResourcePoolsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DeploymentResourcePool> future =
       deploymentResourcePoolServiceClient
           .listDeploymentResourcePoolsPagedCallable()
           .futureCall(request);
   // Do something.
   for (DeploymentResourcePool element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • listDeploymentResourcePoolsCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListDeploymentResourcePoolsRequest,​ListDeploymentResourcePoolsResponse> listDeploymentResourcePoolsCallable()
        List DeploymentResourcePools 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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   ListDeploymentResourcePoolsRequest request =
       ListDeploymentResourcePoolsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDeploymentResourcePoolsResponse response =
         deploymentResourcePoolServiceClient.listDeploymentResourcePoolsCallable().call(request);
     for (DeploymentResourcePool element : response.getDeploymentResourcePoolsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • deleteDeploymentResourcePoolAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​DeleteOperationMetadata> deleteDeploymentResourcePoolAsync​(DeploymentResourcePoolName name)
        Delete a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   DeploymentResourcePoolName name =
       DeploymentResourcePoolName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]");
   deploymentResourcePoolServiceClient.deleteDeploymentResourcePoolAsync(name).get();
 }
        Parameters:
        name - Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteDeploymentResourcePoolAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​DeleteOperationMetadata> deleteDeploymentResourcePoolAsync​(String name)
        Delete a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   String name =
       DeploymentResourcePoolName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]")
           .toString();
   deploymentResourcePoolServiceClient.deleteDeploymentResourcePoolAsync(name).get();
 }
        Parameters:
        name - Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteDeploymentResourcePoolAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​DeleteOperationMetadata> deleteDeploymentResourcePoolAsync​(DeleteDeploymentResourcePoolRequest request)
        Delete a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   DeleteDeploymentResourcePoolRequest request =
       DeleteDeploymentResourcePoolRequest.newBuilder()
           .setName(
               DeploymentResourcePoolName.of(
                       "[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]")
                   .toString())
           .build();
   deploymentResourcePoolServiceClient.deleteDeploymentResourcePoolAsync(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

      • deleteDeploymentResourcePoolOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<DeleteDeploymentResourcePoolRequest,​com.google.protobuf.Empty,​DeleteOperationMetadata> deleteDeploymentResourcePoolOperationCallable()
        Delete a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   DeleteDeploymentResourcePoolRequest request =
       DeleteDeploymentResourcePoolRequest.newBuilder()
           .setName(
               DeploymentResourcePoolName.of(
                       "[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       deploymentResourcePoolServiceClient
           .deleteDeploymentResourcePoolOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }

      • deleteDeploymentResourcePoolCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteDeploymentResourcePoolRequest,​com.google.longrunning.Operation> deleteDeploymentResourcePoolCallable()
        Delete a DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   DeleteDeploymentResourcePoolRequest request =
       DeleteDeploymentResourcePoolRequest.newBuilder()
           .setName(
               DeploymentResourcePoolName.of(
                       "[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       deploymentResourcePoolServiceClient
           .deleteDeploymentResourcePoolCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }

      • queryDeployedModels

        public final DeploymentResourcePoolServiceClient.QueryDeployedModelsPagedResponse queryDeployedModels​(String deploymentResourcePool)
        List DeployedModels that have been deployed on this DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   String deploymentResourcePool = "deploymentResourcePool-1928845137";
   for (DeployedModel element :
       deploymentResourcePoolServiceClient
           .queryDeployedModels(deploymentResourcePool)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        deploymentResourcePool - Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • queryDeployedModels

        public final DeploymentResourcePoolServiceClient.QueryDeployedModelsPagedResponse queryDeployedModels​(QueryDeployedModelsRequest request)
        List DeployedModels that have been deployed on this DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   QueryDeployedModelsRequest request =
       QueryDeployedModelsRequest.newBuilder()
           .setDeploymentResourcePool("deploymentResourcePool-1928845137")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DeployedModel element :
       deploymentResourcePoolServiceClient.queryDeployedModels(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

      • queryDeployedModelsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<QueryDeployedModelsRequest,​DeploymentResourcePoolServiceClient.QueryDeployedModelsPagedResponse> queryDeployedModelsPagedCallable()
        List DeployedModels that have been deployed on this DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   QueryDeployedModelsRequest request =
       QueryDeployedModelsRequest.newBuilder()
           .setDeploymentResourcePool("deploymentResourcePool-1928845137")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DeployedModel> future =
       deploymentResourcePoolServiceClient
           .queryDeployedModelsPagedCallable()
           .futureCall(request);
   // Do something.
   for (DeployedModel element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • queryDeployedModelsCallable

        public final com.google.api.gax.rpc.UnaryCallable<QueryDeployedModelsRequest,​QueryDeployedModelsResponse> queryDeployedModelsCallable()
        List DeployedModels that have been deployed on this DeploymentResourcePool.

        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 (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   QueryDeployedModelsRequest request =
       QueryDeployedModelsRequest.newBuilder()
           .setDeploymentResourcePool("deploymentResourcePool-1928845137")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     QueryDeployedModelsResponse response =
         deploymentResourcePoolServiceClient.queryDeployedModelsCallable().call(request);
     for (DeployedModel element : response.getDeployedModelsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • listLocations

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