Class DeploymentResourcePoolServiceClient (3.2.0)

Version 3.2.0

• 3.54.0 (latest)
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public class DeploymentResourcePoolServiceClient implements 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 DeploymentResourcePoolServiceSettings deploymentResourcePoolServiceSettings =
     DeploymentResourcePoolServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create(deploymentResourcePoolServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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.

Inheritance

java.lang.Object > DeploymentResourcePoolServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final DeploymentResourcePoolServiceClient create()

Constructs an instance of DeploymentResourcePoolServiceClient with default settings.

Returns

Type	Description
DeploymentResourcePoolServiceClient

Exceptions

Type	Description
IOException

create(DeploymentResourcePoolServiceSettings settings)

public static final DeploymentResourcePoolServiceClient create(DeploymentResourcePoolServiceSettings settings)

Constructs an instance of DeploymentResourcePoolServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter

Name	Description
settings	DeploymentResourcePoolServiceSettings

Returns

Type	Description
DeploymentResourcePoolServiceClient

Exceptions

Type	Description
IOException

create(DeploymentResourcePoolServiceStub stub)

public static final DeploymentResourcePoolServiceClient create(DeploymentResourcePoolServiceStub stub)

Constructs an instance of DeploymentResourcePoolServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DeploymentResourcePoolServiceSettings).

Parameter

Name	Description
stub	DeploymentResourcePoolServiceStub

Returns

Type	Description
DeploymentResourcePoolServiceClient

Constructors

DeploymentResourcePoolServiceClient(DeploymentResourcePoolServiceSettings settings)

protected DeploymentResourcePoolServiceClient(DeploymentResourcePoolServiceSettings settings)

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.

Parameter

Name	Description
settings	DeploymentResourcePoolServiceSettings

DeploymentResourcePoolServiceClient(DeploymentResourcePoolServiceStub stub)

protected DeploymentResourcePoolServiceClient(DeploymentResourcePoolServiceStub stub)

Parameter

Name	Description
stub	DeploymentResourcePoolServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

createDeploymentResourcePoolAsync(CreateDeploymentResourcePoolRequest request)

public final OperationFuture<DeploymentResourcePool,CreateDeploymentResourcePoolOperationMetadata> createDeploymentResourcePoolAsync(CreateDeploymentResourcePoolRequest request)

Create a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Parameter

Name	Description
request	CreateDeploymentResourcePoolRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<DeploymentResourcePool,CreateDeploymentResourcePoolOperationMetadata>

createDeploymentResourcePoolAsync(LocationName parent, DeploymentResourcePool deploymentResourcePool, String deploymentResourcePoolId)

public final OperationFuture<DeploymentResourcePool,CreateDeploymentResourcePoolOperationMetadata> createDeploymentResourcePoolAsync(LocationName parent, DeploymentResourcePool deploymentResourcePool, String deploymentResourcePoolId)

Create a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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

Name	Description
parent	LocationName Required. The parent location resource where this DeploymentResourcePool will be created. Format: projects/{project}/locations/{location}
deploymentResourcePool	DeploymentResourcePool Required. The DeploymentResourcePool to create.
deploymentResourcePoolId	String 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?$/.

Returns

Type	Description
OperationFuture<DeploymentResourcePool,CreateDeploymentResourcePoolOperationMetadata>

createDeploymentResourcePoolAsync(String parent, DeploymentResourcePool deploymentResourcePool, String deploymentResourcePoolId)

public final OperationFuture<DeploymentResourcePool,CreateDeploymentResourcePoolOperationMetadata> createDeploymentResourcePoolAsync(String parent, DeploymentResourcePool deploymentResourcePool, String deploymentResourcePoolId)

Create a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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

Name	Description
parent	String Required. The parent location resource where this DeploymentResourcePool will be created. Format: projects/{project}/locations/{location}
deploymentResourcePool	DeploymentResourcePool Required. The DeploymentResourcePool to create.
deploymentResourcePoolId	String 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?$/.

Returns

Type	Description
OperationFuture<DeploymentResourcePool,CreateDeploymentResourcePoolOperationMetadata>

createDeploymentResourcePoolCallable()

public final UnaryCallable<CreateDeploymentResourcePoolRequest,Operation> createDeploymentResourcePoolCallable()

Create a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
UnaryCallable<CreateDeploymentResourcePoolRequest,Operation>

createDeploymentResourcePoolOperationCallable()

public final OperationCallable<CreateDeploymentResourcePoolRequest,DeploymentResourcePool,CreateDeploymentResourcePoolOperationMetadata> createDeploymentResourcePoolOperationCallable()

Create a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
OperationCallable<CreateDeploymentResourcePoolRequest,DeploymentResourcePool,CreateDeploymentResourcePoolOperationMetadata>

deleteDeploymentResourcePoolAsync(DeleteDeploymentResourcePoolRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteDeploymentResourcePoolAsync(DeleteDeploymentResourcePoolRequest request)

Delete a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   DeleteDeploymentResourcePoolRequest request =
       DeleteDeploymentResourcePoolRequest.newBuilder()
           .setName(
               DeploymentResourcePoolName.of(
                       "[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]")
                   .toString())
           .build();
   deploymentResourcePoolServiceClient.deleteDeploymentResourcePoolAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteDeploymentResourcePoolRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteDeploymentResourcePoolAsync(DeploymentResourcePoolName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteDeploymentResourcePoolAsync(DeploymentResourcePoolName name)

Delete a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   DeploymentResourcePoolName name =
       DeploymentResourcePoolName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]");
   deploymentResourcePoolServiceClient.deleteDeploymentResourcePoolAsync(name).get();
 }
 

Parameter

Name	Description
name	DeploymentResourcePoolName Required. The name of the DeploymentResourcePool to delete. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteDeploymentResourcePoolAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteDeploymentResourcePoolAsync(String name)

Delete a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   String name =
       DeploymentResourcePoolName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]")
           .toString();
   deploymentResourcePoolServiceClient.deleteDeploymentResourcePoolAsync(name).get();
 }
 

Parameter

Name	Description
name	String Required. The name of the DeploymentResourcePool to delete. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteDeploymentResourcePoolCallable()

public final UnaryCallable<DeleteDeploymentResourcePoolRequest,Operation> deleteDeploymentResourcePoolCallable()

Delete a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
UnaryCallable<DeleteDeploymentResourcePoolRequest,Operation>

deleteDeploymentResourcePoolOperationCallable()

public final OperationCallable<DeleteDeploymentResourcePoolRequest,Empty,DeleteOperationMetadata> deleteDeploymentResourcePoolOperationCallable()

Delete a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
OperationCallable<DeleteDeploymentResourcePoolRequest,Empty,DeleteOperationMetadata>

getDeploymentResourcePool(DeploymentResourcePoolName name)

public final DeploymentResourcePool getDeploymentResourcePool(DeploymentResourcePoolName name)

Get a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   DeploymentResourcePoolName name =
       DeploymentResourcePoolName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]");
   DeploymentResourcePool response =
       deploymentResourcePoolServiceClient.getDeploymentResourcePool(name);
 }
 

Parameter

Name	Description
name	DeploymentResourcePoolName Required. The name of the DeploymentResourcePool to retrieve. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

Returns

Type	Description
DeploymentResourcePool

getDeploymentResourcePool(GetDeploymentResourcePoolRequest request)

public final DeploymentResourcePool getDeploymentResourcePool(GetDeploymentResourcePoolRequest request)

Get a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   GetDeploymentResourcePoolRequest request =
       GetDeploymentResourcePoolRequest.newBuilder()
           .setName(
               DeploymentResourcePoolName.of(
                       "[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]")
                   .toString())
           .build();
   DeploymentResourcePool response =
       deploymentResourcePoolServiceClient.getDeploymentResourcePool(request);
 }
 

Parameter

Name	Description
request	GetDeploymentResourcePoolRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
DeploymentResourcePool

getDeploymentResourcePool(String name)

public final DeploymentResourcePool getDeploymentResourcePool(String name)

Get a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   String name =
       DeploymentResourcePoolName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]")
           .toString();
   DeploymentResourcePool response =
       deploymentResourcePoolServiceClient.getDeploymentResourcePool(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the DeploymentResourcePool to retrieve. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

Returns

Type	Description
DeploymentResourcePool

getDeploymentResourcePoolCallable()

public final UnaryCallable<GetDeploymentResourcePoolRequest,DeploymentResourcePool> getDeploymentResourcePoolCallable()

Get a DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
UnaryCallable<GetDeploymentResourcePoolRequest,DeploymentResourcePool>

getIamPolicy(GetIamPolicyRequest request)

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = deploymentResourcePoolServiceClient.getIamPolicy(request);
 }
 

Parameter

Name	Description
request	com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.Policy

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       deploymentResourcePoolServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = deploymentResourcePoolServiceClient.getLocation(request);
 }
 

Parameter

Name	Description
request	com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

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.

Returns

Type	Description
OperationsClient

getSettings()

public final DeploymentResourcePoolServiceSettings getSettings()

Returns

Type	Description
DeploymentResourcePoolServiceSettings

getStub()

public DeploymentResourcePoolServiceStub getStub()

Returns

Type	Description
DeploymentResourcePoolServiceStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listDeploymentResourcePools(ListDeploymentResourcePoolsRequest request)

public final DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse listDeploymentResourcePools(ListDeploymentResourcePoolsRequest request)

List DeploymentResourcePools in a location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }
 

Parameter

Name	Description
request	ListDeploymentResourcePoolsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse

listDeploymentResourcePools(ProjectName parent)

public final DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse listDeploymentResourcePools(ProjectName parent)

List DeploymentResourcePools in a location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (DeploymentResourcePool element :
       deploymentResourcePoolServiceClient.listDeploymentResourcePools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	ProjectName Required. The parent Location which owns this collection of DeploymentResourcePools. Format: projects/{project}/locations/{location}

Returns

Type	Description
DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse

listDeploymentResourcePools(String parent)

public final DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse listDeploymentResourcePools(String parent)

List DeploymentResourcePools in a location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (DeploymentResourcePool element :
       deploymentResourcePoolServiceClient.listDeploymentResourcePools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. The parent Location which owns this collection of DeploymentResourcePools. Format: projects/{project}/locations/{location}

Returns

Type	Description
DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse

listDeploymentResourcePoolsCallable()

public final UnaryCallable<ListDeploymentResourcePoolsRequest,ListDeploymentResourcePoolsResponse> listDeploymentResourcePoolsCallable()

List DeploymentResourcePools in a location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListDeploymentResourcePoolsRequest,ListDeploymentResourcePoolsResponse>

listDeploymentResourcePoolsPagedCallable()

public final UnaryCallable<ListDeploymentResourcePoolsRequest,DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse> listDeploymentResourcePoolsPagedCallable()

List DeploymentResourcePools in a location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListDeploymentResourcePoolsRequest,ListDeploymentResourcePoolsPagedResponse>

listLocations(ListLocationsRequest request)

public final DeploymentResourcePoolServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }
 

Parameter

Name	Description
request	com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
DeploymentResourcePoolServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,DeploymentResourcePoolServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }
 

Returns

Type	Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

queryDeployedModels(QueryDeployedModelsRequest request)

public final DeploymentResourcePoolServiceClient.QueryDeployedModelsPagedResponse queryDeployedModels(QueryDeployedModelsRequest request)

List DeployedModels that have been deployed on this DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }
 

Parameter

Name	Description
request	QueryDeployedModelsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
DeploymentResourcePoolServiceClient.QueryDeployedModelsPagedResponse

queryDeployedModels(String deploymentResourcePool)

public final DeploymentResourcePoolServiceClient.QueryDeployedModelsPagedResponse queryDeployedModels(String deploymentResourcePool)

List DeployedModels that have been deployed on this DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   String deploymentResourcePool = "deploymentResourcePool-1928845137";
   for (DeployedModel element :
       deploymentResourcePoolServiceClient
           .queryDeployedModels(deploymentResourcePool)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
deploymentResourcePool	String Required. The name of the target DeploymentResourcePool to query. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

Returns

Type	Description
DeploymentResourcePoolServiceClient.QueryDeployedModelsPagedResponse

queryDeployedModelsCallable()

public final UnaryCallable<QueryDeployedModelsRequest,QueryDeployedModelsResponse> queryDeployedModelsCallable()

List DeployedModels that have been deployed on this DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<QueryDeployedModelsRequest,QueryDeployedModelsResponse>

queryDeployedModelsPagedCallable()

public final UnaryCallable<QueryDeployedModelsRequest,DeploymentResourcePoolServiceClient.QueryDeployedModelsPagedResponse> queryDeployedModelsPagedCallable()

List DeployedModels that have been deployed on this DeploymentResourcePool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }
 

Returns

Type	Description
UnaryCallable<QueryDeployedModelsRequest,QueryDeployedModelsPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = deploymentResourcePoolServiceClient.setIamPolicy(request);
 }
 

Parameter

Name	Description
request	com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.Policy

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       deploymentResourcePoolServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response =
       deploymentResourcePoolServiceClient.testIamPermissions(request);
 }
 

Parameter

Name	Description
request	com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.TestIamPermissionsResponse

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
     DeploymentResourcePoolServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       deploymentResourcePoolServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>