Method: projects.locations.dataStores.schemas.patch
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://discoveryengine.googleapis.com/v1alpha/{schema.name=projects/*/locations/*/dataStores/*/schemas/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
schema.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.
|
Query parameters
| Parameters |
allowMissing |
boolean
If set to true, and the Schema is not found, a new Schema is created. In this situation, updateMask is ignored.
|
Request body
The request body contains an instance of Schema.
Response body
If successful, the response body contains an instance of Operation.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name resource:
discoveryengine.schemas.update
For more information, see the IAM documentation.
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."],[[["This endpoint updates a Schema resource located within a specified data store."],["The HTTP request uses a `PATCH` method with a specific URL structure that follows gRPC Transcoding syntax to target the Schema by its name."],["The request requires a `schema.name` path parameter and optionally accepts an `allowMissing` query parameter to create a new Schema if one doesn't exist, while ignoring the `updateMask`."],["The request body is expected to contain an instance of a Schema, and a successful response will include an Operation instance."],["Updating the Schema requires the OAuth scope `https://www.googleapis.com/auth/cloud-platform` and the IAM permission `discoveryengine.schemas.update` on the specified resource."]]],[]]
