Method: projects.locations.dataStores.branches.documents.list

Obtiene una lista de Documents.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Nombre de recurso de la rama superior, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Usa default_branch como ID de rama para mostrar los documentos de la rama predeterminada.

Si la persona que llama no tiene permiso para enumerar Documents en esta rama, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Los parámetros de consulta

Parámetros
pageSize

integer

Número máximo de Documents que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1000. Los valores superiores a 1000 se establecen en 1000.

Si este campo es negativo, se devuelve un error INVALID_ARGUMENT.
pageToken

string

Un token de página ListDocumentsResponse.next_page_token, recibido de una llamada DocumentService.ListDocuments anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a DocumentService.ListDocuments deben ser los mismos que aparecen en la llamada que proporcionó el token de la página. De lo contrario, se devuelve un error INVALID_ARGUMENT.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, en el cuerpo de la respuesta se incluye una instancia de ListDocumentsResponse.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.documents.list

Para obtener más información, consulta la documentación de gestión de identidades y accesos.