deployment_resource_pools

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

Overview

Name	deployment_resource_pools
Type	Resource
Id	google.aiplatform.deployment_resource_pools

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the DeploymentResourcePool. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
createTime	string (google-datetime)	Output only. Timestamp when this DeploymentResourcePool was created.
dedicatedResources	object	Required. The underlying DedicatedResources that the DeploymentResourcePool uses. (id: GoogleCloudAiplatformV1DedicatedResources)
disableContainerLogging	boolean	If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send stderr and stdout streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to Cloud Logging pricing. User can disable container logging by setting this flag to true.
encryptionSpec	object	Customer-managed encryption key spec for a DeploymentResourcePool. If set, this DeploymentResourcePool will be secured by this key. Endpoints and the DeploymentResourcePool they deploy in need to have the same EncryptionSpec. (id: GoogleCloudAiplatformV1EncryptionSpec)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
serviceAccount	string	The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the iam.serviceAccounts.actAs permission on this service account.

query_deployed_models

Successful response

Name	Datatype	Description
deployedModelRefs	array	References to the DeployedModels that share the specified deploymentResourcePool.
deployedModels	array	DEPRECATED Use deployed_model_refs instead.
nextPageToken	string	A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
totalDeployedModelCount	integer (int32)	The total number of DeployedModels on this DeploymentResourcePool.
totalEndpointCount	integer (int32)	The total number of Endpoints that have DeployedModels on this DeploymentResourcePool.

list

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the DeploymentResourcePool. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
createTime	string (google-datetime)	Output only. Timestamp when this DeploymentResourcePool was created.
dedicatedResources	object	Required. The underlying DedicatedResources that the DeploymentResourcePool uses. (id: GoogleCloudAiplatformV1DedicatedResources)
disableContainerLogging	boolean	If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send stderr and stdout streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to Cloud Logging pricing. User can disable container logging by setting this flag to true.
encryptionSpec	object	Customer-managed encryption key spec for a DeploymentResourcePool. If set, this DeploymentResourcePool will be secured by this key. Endpoints and the DeploymentResourcePool they deploy in need to have the same EncryptionSpec. (id: GoogleCloudAiplatformV1EncryptionSpec)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
serviceAccount	string	The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the iam.serviceAccounts.actAs permission on this service account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, deploymentResourcePoolsId		Get a DeploymentResourcePool.
query_deployed_models	select	projectsId, locationsId, deploymentResourcePoolsId	pageSize, pageToken	List DeployedModels that have been deployed on this DeploymentResourcePool.
list	select	projectsId, locationsId	pageSize, pageToken	List DeploymentResourcePools in a location.
create	insert	projectsId, locationsId		Create a DeploymentResourcePool.
patch	update	projectsId, locationsId, deploymentResourcePoolsId	updateMask	Update a DeploymentResourcePool.
delete	delete	projectsId, locationsId, deploymentResourcePoolsId		Delete 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.

Name	Datatype	Description
deploymentResourcePoolsId	string
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Get a DeploymentResourcePool.

SELECT
name,
createTime,
dedicatedResources,
disableContainerLogging,
encryptionSpec,
satisfiesPzi,
satisfiesPzs,
serviceAccount
FROM google.aiplatform.deployment_resource_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deploymentResourcePoolsId = '{{ deploymentResourcePoolsId }}' -- required;

query_deployed_models

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 pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

list

List DeploymentResourcePools in a location.

SELECT
name,
createTime,
dedicatedResources,
disableContainerLogging,
encryptionSpec,
satisfiesPzi,
satisfiesPzs,
serviceAccount
FROM google.aiplatform.deployment_resource_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

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
;

Manifest

# Description fields are for documentation purposes
- name: deployment_resource_pools
  props:
    - name: projectsId
      value: string
      description: Required parameter for the deployment_resource_pools resource.
    - name: locationsId
      value: string
      description: Required parameter for the deployment_resource_pools resource.
    - name: deploymentResourcePool
      value: object
      description: >
        Required. The DeploymentResourcePool to create.
        
    - name: deploymentResourcePoolId
      value: string
      description: >
        Required. The ID to use for the DeploymentResourcePool, which will become the final component of the DeploymentResourcePool's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
        

UPDATE examples

patch

Update a DeploymentResourcePool.

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

DELETE examples

delete

Delete a DeploymentResourcePool.

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