Method: indexing.datasources.items.push

Envia um item para uma fila e o pesquisa e atualiza mais tarde.

Essa API exige uma conta de administrador ou de serviço para ser executada. A conta de serviço usada é a que está na lista de permissões da fonte de dados correspondente.

Solicitação HTTP

POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:push

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

Parâmetros de caminho

Parâmetros
item.name

string

O nome do item a ser enviado para a fila de indexação.

Formato: datasources/{sourceId}/items/{id}

Este campo é obrigatório. O tamanho máximo é de 1.536 caracteres.

Corpo da solicitação

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

Representação JSON 
{
  "item": {
    "name": string,
    "type": enum (PushItem.Type),
    "metadataHash": string,
    "structuredDataHash": string,
    "contentHash": string,
    "payload": string,
    "queue": string,
    "repositoryError": {
      "type": enum (RepositoryError.Type),
      "httpStatusCode": integer,
      "errorMessage": string
    }
  },
  "connectorName": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Campos
item.type

enum (PushItem.Type)

O tipo da operação push que define o comportamento do push.
item.metadataHash

string

O hash de metadados do item de acordo com o repositório. Se especificado, é usado para determinar como modificar o status do item. Definir esse campo e o campo type resulta em um erro de argumento. O comprimento máximo é de 2.048 caracteres.
item.structuredDataHash

string

Hash de dados estruturados do item de acordo com o repositório. Se especificado, é usado para determinar como modificar o status do item. Definir esse campo e o campo type resulta em um erro de argumento. O comprimento máximo é de 2.048 caracteres.
item.contentHash

string

Hash de conteúdo do item de acordo com o repositório. Se especificado, é usado para determinar como modificar o status do item. Definir esse campo e o campo type resulta em um erro de argumento. O comprimento máximo é de 2.048 caracteres.
item.payload

string (bytes format)

Fornece informações adicionais sobre o estado do documento para o conector, como um ID de repositório alternativo e outros metadados. O comprimento máximo é de 8.192 bytes.

Uma string codificada em base64.
item.queue

string

Fila a que o item pertence. A fila default será escolhida se esse campo não for especificado. O tamanho máximo é de 512 caracteres.
item.repositoryError

object (RepositoryError)

Preencha este campo para armazenar detalhes de erros do conector ou do repositório. Essas informações são exibidas no Admin Console. Esse campo só pode ser preenchido quando type é REPOSITORY_ERROR.
connectorName

string

O nome do conector que faz essa chamada.

Formato: datasources/{sourceId}/connectors/{id}
debugOptions

object (DebugOptions)

Opções de depuração comuns.

Corpo da resposta

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

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

Para mais informações, consulte o guia de autorização.

PushItem

Representa um item a ser enviado para a fila de indexação.

Representação JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Campos
name

string

O nome do item a ser enviado para a fila de indexação.

Formato: datasources/{sourceId}/items/{id}

Este campo é obrigatório. O tamanho máximo é de 1.536 caracteres.
type

enum (PushItem.Type)

O tipo da operação push que define o comportamento do push.
metadataHash

string

O hash de metadados do item de acordo com o repositório. Se especificado, é usado para determinar como modificar o status do item. Definir esse campo e o campo type resulta em um erro de argumento. O comprimento máximo é de 2.048 caracteres.
structuredDataHash

string

Hash de dados estruturados do item de acordo com o repositório. Se especificado, é usado para determinar como modificar o status do item. Definir este campo e o campo type resulta em um erro de argumento. O comprimento máximo é de 2.048 caracteres.
contentHash

string

Hash de conteúdo do item de acordo com o repositório. Se especificado, é usado para determinar como modificar o status do item. Definir este campo e o campo type resulta em um erro de argumento. O comprimento máximo é de 2.048 caracteres.
payload

string (bytes format)

Fornece informações adicionais sobre o estado do documento para o conector, como um ID de repositório alternativo e outros metadados. O comprimento máximo é de 8.192 bytes.

Uma string codificada em base64.
queue

string

Fila a que o item pertence. A fila default será escolhida se esse campo não for especificado. O tamanho máximo é de 512 caracteres.
repositoryError

object (RepositoryError)

Preencha este campo para armazenar detalhes de erros do conector ou do repositório. Essas informações são exibidas no Admin Console. Esse campo só pode ser preenchido quando type é REPOSITORY_ERROR.

PushItem.Type

O tipo da operação push que define o comportamento do push.

Enums
UNSPECIFIED O padrão é UNSPECIFIED. Especifica que a operação de push não precisa modificar ItemStatus
MODIFIED Indica que o documento do repositório foi modificado ou atualizado desde a chamada update anterior. Isso muda o status para MODIFIED para um item existente. Se ele for chamado em um item que não existe, o status será alterado para NEW_ITEM.
NOT_MODIFIED O item no repositório não foi modificado desde a última chamada de atualização. Essa operação de push vai definir o status como ACCEPTED.
REPOSITORY_ERROR O conector está enfrentando um erro de repositório relacionado a este item. Mude o status para REPOSITORY_ERROR. O item é cancelado e reprogramado em um horário futuro determinado por espera exponencial.
REQUEUE Chamada de push com REQUEUE somente para itens reservados. Essa ação cancela a reserva do item e redefine o tempo disponível para o horário do relógio.