metadata_schemas

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

Overview

Name	metadata_schemas
Type	Resource
Id	google.aiplatform.metadata_schemas

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the MetadataSchema.
createTime	string (google-datetime)	Output only. Timestamp when this MetadataSchema was created.
description	string	Description of the Metadata Schema
schema	string	Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by title in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 MetadataSchema Object
schemaType	string	The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
schemaVersion	string	The version of the MetadataSchema. The version's format must match the following regular expression: ^[0-9]+.+.+$, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.

list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the MetadataSchema.
createTime	string (google-datetime)	Output only. Timestamp when this MetadataSchema was created.
description	string	Description of the Metadata Schema
schema	string	Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by title in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 MetadataSchema Object
schemaType	string	The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
schemaVersion	string	The version of the MetadataSchema. The version's format must match the following regular expression: ^[0-9]+.+.+$, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, metadataStoresId, metadataSchemasId		Retrieves a specific MetadataSchema.
list	select	projectsId, locationsId, metadataStoresId	pageSize, pageToken, filter	Lists MetadataSchemas.
create	insert	projectsId, locationsId, metadataStoresId	metadataSchemaId	Creates a MetadataSchema.

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
metadataSchemasId	string
metadataStoresId	string
projectsId	string
filter	string
metadataSchemaId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Retrieves a specific MetadataSchema.

SELECT
name,
createTime,
description,
schema,
schemaType,
schemaVersion
FROM google.aiplatform.metadata_schemas
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND metadataStoresId = '{{ metadataStoresId }}' -- required
AND metadataSchemasId = '{{ metadataSchemasId }}' -- required;

list

Lists MetadataSchemas.

SELECT
name,
createTime,
description,
schema,
schemaType,
schemaVersion
FROM google.aiplatform.metadata_schemas
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND metadataStoresId = '{{ metadataStoresId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

INSERT examples

create

Creates a MetadataSchema.

INSERT INTO google.aiplatform.metadata_schemas (
data__schemaVersion,
data__schema,
data__schemaType,
data__description,
projectsId,
locationsId,
metadataStoresId,
metadataSchemaId
)
SELECT 
'{{ schemaVersion }}',
'{{ schema }}',
'{{ schemaType }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ metadataStoresId }}',
'{{ metadataSchemaId }}'
RETURNING
name,
createTime,
description,
schema,
schemaType,
schemaVersion
;

Manifest

# Description fields are for documentation purposes
- name: metadata_schemas
  props:
    - name: projectsId
      value: string
      description: Required parameter for the metadata_schemas resource.
    - name: locationsId
      value: string
      description: Required parameter for the metadata_schemas resource.
    - name: metadataStoresId
      value: string
      description: Required parameter for the metadata_schemas resource.
    - name: schemaVersion
      value: string
      description: >
        The version of the MetadataSchema. The version's format must match the following regular expression: `^[0-9]+.+.+$`, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
        
    - name: schema
      value: string
      description: >
        Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by `title` in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 [MetadataSchema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)
        
    - name: schemaType
      value: string
      description: >
        The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
        
      valid_values: ['METADATA_SCHEMA_TYPE_UNSPECIFIED', 'ARTIFACT_TYPE', 'EXECUTION_TYPE', 'CONTEXT_TYPE']
    - name: description
      value: string
      description: >
        Description of the Metadata Schema
        
    - name: metadataSchemaId
      value: string