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.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
SpecialistPoolServiceClient(SpecialistPoolServiceClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
SpecialistPoolServiceClient const &
|
SpecialistPoolServiceClient(SpecialistPoolServiceClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
SpecialistPoolServiceClient &&
|
SpecialistPoolServiceClient(std::shared_ptr< SpecialistPoolServiceConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< SpecialistPoolServiceConnection >
|
opts |
Options
|
Operators
operator=(SpecialistPoolServiceClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
SpecialistPoolServiceClient const &
|
| Returns | |
|---|---|
| Type | Description |
SpecialistPoolServiceClient & |
|
operator=(SpecialistPoolServiceClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
SpecialistPoolServiceClient &&
|
| Returns | |
|---|---|
| Type | Description |
SpecialistPoolServiceClient & |
|
Functions
CreateSpecialistPool(std::string const &, google::cloud::aiplatform::v1::SpecialistPool const &, Options)
Creates a SpecialistPool.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent Project name for the new SpecialistPool. The form is |
specialist_pool |
google::cloud::aiplatform::v1::SpecialistPool const &
Required. The SpecialistPool to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::SpecialistPool > > |
A |
CreateSpecialistPool(NoAwaitTag, std::string const &, google::cloud::aiplatform::v1::SpecialistPool const &, Options)
Creates a SpecialistPool.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
specialist_pool |
google::cloud::aiplatform::v1::SpecialistPool const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateSpecialistPool(google::cloud::aiplatform::v1::CreateSpecialistPoolRequest const &, Options)
Creates a SpecialistPool.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::aiplatform::v1::CreateSpecialistPoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::SpecialistPool > > |
A |
CreateSpecialistPool(NoAwaitTag, google::cloud::aiplatform::v1::CreateSpecialistPoolRequest const &, Options)
Creates a SpecialistPool.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::aiplatform::v1::CreateSpecialistPoolRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateSpecialistPool(google::longrunning::Operation const &, Options)
Creates a SpecialistPool.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::SpecialistPool > > |
|
GetSpecialistPool(std::string const &, Options)
Gets a SpecialistPool.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the SpecialistPool resource. The form is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::aiplatform::v1::SpecialistPool > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.SpecialistPool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSpecialistPool(google::cloud::aiplatform::v1::GetSpecialistPoolRequest const &, Options)
Gets a SpecialistPool.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::aiplatform::v1::GetSpecialistPoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::aiplatform::v1::SpecialistPool > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.SpecialistPool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListSpecialistPools(std::string const &, Options)
Lists SpecialistPools in a Location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The name of the SpecialistPool's parent resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::aiplatform::v1::SpecialistPool > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSpecialistPools(google::cloud::aiplatform::v1::ListSpecialistPoolsRequest, Options)
Lists SpecialistPools in a Location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::aiplatform::v1::ListSpecialistPoolsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::aiplatform::v1::SpecialistPool > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteSpecialistPool(std::string const &, Options)
Deletes a SpecialistPool as well as all Specialists in the pool.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the SpecialistPool to delete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteSpecialistPool(NoAwaitTag, std::string const &, Options)
Deletes a SpecialistPool as well as all Specialists in the pool.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteSpecialistPool(google::cloud::aiplatform::v1::DeleteSpecialistPoolRequest const &, Options)
Deletes a SpecialistPool as well as all Specialists in the pool.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::aiplatform::v1::DeleteSpecialistPoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteSpecialistPool(NoAwaitTag, google::cloud::aiplatform::v1::DeleteSpecialistPoolRequest const &, Options)
Deletes a SpecialistPool as well as all Specialists in the pool.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::aiplatform::v1::DeleteSpecialistPoolRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteSpecialistPool(google::longrunning::Operation const &, Options)
Deletes a SpecialistPool as well as all Specialists in the pool.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
|
UpdateSpecialistPool(google::cloud::aiplatform::v1::SpecialistPool const &, google::protobuf::FieldMask const &, Options)
Updates a SpecialistPool.
| Parameters | |
|---|---|
| Name | Description |
specialist_pool |
google::cloud::aiplatform::v1::SpecialistPool const &
Required. The SpecialistPool which replaces the resource on the server. |
update_mask |
google::protobuf::FieldMask const &
Required. The update mask applies to the resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::SpecialistPool > > |
A |
UpdateSpecialistPool(NoAwaitTag, google::cloud::aiplatform::v1::SpecialistPool const &, google::protobuf::FieldMask const &, Options)
Updates a SpecialistPool.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
specialist_pool |
google::cloud::aiplatform::v1::SpecialistPool const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateSpecialistPool(google::cloud::aiplatform::v1::UpdateSpecialistPoolRequest const &, Options)
Updates a SpecialistPool.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::aiplatform::v1::UpdateSpecialistPoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::SpecialistPool > > |
A |
UpdateSpecialistPool(NoAwaitTag, google::cloud::aiplatform::v1::UpdateSpecialistPoolRequest const &, Options)
Updates a SpecialistPool.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::aiplatform::v1::UpdateSpecialistPoolRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateSpecialistPool(google::longrunning::Operation const &, Options)
Updates a SpecialistPool.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::SpecialistPool > > |
|
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::location::ListLocationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::location::GetLocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
| Parameters | |
|---|---|
| Name | Description |
request |
google::iam::v1::SetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy set.
| Parameters | |
|---|---|
| Name | Description |
request |
google::iam::v1::GetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
| Parameters | |
|---|---|
| Name | Description |
request |
google::iam::v1::TestIamPermissionsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::TestIamPermissionsResponse > |
the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::DeleteOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::CancelOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
WaitOperation(google::longrunning::WaitOperationRequest const &, Options)
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::WaitOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |