Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class SpecialistPool.
SpecialistPool represents customers' own workforce to work on their data labeling jobs. It includes a group of specialist managers and workers.
Managers are responsible for managing the workers in this pool as well as customers' data labeling jobs associated with this pool. Customers create specialist pool as well as start data labeling jobs on Cloud, managers and workers handle the jobs using CrowdCompute console.
Generated from protobuf message google.cloud.aiplatform.v1.SpecialistPool
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The resource name of the SpecialistPool. |
↳ display_name |
string
Required. The user-defined name of the SpecialistPool. The name can be up to 128 characters long and can consist of any UTF-8 characters. This field should be unique on project-level. |
↳ specialist_managers_count |
int
Output only. The number of managers in this SpecialistPool. |
↳ specialist_manager_emails |
array
The email addresses of the managers in the SpecialistPool. |
↳ pending_data_labeling_jobs |
array
Output only. The resource name of the pending data labeling jobs. |
↳ specialist_worker_emails |
array
The email addresses of workers in the SpecialistPool. |
getName
Required. The resource name of the SpecialistPool.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The resource name of the SpecialistPool.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Required. The user-defined name of the SpecialistPool.
The name can be up to 128 characters long and can consist of any UTF-8 characters. This field should be unique on project-level.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Required. The user-defined name of the SpecialistPool.
The name can be up to 128 characters long and can consist of any UTF-8 characters. This field should be unique on project-level.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpecialistManagersCount
Output only. The number of managers in this SpecialistPool.
Generated from protobuf field int32 specialist_managers_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setSpecialistManagersCount
Output only. The number of managers in this SpecialistPool.
Generated from protobuf field int32 specialist_managers_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpecialistManagerEmails
The email addresses of the managers in the SpecialistPool.
Generated from protobuf field repeated string specialist_manager_emails = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSpecialistManagerEmails
The email addresses of the managers in the SpecialistPool.
Generated from protobuf field repeated string specialist_manager_emails = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPendingDataLabelingJobs
Output only. The resource name of the pending data labeling jobs.
Generated from protobuf field repeated string pending_data_labeling_jobs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPendingDataLabelingJobs
Output only. The resource name of the pending data labeling jobs.
Generated from protobuf field repeated string pending_data_labeling_jobs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpecialistWorkerEmails
The email addresses of workers in the SpecialistPool.
Generated from protobuf field repeated string specialist_worker_emails = 7;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSpecialistWorkerEmails
The email addresses of workers in the SpecialistPool.
Generated from protobuf field repeated string specialist_worker_emails = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |