schemas

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

Overview

Name	schemas
Type	Resource
Id	google.discoveryengine.schemas

Fields

The following fields are returned by SELECT queries:

projects_locations_collections_data_stores_schemas_get

Successful response

Name	Datatype	Description
name	string	Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
jsonSchema	string	The JSON representation of the schema.
structSchema	object	The structured representation of the schema.

projects_locations_collections_data_stores_schemas_list

Successful response

Name	Datatype	Description
name	string	Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
jsonSchema	string	The JSON representation of the schema.
structSchema	object	The structured representation of the schema.

projects_locations_data_stores_schemas_get

Successful response

Name	Datatype	Description
name	string	Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
jsonSchema	string	The JSON representation of the schema.
structSchema	object	The structured representation of the schema.

projects_locations_data_stores_schemas_list

Successful response

Name	Datatype	Description
name	string	Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
jsonSchema	string	The JSON representation of the schema.
structSchema	object	The structured representation of the schema.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_data_stores_schemas_get	select	projectsId, locationsId, collectionsId, dataStoresId, schemasId		Gets a Schema.
projects_locations_collections_data_stores_schemas_list	select	projectsId, locationsId, collectionsId, dataStoresId	pageSize, pageToken	Gets a list of Schemas.
projects_locations_data_stores_schemas_get	select	projectsId, locationsId, dataStoresId, schemasId		Gets a Schema.
projects_locations_data_stores_schemas_list	select	projectsId, locationsId, dataStoresId	pageSize, pageToken	Gets a list of Schemas.
projects_locations_collections_data_stores_schemas_create	insert	projectsId, locationsId, collectionsId, dataStoresId	schemaId	Creates a Schema.
projects_locations_data_stores_schemas_create	insert	projectsId, locationsId, dataStoresId	schemaId	Creates a Schema.
projects_locations_collections_data_stores_schemas_patch	update	projectsId, locationsId, collectionsId, dataStoresId, schemasId	allowMissing	Updates a Schema.
projects_locations_data_stores_schemas_patch	update	projectsId, locationsId, dataStoresId, schemasId	allowMissing	Updates a Schema.
projects_locations_collections_data_stores_schemas_delete	delete	projectsId, locationsId, collectionsId, dataStoresId, schemasId		Deletes a Schema.
projects_locations_data_stores_schemas_delete	delete	projectsId, locationsId, dataStoresId, schemasId		Deletes a Schema.

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
collectionsId	string
dataStoresId	string
locationsId	string
projectsId	string
schemasId	string
allowMissing	boolean
pageSize	integer (int32)
pageToken	string
schemaId	string

SELECT examples

projects_locations_collections_data_stores_schemas_get

Gets a Schema.

SELECT
name,
jsonSchema,
structSchema
FROM google.discoveryengine.schemas
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND schemasId = '{{ schemasId }}' -- required;

projects_locations_collections_data_stores_schemas_list

Gets a list of Schemas.

SELECT
name,
jsonSchema,
structSchema
FROM google.discoveryengine.schemas
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

projects_locations_data_stores_schemas_get

Gets a Schema.

SELECT
name,
jsonSchema,
structSchema
FROM google.discoveryengine.schemas
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND schemasId = '{{ schemasId }}' -- required;

projects_locations_data_stores_schemas_list

Gets a list of Schemas.

SELECT
name,
jsonSchema,
structSchema
FROM google.discoveryengine.schemas
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_collections_data_stores_schemas_create

Creates a Schema.

INSERT INTO google.discoveryengine.schemas (
data__structSchema,
data__jsonSchema,
data__name,
projectsId,
locationsId,
collectionsId,
dataStoresId,
schemaId
)
SELECT 
'{{ structSchema }}',
'{{ jsonSchema }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ collectionsId }}',
'{{ dataStoresId }}',
'{{ schemaId }}'
RETURNING
name,
done,
error,
metadata,
response
;

projects_locations_data_stores_schemas_create

Creates a Schema.

INSERT INTO google.discoveryengine.schemas (
data__structSchema,
data__jsonSchema,
data__name,
projectsId,
locationsId,
dataStoresId,
schemaId
)
SELECT 
'{{ structSchema }}',
'{{ jsonSchema }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dataStoresId }}',
'{{ schemaId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: schemas
  props:
    - name: projectsId
      value: string
      description: Required parameter for the schemas resource.
    - name: locationsId
      value: string
      description: Required parameter for the schemas resource.
    - name: collectionsId
      value: string
      description: Required parameter for the schemas resource.
    - name: dataStoresId
      value: string
      description: Required parameter for the schemas resource.
    - name: structSchema
      value: object
      description: >
        The structured representation of the schema.
        
    - name: jsonSchema
      value: string
      description: >
        The JSON representation of the schema.
        
    - name: name
      value: string
      description: >
        Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
        
    - name: schemaId
      value: string

UPDATE examples

projects_locations_collections_data_stores_schemas_patch

Updates a Schema.

UPDATE google.discoveryengine.schemas
SET 
data__structSchema = '{{ structSchema }}',
data__jsonSchema = '{{ jsonSchema }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND schemasId = '{{ schemasId }}' --required
AND allowMissing = {{ allowMissing}}
RETURNING
name,
done,
error,
metadata,
response;

projects_locations_data_stores_schemas_patch

Updates a Schema.

UPDATE google.discoveryengine.schemas
SET 
data__structSchema = '{{ structSchema }}',
data__jsonSchema = '{{ jsonSchema }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND schemasId = '{{ schemasId }}' --required
AND allowMissing = {{ allowMissing}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_collections_data_stores_schemas_delete

Deletes a Schema.

DELETE FROM google.discoveryengine.schemas
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND schemasId = '{{ schemasId }}' --required;

projects_locations_data_stores_schemas_delete

Deletes a Schema.

DELETE FROM google.discoveryengine.schemas
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND schemasId = '{{ schemasId }}' --required;