REST Resource: projects.locations.dataStores.schemas
bookmark_borderbookmark
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Schema
Defines the structure and layout of a type of document data.
| JSON representation |
{
"name": string,
"fieldConfigs": [
{
object (FieldConfig)
}
],
// 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.
|
fieldConfigs[] |
object (FieldConfig)
Output only. Configurations for fields of the schema.
|
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["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-03-03 UTC."],[[["A Schema defines the structure and layout of a specific type of document data."],["Schemas can be represented in JSON format, including a name and an array of field configurations."],["The schema data is defined in one of two fields: `structSchema` using a structured format, or `jsonSchema` using a raw string format."],["Schemas can be managed through several methods including creation, deletion, retrieval, listing, and updating."],["Schemas are identified by a resource name in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/schemas/{schema}`, with the name being immutable."]]],[]]
