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

Obtiene una lista de Documents.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso de la rama principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Usa default_branch como el ID de la rama para enumerar los documentos en la rama predeterminada.

Si el emisor no tiene permiso para enumerar los Documents en esta rama, independientemente de si esta rama existe o no, se devuelve un error PERMISSION_DENIED.

Parámetros de consulta

Parámetros
pageSize

integer

Cantidad máxima de Documents que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1,000. Los valores superiores a 1,000 se establecen en 1,000.

Si este campo es negativo, se muestra un error INVALID_ARGUMENT.

pageToken

string

Un token de página ListDocumentsResponse.next_page_token, recibido desde una llamada a DocumentService.ListDocuments anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a DocumentService.ListDocuments deben coincidir con la llamada que proporcionó el token de la página. De lo contrario, se muestra un error INVALID_ARGUMENT.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ListDocumentsResponse.

Alcances de autorización

Se necesita 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 Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.documents.list

Para obtener más información, consulta la documentación de IAM.