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

Obtém uma lista de Documents.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso da ramificação principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Use default_branch como ID da filial para listar documentos na filial predefinida.

Se o autor da chamada não tiver autorização para listar Documents nesta ramificação, independentemente de esta ramificação existir ou não, é devolvido um erro PERMISSION_DENIED.

Parâmetros de consulta

Parâmetros
pageSize

integer

Número máximo de Documents a devolver. Se não for especificado, a predefinição é 100. O valor máximo permitido é 1000. Os valores superiores a 1000 são definidos como 1000.

Se este campo for negativo, é devolvido um erro INVALID_ARGUMENT.
pageToken

string

Um token de página ListDocumentsResponse.next_page_token, recebido de uma chamada DocumentService.ListDocuments anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a DocumentService.ListDocuments têm de corresponder à chamada que forneceu o token da página. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de ListDocumentsResponse.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.documents.list

Para mais informações, consulte a documentação do IAM.