Method: projects.locations.dataStores.branches.batchGetDocumentsMetadata

Gets index freshness metadata for Documents. Supported for website search only.

HTTP request

GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/batchGetDocumentsMetadata

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}.

Query parameters

Parameters
matcher

object (Matcher)

Required. Matcher for the Documents.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of BatchGetDocumentsMetadataResponse.

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 parent resource:

  • discoveryengine.documents.batchGetDocumentsMetadata

For more information, see the IAM documentation.