Skip to main content

deployment_resource_pools

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

Overview​

Namedeployment_resource_pools
TypeResource
Idgoogle.aiplatform.deployment_resource_pools

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
deployedModelRefsarrayReferences to the DeployedModels that share the specified deploymentResourcePool.
deployedModelsarrayDEPRECATED Use deployed_model_refs instead.
nextPageTokenstringA token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
totalDeployedModelCountinteger (int32)The total number of DeployedModels on this DeploymentResourcePool.
totalEndpointCountinteger (int32)The total number of Endpoints that have DeployedModels on this DeploymentResourcePool.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
query_deployed_modelsselectprojectsId, locationsId, deploymentResourcePoolsIdpageToken, pageSizeList DeployedModels that have been deployed on this DeploymentResourcePool.
getselectprojectsId, locationsId, deploymentResourcePoolsIdGet a DeploymentResourcePool.
listselectprojectsId, locationsIdpageToken, pageSizeList DeploymentResourcePools in a location.
createinsertprojectsId, locationsIdCreate a DeploymentResourcePool.
patchupdateprojectsId, locationsId, deploymentResourcePoolsIdupdateMaskUpdate a DeploymentResourcePool.
deletedeleteprojectsId, locationsId, deploymentResourcePoolsIdDelete a DeploymentResourcePool.

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.

NameDatatypeDescription
deploymentResourcePoolsIdstring
locationsIdstring
projectsIdstring
pageSizeinteger (int32)
pageTokenstring
updateMaskstring (google-fieldmask)

SELECT examples​

List DeployedModels that have been deployed on this DeploymentResourcePool.

SELECT
deployedModelRefs,
deployedModels,
nextPageToken,
totalDeployedModelCount,
totalEndpointCount
FROM google.aiplatform.deployment_resource_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deploymentResourcePoolsId = '{{ deploymentResourcePoolsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples​

Create a DeploymentResourcePool.

INSERT INTO google.aiplatform.deployment_resource_pools (
data__deploymentResourcePool,
data__deploymentResourcePoolId,
projectsId,
locationsId
)
SELECT 
'{{ deploymentResourcePool }}',
'{{ deploymentResourcePoolId }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Update a DeploymentResourcePool.

UPDATE google.aiplatform.deployment_resource_pools
SET 
data__name = '{{ name }}',
data__dedicatedResources = '{{ dedicatedResources }}',
data__disableContainerLogging = {{ disableContainerLogging }},
data__encryptionSpec = '{{ encryptionSpec }}',
data__serviceAccount = '{{ serviceAccount }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deploymentResourcePoolsId = '{{ deploymentResourcePoolsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Delete a DeploymentResourcePool.

DELETE FROM google.aiplatform.deployment_resource_pools
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deploymentResourcePoolsId = '{{ deploymentResourcePoolsId }}' --required
;