Method: indexing.datasources.items.push

Envia um item para uma fila para pesquisa e atualização posteriores.

Esta API requer uma conta de administrador ou de serviço para ser executada. A conta de serviço usada 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: fontes de dados/{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 de operação de push que define o comportamento de 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 este campo e o campo type resulta em erro de argumento. O tamanho 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 este campo e o campo type resulta em erro de argumento. O tamanho 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 este campo e o campo type resulta em erro de argumento. O tamanho máximo é de 2.048 caracteres.
item.payload

string (bytes format)

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

Uma string codificada em base64.
item.queue

string

Fila a que este 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 esse campo para armazenar detalhes de erro 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 está fazendo a chamada.

Formato: fontes de dados/{sourceId}/connectors/{ID}
debugOptions

object (DebugOptions)

Opções comuns de depuração.

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: fontes de dados/{sourceId}/items/{ID}

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

enum (PushItem.Type)

O tipo de operação de push que define o comportamento de 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 este campo e o campo type resulta em erro de argumento. O tamanho 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 erro de argumento. O tamanho 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 erro de argumento. O tamanho máximo é de 2.048 caracteres.
payload

string (bytes format)

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

Uma string codificada em base64.
queue

string

Fila a que este 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 esse campo para armazenar detalhes de erro 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 de operação de push que define o comportamento de push.

Enums
UNSPECIFIED Padrão UNSPECIFIED. Especifica que a operação de push não pode modificar ItemStatus
MODIFIED Indica que o documento do repositório foi modificado ou atualizado desde a chamada update anterior. Isso muda o status de um item atual para MODIFIED. Se ele for chamado em um item não existente, 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. Esta operação de push definirá o status para o estado ACCEPTED.
REPOSITORY_ERROR O conector está com um erro de repositório relacionado a este item. Mudar o status para o estado REPOSITORY_ERROR. O item não será reservado e será remarcado em um horário futuro determinado pela espera exponencial.
REQUEUE Chamar push com REQUEUE apenas para itens que foram reservados. Essa ação cancela a reserva do item e redefine o tempo disponível para o horário convencional.