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

Gets a Document.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}.

If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested Document does not exist, a NOT_FOUND error is returned.

Request body

The request body must be empty.

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.get

For more information, see the IAM documentation.