Method: projects.locations.dataStores.branches.documents.patch
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://discoveryengine.googleapis.com/v1alpha/{document.name=projects/*/locations/*/dataStores/*/branches/*/documents/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
document.name |
string
Immutable. The full resource name of the document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}. 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 Document is not found, a new Document is be created.
|
updateMask |
string (FieldMask format)
Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
|
Request body
The request body contains an instance of Document.
Response body
If successful, the response body contains an instance of Document.
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.documents.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 page details how to update a Document resource via a PATCH HTTP request to the Google Discovery Engine API."],["The request URL requires a `document.name` path parameter, following a specific format that includes the project, location, data store, branch, and document ID."],["Query parameters `allowMissing` and `updateMask` allow for optional behavior, including creating a document if it doesn't exist and specifying which document fields to update."],["The request and response bodies both use the Document resource, and successful requests return the updated Document resource."],["Updating a document requires the `discoveryengine.documents.update` IAM permission and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
