Method: projects.locations.dataStores.patch

Updates a DataStore

HTTP request

PATCH https://discoveryengine.googleapis.com/v1alpha/{dataStore.name=projects/*/locations/*/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.