specialist_pools

Creates, updates, deletes, gets or lists a specialist_pools resource.

Overview

Name	specialist_pools
Type	Resource
Id	google.aiplatform.specialist_pools

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Required. The resource name of the SpecialistPool.
displayName	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.
pendingDataLabelingJobs	array	Output only. The resource name of the pending data labeling jobs.
specialistManagerEmails	array	The email addresses of the managers in the SpecialistPool.
specialistManagersCount	integer (int32)	Output only. The number of managers in this SpecialistPool.
specialistWorkerEmails	array	The email addresses of workers in the SpecialistPool.

list

Successful response

Name	Datatype	Description
name	string	Required. The resource name of the SpecialistPool.
displayName	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.
pendingDataLabelingJobs	array	Output only. The resource name of the pending data labeling jobs.
specialistManagerEmails	array	The email addresses of the managers in the SpecialistPool.
specialistManagersCount	integer (int32)	Output only. The number of managers in this SpecialistPool.
specialistWorkerEmails	array	The email addresses of workers in the SpecialistPool.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, specialistPoolsId		Gets a SpecialistPool.
list	select	projectsId, locationsId	pageSize, pageToken, readMask	Lists SpecialistPools in a Location.
create	insert	projectsId, locationsId		Creates a SpecialistPool.
patch	update	projectsId, locationsId, specialistPoolsId	updateMask	Updates a SpecialistPool.
delete	delete	projectsId, locationsId, specialistPoolsId	force	Deletes a SpecialistPool as well as all Specialists in the pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
specialistPoolsId	string
force	boolean
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)
updateMask	string (google-fieldmask)

SELECT examples

get

Gets a SpecialistPool.

SELECT
name,
displayName,
pendingDataLabelingJobs,
specialistManagerEmails,
specialistManagersCount,
specialistWorkerEmails
FROM google.aiplatform.specialist_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND specialistPoolsId = '{{ specialistPoolsId }}' -- required;

list

Lists SpecialistPools in a Location.

SELECT
name,
displayName,
pendingDataLabelingJobs,
specialistManagerEmails,
specialistManagersCount,
specialistWorkerEmails
FROM google.aiplatform.specialist_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND readMask = '{{ readMask }}';

INSERT examples

create

Creates a SpecialistPool.

INSERT INTO google.aiplatform.specialist_pools (
data__name,
data__displayName,
data__specialistManagerEmails,
data__specialistWorkerEmails,
projectsId,
locationsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ specialistManagerEmails }}',
'{{ specialistWorkerEmails }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: specialist_pools
  props:
    - name: projectsId
      value: string
      description: Required parameter for the specialist_pools resource.
    - name: locationsId
      value: string
      description: Required parameter for the specialist_pools resource.
    - name: name
      value: string
      description: >
        Required. The resource name of the SpecialistPool.
        
    - name: displayName
      value: string
      description: >
        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.
        
    - name: specialistManagerEmails
      value: array
      description: >
        The email addresses of the managers in the SpecialistPool.
        
    - name: specialistWorkerEmails
      value: array
      description: >
        The email addresses of workers in the SpecialistPool.
        

UPDATE examples

patch

Updates a SpecialistPool.

UPDATE google.aiplatform.specialist_pools
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__specialistManagerEmails = '{{ specialistManagerEmails }}',
data__specialistWorkerEmails = '{{ specialistWorkerEmails }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND specialistPoolsId = '{{ specialistPoolsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a SpecialistPool as well as all Specialists in the pool.

DELETE FROM google.aiplatform.specialist_pools
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND specialistPoolsId = '{{ specialistPoolsId }}' --required
AND force = '{{ force }}';