Skip to main content

persistent_resources

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

Overview​

Namepersistent_resources
TypeResource
Idgoogle.aiplatform.persistent_resources

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringImmutable. Resource name of a PersistentResource.
createTimestring (google-datetime)Output only. Time when the PersistentResource was created.
displayNamestringOptional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpecobjectOptional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
errorobjectThe Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. (id: GoogleRpcStatus)
labelsobjectOptional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
networkstringOptional. The full name of the Compute Engine network to peered with Vertex AI to host the persistent resources. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the resources aren't peered with any network.
pscInterfaceConfigobjectOptional. Configuration for PSC-I for PersistentResource. (id: GoogleCloudAiplatformV1PscInterfaceConfig)
reservedIpRangesarrayOptional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
resourcePoolsarrayRequired. The spec of the pools of different resources.
resourceRuntimeobjectOutput only. Runtime information of the Persistent Resource. (id: GoogleCloudAiplatformV1ResourceRuntime)
resourceRuntimeSpecobjectOptional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. (id: GoogleCloudAiplatformV1ResourceRuntimeSpec)
satisfiesPzibooleanOutput only. Reserved for future use.
satisfiesPzsbooleanOutput only. Reserved for future use.
startTimestring (google-datetime)Output only. Time when the PersistentResource for the first time entered the RUNNING state.
statestringOutput only. The detailed state of a Study.
updateTimestring (google-datetime)Output only. Time when the PersistentResource was most recently updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, persistentResourcesIdGets a PersistentResource.
listselectprojectsId, locationsIdpageSize, pageTokenLists PersistentResources in a Location.
createinsertprojectsId, locationsIdpersistentResourceIdCreates a PersistentResource.
patchupdateprojectsId, locationsId, persistentResourcesIdupdateMaskUpdates a PersistentResource.
deletedeleteprojectsId, locationsId, persistentResourcesIdDeletes a PersistentResource.
rebootexecprojectsId, locationsId, persistentResourcesIdReboots a PersistentResource.

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
locationsIdstring
persistentResourcesIdstring
projectsIdstring
pageSizeinteger (int32)
pageTokenstring
persistentResourceIdstring
updateMaskstring (google-fieldmask)

SELECT examples​

Gets a PersistentResource.

SELECT
name,
createTime,
displayName,
encryptionSpec,
error,
labels,
network,
pscInterfaceConfig,
reservedIpRanges,
resourcePools,
resourceRuntime,
resourceRuntimeSpec,
satisfiesPzi,
satisfiesPzs,
startTime,
state,
updateTime
FROM google.aiplatform.persistent_resources
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND persistentResourcesId = '{{ persistentResourcesId }}' -- required;

INSERT examples​

Creates a PersistentResource.

INSERT INTO google.aiplatform.persistent_resources (
data__name,
data__displayName,
data__resourcePools,
data__labels,
data__network,
data__pscInterfaceConfig,
data__encryptionSpec,
data__resourceRuntimeSpec,
data__reservedIpRanges,
projectsId,
locationsId,
persistentResourceId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ resourcePools }}',
'{{ labels }}',
'{{ network }}',
'{{ pscInterfaceConfig }}',
'{{ encryptionSpec }}',
'{{ resourceRuntimeSpec }}',
'{{ reservedIpRanges }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ persistentResourceId }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Updates a PersistentResource.

UPDATE google.aiplatform.persistent_resources
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__resourcePools = '{{ resourcePools }}',
data__labels = '{{ labels }}',
data__network = '{{ network }}',
data__pscInterfaceConfig = '{{ pscInterfaceConfig }}',
data__encryptionSpec = '{{ encryptionSpec }}',
data__resourceRuntimeSpec = '{{ resourceRuntimeSpec }}',
data__reservedIpRanges = '{{ reservedIpRanges }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND persistentResourcesId = '{{ persistentResourcesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Deletes a PersistentResource.

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

Lifecycle Methods​

Reboots a PersistentResource.

EXEC google.aiplatform.persistent_resources.reboot 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@persistentResourcesId='{{ persistentResourcesId }}' --required;