Method: projects.locations.collections.dataStores.branches.documents.patch

Updates a Document.

HTTP request

PATCH https://discoveryengine.googleapis.com/v1/{document.name=projects/*/locations/*/collections/*/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 one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

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.