Method: projects.locations.collections.dataStores.patch
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://discoveryengine.googleapis.com/v1alpha/{dataStore.name=projects/*/locations/*/collections/*/dataStores/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
dataStore.name |
string
Immutable. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. 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 DataStore.
Response body
If successful, the response body contains an instance of DataStore.
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.dataStores.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 DataStore resource using a PATCH HTTP request to the specified URL, adhering to gRPC Transcoding syntax."],["Updating a DataStore requires specifying the `dataStore.name` path parameter, which follows a specific format including project, location, collection, and data store IDs."],["The `updateMask` query parameter is used to determine which fields within the DataStore to update, employing a comma-separated list of field names in FieldMask format."],["Both the request and response bodies contain an instance of the DataStore resource, showing the data being sent and received."],["To successfully update a DataStore, you must have the `discoveryengine.dataStores.update` IAM permission on the resource and use the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
