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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eA Schema defines the structure and layout of a specific type of document data.\u003c/p\u003e\n"],["\u003cp\u003eSchemas can be represented in JSON format, with fields for \u003ccode\u003ename\u003c/code\u003e and a union field \u003ccode\u003eschema\u003c/code\u003e that can be either a \u003ccode\u003estructSchema\u003c/code\u003e (object) or a \u003ccode\u003ejsonSchema\u003c/code\u003e (string).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e field in a Schema represents the full resource name of the schema, and must be a UTF-8 encoded string within a limit of 1024 characters.\u003c/p\u003e\n"],["\u003cp\u003eAvailable methods for Schemas include \u003ccode\u003ecreate\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e, and \u003ccode\u003epatch\u003c/code\u003e, allowing for the creation, removal, retrieval, listing, and updating of Schemas.\u003c/p\u003e\n"]]],[],null,["# REST Resource: projects.locations.dataStores.schemas\n\n- [Resource: Schema](#Schema)\n - [JSON representation](#Schema.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Schema\n----------------\n\nDefines the structure and layout of a type of document data."]]
