- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 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 SpecialistPoolServiceClient implements 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:
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:
- 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.
- 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.
- 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:
SpecialistPoolServiceSettings specialistPoolServiceSettings =
SpecialistPoolServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create(specialistPoolServiceSettings);
To customize the endpoint:
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.
Implements
BackgroundResourceConstructors
SpecialistPoolServiceClient(SpecialistPoolServiceSettings settings)
protected SpecialistPoolServiceClient(SpecialistPoolServiceSettings settings)
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.
Name | Description |
settings | SpecialistPoolServiceSettings |
SpecialistPoolServiceClient(SpecialistPoolServiceStub stub)
protected SpecialistPoolServiceClient(SpecialistPoolServiceStub stub)
Name | Description |
stub | SpecialistPoolServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
create()
public static final SpecialistPoolServiceClient create()
Constructs an instance of SpecialistPoolServiceClient with default settings.
Type | Description |
SpecialistPoolServiceClient |
Type | Description |
IOException |
create(SpecialistPoolServiceSettings settings)
public static final SpecialistPoolServiceClient create(SpecialistPoolServiceSettings settings)
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.
Name | Description |
settings | SpecialistPoolServiceSettings |
Type | Description |
SpecialistPoolServiceClient |
Type | Description |
IOException |
create(SpecialistPoolServiceStub stub)
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).
Name | Description |
stub | SpecialistPoolServiceStub |
Type | Description |
SpecialistPoolServiceClient |
createSpecialistPoolAsync(CreateSpecialistPoolRequest request)
public final OperationFuture<SpecialistPool,CreateSpecialistPoolOperationMetadata> createSpecialistPoolAsync(CreateSpecialistPoolRequest request)
Creates a SpecialistPool.
Sample code:
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();
}
Name | Description |
request | CreateSpecialistPoolRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<SpecialistPool,CreateSpecialistPoolOperationMetadata> |
createSpecialistPoolAsync(LocationName parent, SpecialistPool specialistPool)
public final OperationFuture<SpecialistPool,CreateSpecialistPoolOperationMetadata> createSpecialistPoolAsync(LocationName parent, SpecialistPool specialistPool)
Creates a SpecialistPool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
SpecialistPool specialistPool = SpecialistPool.newBuilder().build();
SpecialistPool response =
specialistPoolServiceClient.createSpecialistPoolAsync(parent, specialistPool).get();
}
Name | Description |
parent | LocationName Required. The parent Project name for the new SpecialistPool. The form is
|
specialistPool | SpecialistPool Required. The SpecialistPool to create. |
Type | Description |
OperationFuture<SpecialistPool,CreateSpecialistPoolOperationMetadata> |
createSpecialistPoolAsync(String parent, SpecialistPool specialistPool)
public final OperationFuture<SpecialistPool,CreateSpecialistPoolOperationMetadata> createSpecialistPoolAsync(String parent, SpecialistPool specialistPool)
Creates a SpecialistPool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
SpecialistPool specialistPool = SpecialistPool.newBuilder().build();
SpecialistPool response =
specialistPoolServiceClient.createSpecialistPoolAsync(parent, specialistPool).get();
}
Name | Description |
parent | String Required. The parent Project name for the new SpecialistPool. The form is
|
specialistPool | SpecialistPool Required. The SpecialistPool to create. |
Type | Description |
OperationFuture<SpecialistPool,CreateSpecialistPoolOperationMetadata> |
createSpecialistPoolCallable()
public final UnaryCallable<CreateSpecialistPoolRequest,Operation> createSpecialistPoolCallable()
Creates a SpecialistPool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
CreateSpecialistPoolRequest request =
CreateSpecialistPoolRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSpecialistPool(SpecialistPool.newBuilder().build())
.build();
ApiFuture
Type | Description |
UnaryCallable<CreateSpecialistPoolRequest,Operation> |
createSpecialistPoolOperationCallable()
public final OperationCallable<CreateSpecialistPoolRequest,SpecialistPool,CreateSpecialistPoolOperationMetadata> createSpecialistPoolOperationCallable()
Creates a SpecialistPool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
CreateSpecialistPoolRequest request =
CreateSpecialistPoolRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSpecialistPool(SpecialistPool.newBuilder().build())
.build();
OperationFuture
Type | Description |
OperationCallable<CreateSpecialistPoolRequest,SpecialistPool,CreateSpecialistPoolOperationMetadata> |
deleteSpecialistPoolAsync(DeleteSpecialistPoolRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteSpecialistPoolAsync(DeleteSpecialistPoolRequest request)
Deletes a SpecialistPool as well as all Specialists in the pool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
DeleteSpecialistPoolRequest request =
DeleteSpecialistPoolRequest.newBuilder()
.setName(
SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString())
.setForce(true)
.build();
specialistPoolServiceClient.deleteSpecialistPoolAsync(request).get();
}
Name | Description |
request | DeleteSpecialistPoolRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteSpecialistPoolAsync(SpecialistPoolName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteSpecialistPoolAsync(SpecialistPoolName name)
Deletes a SpecialistPool as well as all Specialists in the pool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
SpecialistPoolName name =
SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]");
specialistPoolServiceClient.deleteSpecialistPoolAsync(name).get();
}
Name | Description |
name | SpecialistPoolName Required. The resource name of the SpecialistPool to delete. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteSpecialistPoolAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteSpecialistPoolAsync(String name)
Deletes a SpecialistPool as well as all Specialists in the pool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
String name =
SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString();
specialistPoolServiceClient.deleteSpecialistPoolAsync(name).get();
}
Name | Description |
name | String Required. The resource name of the SpecialistPool to delete. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteSpecialistPoolCallable()
public final UnaryCallable<DeleteSpecialistPoolRequest,Operation> deleteSpecialistPoolCallable()
Deletes a SpecialistPool as well as all Specialists in the pool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
DeleteSpecialistPoolRequest request =
DeleteSpecialistPoolRequest.newBuilder()
.setName(
SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString())
.setForce(true)
.build();
ApiFuture
Type | Description |
UnaryCallable<DeleteSpecialistPoolRequest,Operation> |
deleteSpecialistPoolOperationCallable()
public final OperationCallable<DeleteSpecialistPoolRequest,Empty,DeleteOperationMetadata> deleteSpecialistPoolOperationCallable()
Deletes a SpecialistPool as well as all Specialists in the pool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
DeleteSpecialistPoolRequest request =
DeleteSpecialistPoolRequest.newBuilder()
.setName(
SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString())
.setForce(true)
.build();
OperationFuture
Type | Description |
OperationCallable<DeleteSpecialistPoolRequest,Empty,DeleteOperationMetadata> |
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.
Type | Description |
OperationsClient |
getSettings()
public final SpecialistPoolServiceSettings getSettings()
Type | Description |
SpecialistPoolServiceSettings |
getSpecialistPool(GetSpecialistPoolRequest request)
public final SpecialistPool getSpecialistPool(GetSpecialistPoolRequest request)
Gets a SpecialistPool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
GetSpecialistPoolRequest request =
GetSpecialistPoolRequest.newBuilder()
.setName(
SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString())
.build();
SpecialistPool response = specialistPoolServiceClient.getSpecialistPool(request);
}
Name | Description |
request | GetSpecialistPoolRequest The request object containing all of the parameters for the API call. |
Type | Description |
SpecialistPool |
getSpecialistPool(SpecialistPoolName name)
public final SpecialistPool getSpecialistPool(SpecialistPoolName name)
Gets a SpecialistPool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
SpecialistPoolName name =
SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]");
SpecialistPool response = specialistPoolServiceClient.getSpecialistPool(name);
}
Name | Description |
name | SpecialistPoolName Required. The name of the SpecialistPool resource. The form is
|
Type | Description |
SpecialistPool |
getSpecialistPool(String name)
public final SpecialistPool getSpecialistPool(String name)
Gets a SpecialistPool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
String name =
SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString();
SpecialistPool response = specialistPoolServiceClient.getSpecialistPool(name);
}
Name | Description |
name | String Required. The name of the SpecialistPool resource. The form is
|
Type | Description |
SpecialistPool |
getSpecialistPoolCallable()
public final UnaryCallable<GetSpecialistPoolRequest,SpecialistPool> getSpecialistPoolCallable()
Gets a SpecialistPool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
GetSpecialistPoolRequest request =
GetSpecialistPoolRequest.newBuilder()
.setName(
SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]").toString())
.build();
ApiFuture
Type | Description |
UnaryCallable<GetSpecialistPoolRequest,SpecialistPool> |
getStub()
public SpecialistPoolServiceStub getStub()
Type | Description |
SpecialistPoolServiceStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listSpecialistPools(ListSpecialistPoolsRequest request)
public final SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse listSpecialistPools(ListSpecialistPoolsRequest request)
Lists SpecialistPools in a Location.
Sample code:
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);
}
}
Name | Description |
request | ListSpecialistPoolsRequest The request object containing all of the parameters for the API call. |
Type | Description |
SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse |
listSpecialistPools(LocationName parent)
public final SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse listSpecialistPools(LocationName parent)
Lists SpecialistPools in a Location.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (SpecialistPool element :
specialistPoolServiceClient.listSpecialistPools(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The name of the SpecialistPool's parent resource. Format:
|
Type | Description |
SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse |
listSpecialistPools(String parent)
public final SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse listSpecialistPools(String parent)
Lists SpecialistPools in a Location.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (SpecialistPool element :
specialistPoolServiceClient.listSpecialistPools(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The name of the SpecialistPool's parent resource. Format:
|
Type | Description |
SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse |
listSpecialistPoolsCallable()
public final UnaryCallable<ListSpecialistPoolsRequest,ListSpecialistPoolsResponse> listSpecialistPoolsCallable()
Lists SpecialistPools in a Location.
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListSpecialistPoolsRequest,ListSpecialistPoolsResponse> |
listSpecialistPoolsPagedCallable()
public final UnaryCallable<ListSpecialistPoolsRequest,SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse> listSpecialistPoolsPagedCallable()
Lists SpecialistPools in a Location.
Sample code:
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
Type | Description |
UnaryCallable<ListSpecialistPoolsRequest,ListSpecialistPoolsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateSpecialistPoolAsync(SpecialistPool specialistPool, FieldMask updateMask)
public final OperationFuture<SpecialistPool,UpdateSpecialistPoolOperationMetadata> updateSpecialistPoolAsync(SpecialistPool specialistPool, FieldMask updateMask)
Updates a SpecialistPool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
SpecialistPool specialistPool = SpecialistPool.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
SpecialistPool response =
specialistPoolServiceClient.updateSpecialistPoolAsync(specialistPool, updateMask).get();
}
Name | Description |
specialistPool | SpecialistPool Required. The SpecialistPool which replaces the resource on the server. |
updateMask | FieldMask Required. The update mask applies to the resource. |
Type | Description |
OperationFuture<SpecialistPool,UpdateSpecialistPoolOperationMetadata> |
updateSpecialistPoolAsync(UpdateSpecialistPoolRequest request)
public final OperationFuture<SpecialistPool,UpdateSpecialistPoolOperationMetadata> updateSpecialistPoolAsync(UpdateSpecialistPoolRequest request)
Updates a SpecialistPool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
UpdateSpecialistPoolRequest request =
UpdateSpecialistPoolRequest.newBuilder()
.setSpecialistPool(SpecialistPool.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
SpecialistPool response =
specialistPoolServiceClient.updateSpecialistPoolAsync(request).get();
}
Name | Description |
request | UpdateSpecialistPoolRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<SpecialistPool,UpdateSpecialistPoolOperationMetadata> |
updateSpecialistPoolCallable()
public final UnaryCallable<UpdateSpecialistPoolRequest,Operation> updateSpecialistPoolCallable()
Updates a SpecialistPool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
UpdateSpecialistPoolRequest request =
UpdateSpecialistPoolRequest.newBuilder()
.setSpecialistPool(SpecialistPool.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture
Type | Description |
UnaryCallable<UpdateSpecialistPoolRequest,Operation> |
updateSpecialistPoolOperationCallable()
public final OperationCallable<UpdateSpecialistPoolRequest,SpecialistPool,UpdateSpecialistPoolOperationMetadata> updateSpecialistPoolOperationCallable()
Updates a SpecialistPool.
Sample code:
try (SpecialistPoolServiceClient specialistPoolServiceClient =
SpecialistPoolServiceClient.create()) {
UpdateSpecialistPoolRequest request =
UpdateSpecialistPoolRequest.newBuilder()
.setSpecialistPool(SpecialistPool.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
OperationFuture
Type | Description |
OperationCallable<UpdateSpecialistPoolRequest,SpecialistPool,UpdateSpecialistPoolOperationMetadata> |