REST Resource: projects.locations.dataStores.schemas

Resource: Schema

Defines the structure and layout of a type of document data.

JSON representation
{
  "name": string,

  // Union field schema can be only one of the following:
  "structSchema": {
    object
  },
  "jsonSchema": string
  // End of list of possible types for union field schema.
}
Fields
name

string

Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/schemas/{schema}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Union field schema. Schema representation. One of struct_schema or json_schema should be provided otherwise an INVALID_ARGUMENT error is thrown. schema can be only one of the following:
structSchema

object (Struct format)

The structured representation of the schema.

jsonSchema

string

The JSON representation of the schema.

Methods

create

Creates a Schema.

delete

Deletes a Schema.

get

Gets a Schema.

list

Gets a list of Schemas.

patch

Updates a Schema.