com.google.cloud.aiplatform.v1

Class SpecialistPoolServiceClient

java.lang.Object

com.google.cloud.aiplatform.v1.SpecialistPoolServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class SpecialistPoolServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: A service for creating and managing Customer SpecialistPools. When customers start Data Labeling jobs, they can reuse/create Specialist Pools to bring their own Specialists to label the data. Customers can add/remove Managers for the Specialist Pool on Cloud console, then Managers will get email notifications to manage Specialists and tasks on CrowdCompute console.

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 (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   SpecialistPoolName name =
       SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]");
   SpecialistPool response = specialistPoolServiceClient.getSpecialistPool(name);
 }
 

Note: close() needs to be called on the SpecialistPoolServiceClient 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 SpecialistPoolServiceSettings 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.
 SpecialistPoolServiceSettings specialistPoolServiceSettings =
     SpecialistPoolServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create(specialistPoolServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 SpecialistPoolServiceSettings specialistPoolServiceSettings =
     SpecialistPoolServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create(specialistPoolServiceSettings);
 

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpecialistPoolServiceClient.ListLocationsFixedSizeCollection
static class	SpecialistPoolServiceClient.ListLocationsPage
static class	SpecialistPoolServiceClient.ListLocationsPagedResponse
static class	SpecialistPoolServiceClient.ListSpecialistPoolsFixedSizeCollection
static class	SpecialistPoolServiceClient.ListSpecialistPoolsPage
static class	SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpecialistPoolServiceClient(SpecialistPoolServiceSettings settings) Constructs an instance of SpecialistPoolServiceClient, using the given settings.
protected	SpecialistPoolServiceClient(SpecialistPoolServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static SpecialistPoolServiceClient	create() Constructs an instance of SpecialistPoolServiceClient with default settings.
static SpecialistPoolServiceClient	create(SpecialistPoolServiceSettings settings) Constructs an instance of SpecialistPoolServiceClient, using the given settings.
static SpecialistPoolServiceClient	create(SpecialistPoolServiceStub stub) Constructs an instance of SpecialistPoolServiceClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<SpecialistPool,CreateSpecialistPoolOperationMetadata>	createSpecialistPoolAsync(CreateSpecialistPoolRequest request) Creates a SpecialistPool.
com.google.api.gax.longrunning.OperationFuture<SpecialistPool,CreateSpecialistPoolOperationMetadata>	createSpecialistPoolAsync(LocationName parent, SpecialistPool specialistPool) Creates a SpecialistPool.
com.google.api.gax.longrunning.OperationFuture<SpecialistPool,CreateSpecialistPoolOperationMetadata>	createSpecialistPoolAsync(String parent, SpecialistPool specialistPool) Creates a SpecialistPool.
com.google.api.gax.rpc.UnaryCallable<CreateSpecialistPoolRequest,com.google.longrunning.Operation>	createSpecialistPoolCallable() Creates a SpecialistPool.
com.google.api.gax.rpc.OperationCallable<CreateSpecialistPoolRequest,SpecialistPool,CreateSpecialistPoolOperationMetadata>	createSpecialistPoolOperationCallable() Creates a SpecialistPool.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>	deleteSpecialistPoolAsync(DeleteSpecialistPoolRequest request) Deletes a SpecialistPool as well as all Specialists in the pool.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>	deleteSpecialistPoolAsync(SpecialistPoolName name) Deletes a SpecialistPool as well as all Specialists in the pool.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>	deleteSpecialistPoolAsync(String name) Deletes a SpecialistPool as well as all Specialists in the pool.
com.google.api.gax.rpc.UnaryCallable<DeleteSpecialistPoolRequest,com.google.longrunning.Operation>	deleteSpecialistPoolCallable() Deletes a SpecialistPool as well as all Specialists in the pool.
com.google.api.gax.rpc.OperationCallable<DeleteSpecialistPoolRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteSpecialistPoolOperationCallable() Deletes a SpecialistPool as well as all Specialists in the pool.
com.google.iam.v1.Policy	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the access control policy for a resource.
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.
com.google.cloud.location.Location	getLocation(com.google.cloud.location.GetLocationRequest request) Gets information about a location.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationCallable() Gets information about a location.
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.
SpecialistPoolServiceSettings	getSettings()
SpecialistPool	getSpecialistPool(GetSpecialistPoolRequest request) Gets a SpecialistPool.
SpecialistPool	getSpecialistPool(SpecialistPoolName name) Gets a SpecialistPool.
SpecialistPool	getSpecialistPool(String name) Gets a SpecialistPool.
com.google.api.gax.rpc.UnaryCallable<GetSpecialistPoolRequest,SpecialistPool>	getSpecialistPoolCallable() Gets a SpecialistPool.
SpecialistPoolServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
SpecialistPoolServiceClient.ListLocationsPagedResponse	listLocations(com.google.cloud.location.ListLocationsRequest request) Lists information about the supported locations for this service.
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.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,SpecialistPoolServiceClient.ListLocationsPagedResponse>	listLocationsPagedCallable() Lists information about the supported locations for this service.
SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse	listSpecialistPools(ListSpecialistPoolsRequest request) Lists SpecialistPools in a Location.
SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse	listSpecialistPools(LocationName parent) Lists SpecialistPools in a Location.
SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse	listSpecialistPools(String parent) Lists SpecialistPools in a Location.
com.google.api.gax.rpc.UnaryCallable<ListSpecialistPoolsRequest,ListSpecialistPoolsResponse>	listSpecialistPoolsCallable() Lists SpecialistPools in a Location.
com.google.api.gax.rpc.UnaryCallable<ListSpecialistPoolsRequest,SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse>	listSpecialistPoolsPagedCallable() Lists SpecialistPools in a Location.
com.google.iam.v1.Policy	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets the access control policy on the specified resource.
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.
void	shutdown()
void	shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Returns permissions that a caller has on the specified resource.
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.
com.google.api.gax.longrunning.OperationFuture<SpecialistPool,UpdateSpecialistPoolOperationMetadata>	updateSpecialistPoolAsync(SpecialistPool specialistPool, com.google.protobuf.FieldMask updateMask) Updates a SpecialistPool.
com.google.api.gax.longrunning.OperationFuture<SpecialistPool,UpdateSpecialistPoolOperationMetadata>	updateSpecialistPoolAsync(UpdateSpecialistPoolRequest request) Updates a SpecialistPool.
com.google.api.gax.rpc.UnaryCallable<UpdateSpecialistPoolRequest,com.google.longrunning.Operation>	updateSpecialistPoolCallable() Updates a SpecialistPool.
com.google.api.gax.rpc.OperationCallable<UpdateSpecialistPoolRequest,SpecialistPool,UpdateSpecialistPoolOperationMetadata>	updateSpecialistPoolOperationCallable() Updates a SpecialistPool.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpecialistPoolServiceClient

protected SpecialistPoolServiceClient(SpecialistPoolServiceSettings settings)
                               throws IOException

Constructs an instance of SpecialistPoolServiceClient, 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

SpecialistPoolServiceClient

protected SpecialistPoolServiceClient(SpecialistPoolServiceStub stub)

Method Detail

create

public static final SpecialistPoolServiceClient create()
                                                throws IOException

Constructs an instance of SpecialistPoolServiceClient with default settings.

Throws:

IOException

create

public static final SpecialistPoolServiceClient create(SpecialistPoolServiceSettings settings)
                                                throws IOException

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

Throws:

IOException

create

public static final SpecialistPoolServiceClient create(SpecialistPoolServiceStub stub)

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

getSettings

public final SpecialistPoolServiceSettings getSettings()

getStub

public SpecialistPoolServiceStub getStub()

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.

createSpecialistPoolAsync

public final com.google.api.gax.longrunning.OperationFuture<SpecialistPool,CreateSpecialistPoolOperationMetadata> createSpecialistPoolAsync(LocationName parent,
                                                                                                                                            SpecialistPool specialistPool)

Creates a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   SpecialistPool specialistPool = SpecialistPool.newBuilder().build();
   SpecialistPool response =
       specialistPoolServiceClient.createSpecialistPoolAsync(parent, specialistPool).get();
 }
 

Parameters:

parent - Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.

specialistPool - Required. The SpecialistPool to create.

Throws:

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

createSpecialistPoolAsync

public final com.google.api.gax.longrunning.OperationFuture<SpecialistPool,CreateSpecialistPoolOperationMetadata> createSpecialistPoolAsync(String parent,
                                                                                                                                            SpecialistPool specialistPool)

Creates a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   SpecialistPool specialistPool = SpecialistPool.newBuilder().build();
   SpecialistPool response =
       specialistPoolServiceClient.createSpecialistPoolAsync(parent, specialistPool).get();
 }
 

Parameters:

parent - Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.

specialistPool - Required. The SpecialistPool to create.

Throws:

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

createSpecialistPoolAsync

public final com.google.api.gax.longrunning.OperationFuture<SpecialistPool,CreateSpecialistPoolOperationMetadata> createSpecialistPoolAsync(CreateSpecialistPoolRequest request)

Creates a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   CreateSpecialistPoolRequest request =
       CreateSpecialistPoolRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSpecialistPool(SpecialistPool.newBuilder().build())
           .build();
   SpecialistPool response =
       specialistPoolServiceClient.createSpecialistPoolAsync(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

createSpecialistPoolOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateSpecialistPoolRequest,SpecialistPool,CreateSpecialistPoolOperationMetadata> createSpecialistPoolOperationCallable()

Creates a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   CreateSpecialistPoolRequest request =
       CreateSpecialistPoolRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSpecialistPool(SpecialistPool.newBuilder().build())
           .build();
   OperationFuture<SpecialistPool, CreateSpecialistPoolOperationMetadata> future =
       specialistPoolServiceClient.createSpecialistPoolOperationCallable().futureCall(request);
   // Do something.
   SpecialistPool response = future.get();
 }
 

createSpecialistPoolCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateSpecialistPoolRequest,com.google.longrunning.Operation> createSpecialistPoolCallable()

Creates a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   CreateSpecialistPoolRequest request =
       CreateSpecialistPoolRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSpecialistPool(SpecialistPool.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       specialistPoolServiceClient.createSpecialistPoolCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

getSpecialistPool

public final SpecialistPool getSpecialistPool(SpecialistPoolName name)

Gets a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   SpecialistPoolName name =
       SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]");
   SpecialistPool response = specialistPoolServiceClient.getSpecialistPool(name);
 }
 

Parameters:

name - Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.

Throws:

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

getSpecialistPool

public final SpecialistPool getSpecialistPool(String name)

Gets a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   String name =
       SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString();
   SpecialistPool response = specialistPoolServiceClient.getSpecialistPool(name);
 }
 

Parameters:

name - Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.

Throws:

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

getSpecialistPool

public final SpecialistPool getSpecialistPool(GetSpecialistPoolRequest request)

Gets a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   GetSpecialistPoolRequest request =
       GetSpecialistPoolRequest.newBuilder()
           .setName(
               SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString())
           .build();
   SpecialistPool response = specialistPoolServiceClient.getSpecialistPool(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

getSpecialistPoolCallable

public final com.google.api.gax.rpc.UnaryCallable<GetSpecialistPoolRequest,SpecialistPool> getSpecialistPoolCallable()

Gets a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   GetSpecialistPoolRequest request =
       GetSpecialistPoolRequest.newBuilder()
           .setName(
               SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString())
           .build();
   ApiFuture<SpecialistPool> future =
       specialistPoolServiceClient.getSpecialistPoolCallable().futureCall(request);
   // Do something.
   SpecialistPool response = future.get();
 }
 

listSpecialistPools

public final SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse listSpecialistPools(LocationName parent)

Lists SpecialistPools 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 (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (SpecialistPool element :
       specialistPoolServiceClient.listSpecialistPools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`

Throws:

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

listSpecialistPools

public final SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse listSpecialistPools(String parent)

Lists SpecialistPools 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 (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (SpecialistPool element :
       specialistPoolServiceClient.listSpecialistPools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`

Throws:

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

listSpecialistPools

public final SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse listSpecialistPools(ListSpecialistPoolsRequest request)

Lists SpecialistPools 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 (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   ListSpecialistPoolsRequest request =
       ListSpecialistPoolsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (SpecialistPool element :
       specialistPoolServiceClient.listSpecialistPools(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

listSpecialistPoolsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListSpecialistPoolsRequest,SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse> listSpecialistPoolsPagedCallable()

Lists SpecialistPools 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 (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   ListSpecialistPoolsRequest request =
       ListSpecialistPoolsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<SpecialistPool> future =
       specialistPoolServiceClient.listSpecialistPoolsPagedCallable().futureCall(request);
   // Do something.
   for (SpecialistPool element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listSpecialistPoolsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListSpecialistPoolsRequest,ListSpecialistPoolsResponse> listSpecialistPoolsCallable()

Lists SpecialistPools 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 (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   ListSpecialistPoolsRequest request =
       ListSpecialistPoolsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListSpecialistPoolsResponse response =
         specialistPoolServiceClient.listSpecialistPoolsCallable().call(request);
     for (SpecialistPool element : response.getSpecialistPoolsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteSpecialistPoolAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteSpecialistPoolAsync(SpecialistPoolName name)

Deletes a SpecialistPool as well as all Specialists in the pool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   SpecialistPoolName name =
       SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]");
   specialistPoolServiceClient.deleteSpecialistPoolAsync(name).get();
 }
 

Parameters:

name - Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`

Throws:

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

deleteSpecialistPoolAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteSpecialistPoolAsync(String name)

Deletes a SpecialistPool as well as all Specialists in the pool.

Sample code:

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

Parameters:

name - Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`

Throws:

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

deleteSpecialistPoolAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteSpecialistPoolAsync(DeleteSpecialistPoolRequest request)

Deletes a SpecialistPool as well as all Specialists in the pool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   DeleteSpecialistPoolRequest request =
       DeleteSpecialistPoolRequest.newBuilder()
           .setName(
               SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString())
           .setForce(true)
           .build();
   specialistPoolServiceClient.deleteSpecialistPoolAsync(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

deleteSpecialistPoolOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteSpecialistPoolRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteSpecialistPoolOperationCallable()

Deletes a SpecialistPool as well as all Specialists in the pool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   DeleteSpecialistPoolRequest request =
       DeleteSpecialistPoolRequest.newBuilder()
           .setName(
               SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString())
           .setForce(true)
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       specialistPoolServiceClient.deleteSpecialistPoolOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

deleteSpecialistPoolCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteSpecialistPoolRequest,com.google.longrunning.Operation> deleteSpecialistPoolCallable()

Deletes a SpecialistPool as well as all Specialists in the pool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   DeleteSpecialistPoolRequest request =
       DeleteSpecialistPoolRequest.newBuilder()
           .setName(
               SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString())
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       specialistPoolServiceClient.deleteSpecialistPoolCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

updateSpecialistPoolAsync

public final com.google.api.gax.longrunning.OperationFuture<SpecialistPool,UpdateSpecialistPoolOperationMetadata> updateSpecialistPoolAsync(SpecialistPool specialistPool,
                                                                                                                                            com.google.protobuf.FieldMask updateMask)

Updates a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   SpecialistPool specialistPool = SpecialistPool.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   SpecialistPool response =
       specialistPoolServiceClient.updateSpecialistPoolAsync(specialistPool, updateMask).get();
 }
 

Parameters:

specialistPool - Required. The SpecialistPool which replaces the resource on the server.

updateMask - Required. The update mask applies to the resource.

Throws:

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

updateSpecialistPoolAsync

public final com.google.api.gax.longrunning.OperationFuture<SpecialistPool,UpdateSpecialistPoolOperationMetadata> updateSpecialistPoolAsync(UpdateSpecialistPoolRequest request)

Updates a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   UpdateSpecialistPoolRequest request =
       UpdateSpecialistPoolRequest.newBuilder()
           .setSpecialistPool(SpecialistPool.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   SpecialistPool response =
       specialistPoolServiceClient.updateSpecialistPoolAsync(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

updateSpecialistPoolOperationCallable

public final com.google.api.gax.rpc.OperationCallable<UpdateSpecialistPoolRequest,SpecialistPool,UpdateSpecialistPoolOperationMetadata> updateSpecialistPoolOperationCallable()

Updates a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   UpdateSpecialistPoolRequest request =
       UpdateSpecialistPoolRequest.newBuilder()
           .setSpecialistPool(SpecialistPool.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<SpecialistPool, UpdateSpecialistPoolOperationMetadata> future =
       specialistPoolServiceClient.updateSpecialistPoolOperationCallable().futureCall(request);
   // Do something.
   SpecialistPool response = future.get();
 }
 

updateSpecialistPoolCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateSpecialistPoolRequest,com.google.longrunning.Operation> updateSpecialistPoolCallable()

Updates a SpecialistPool.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   UpdateSpecialistPoolRequest request =
       UpdateSpecialistPoolRequest.newBuilder()
           .setSpecialistPool(SpecialistPool.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       specialistPoolServiceClient.updateSpecialistPoolCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

listLocations

public final SpecialistPoolServiceClient.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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : specialistPoolServiceClient.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,SpecialistPoolServiceClient.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 (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       specialistPoolServiceClient.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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         specialistPoolServiceClient.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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = specialistPoolServiceClient.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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       specialistPoolServiceClient.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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.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 = specialistPoolServiceClient.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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.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 =
       specialistPoolServiceClient.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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = specialistPoolServiceClient.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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       specialistPoolServiceClient.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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = specialistPoolServiceClient.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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpecialistPoolServiceClient specialistPoolServiceClient =
     SpecialistPoolServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       specialistPoolServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface 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

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException