metadata_stores

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

Overview

Name	metadata_stores
Type	Resource
Id	google.aiplatform.metadata_stores

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the MetadataStore instance.
createTime	string (google-datetime)	Output only. Timestamp when this MetadataStore was created.
dataplexConfig	object	Optional. Dataplex integration settings. (id: GoogleCloudAiplatformV1MetadataStoreDataplexConfig)
description	string	Description of the MetadataStore.
encryptionSpec	object	Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
state	object	Output only. State information of the MetadataStore. (id: GoogleCloudAiplatformV1MetadataStoreMetadataStoreState)
updateTime	string (google-datetime)	Output only. Timestamp when this MetadataStore was last updated.

list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the MetadataStore instance.
createTime	string (google-datetime)	Output only. Timestamp when this MetadataStore was created.
dataplexConfig	object	Optional. Dataplex integration settings. (id: GoogleCloudAiplatformV1MetadataStoreDataplexConfig)
description	string	Description of the MetadataStore.
encryptionSpec	object	Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
state	object	Output only. State information of the MetadataStore. (id: GoogleCloudAiplatformV1MetadataStoreMetadataStoreState)
updateTime	string (google-datetime)	Output only. Timestamp when this MetadataStore was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, metadataStoresId		Retrieves a specific MetadataStore.
list	select	projectsId, locationsId	pageSize, pageToken	Lists MetadataStores for a Location.
create	insert	projectsId, locationsId	metadataStoreId	Initializes a MetadataStore, including allocation of resources.
delete	delete	projectsId, locationsId, metadataStoresId	force	Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).

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
metadataStoresId	string
projectsId	string
force	boolean
metadataStoreId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Retrieves a specific MetadataStore.

SELECT
name,
createTime,
dataplexConfig,
description,
encryptionSpec,
state,
updateTime
FROM google.aiplatform.metadata_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND metadataStoresId = '{{ metadataStoresId }}' -- required;

list

Lists MetadataStores for a Location.

SELECT
name,
createTime,
dataplexConfig,
description,
encryptionSpec,
state,
updateTime
FROM google.aiplatform.metadata_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Initializes a MetadataStore, including allocation of resources.

INSERT INTO google.aiplatform.metadata_stores (
data__encryptionSpec,
data__description,
data__dataplexConfig,
projectsId,
locationsId,
metadataStoreId
)
SELECT 
'{{ encryptionSpec }}',
'{{ description }}',
'{{ dataplexConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ metadataStoreId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: metadata_stores
  props:
    - name: projectsId
      value: string
      description: Required parameter for the metadata_stores resource.
    - name: locationsId
      value: string
      description: Required parameter for the metadata_stores resource.
    - name: encryptionSpec
      value: object
      description: >
        Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key.
        
    - name: description
      value: string
      description: >
        Description of the MetadataStore.
        
    - name: dataplexConfig
      value: object
      description: >
        Optional. Dataplex integration settings.
        
    - name: metadataStoreId
      value: string

DELETE examples

delete

Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).

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