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(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 |
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(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 |
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(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 |