Method: projects.locations.collections.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/*/collections/*/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 webpage details how to update a Schema using a PATCH HTTP request."],["The request URL structure is defined using gRPC Transcoding syntax, with a required `schema.name` path parameter."],["You can use the `allowMissing` query parameter to create a new Schema if one is not found."],["The request body must be an instance of a schema, while the successful response body contains an instance of an Operation."],["To successfully use the request, you will need the `discoveryengine.schemas.update` IAM permission, and the `https://www.googleapis.com/auth/cloud-platform` authorization scope."]]],[]]