Class SpecialistPoolServiceClient (2.23.0-rc)

Version latest

• 2.25.0-rc (latest)
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0

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 projects/{project}/locations/{location}.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.SpecialistPool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateSpecialistPoolRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.SpecialistPool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 projects/{project}/locations/{location}/specialistPools/{specialist_pool}.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetSpecialistPoolRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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: projects/{project}/locations/{location}
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.SpecialistPool, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListSpecialistPoolsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.SpecialistPool, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: projects/{project}/locations/{location}/specialistPools/{specialist_pool}
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteSpecialistPoolRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.SpecialistPool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpdateSpecialistPoolRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.SpecialistPool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.