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

Exclui permanentemente todos os Documents selecionados em uma ramificação.

Esse processo é assíncrono. Dependendo do número de Documents a serem excluídos, essa operação pode levar horas para ser concluída. Antes da conclusão da operação de exclusão, alguns Documents ainda podem ser retornados por DocumentService.GetDocument ou DocumentService.ListDocuments.

Para receber uma lista dos Documents a serem excluídos, defina PurgeDocumentsRequest.force como "false".

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso pai, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "filter": string,
  "errorConfig": {
    object (PurgeErrorConfig)
  },
  "force": boolean,

  // Union field source can be only one of the following:
  "gcsSource": {
    object (GcsSource)
  },
  "inlineSource": {
    object (InlineSource)
  }
  // End of list of possible types for union field source.
}
Campos
filter

string

Obrigatório. Filtre os documentos correspondentes para excluir permanentemente. O único valor aceito no momento é * (todos os itens).
errorConfig

object (PurgeErrorConfig)

O local desejado dos erros ocorridos durante a limpeza.
force

boolean

Realiza a limpeza. Se force for definido como "false", retorne a contagem de limpeza esperada sem excluir documentos.
Campo de união source. A origem de entrada desejada para a exclusão de documentos com base nos IDs. source pode ser apenas de um dos tipos a seguir:
gcsSource

object (GcsSource)

Local do Cloud Storage para o conteúdo de entrada. dataSchema compatíveis: * documentId: um Document.id válido por linha.
inlineSource

object (InlineSource)

Origem inline do conteúdo de entrada para remoção.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.documents.purge

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