Method: indexing.datasources.items.push

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

Essa API requer um administrador ou uma conta de serviço para ser executada. A conta de serviço usada é a que está na lista de permissões na 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 que 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 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, será usado para determinar como modificar o status do item. Definir este campo e o campo type resulta em um erro de argumento. O tamanho máximo é de 2.048 caracteres.
item.structuredDataHash

string

O hash de dados estruturados do item de acordo com o repositório. Se especificado, será usado para determinar como modificar o status do item. Definir este campo e o campo type resulta em um 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, será usado para determinar como modificar o status do item. Definir este campo e o campo type resulta em um 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 para o conector, como um ID alternativo do repositório 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 os detalhes do erro do conector ou do repositório. Essas informações são exibidas no Admin Console. Esse campo só pode ser preenchido quando type for REPOSITORY_ERROR.
connectorName

string

O nome do conector que está fazendo a 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 de 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 que 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 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, será usado para determinar como modificar o status do item. Definir este campo e o campo type resulta em um erro de argumento. O tamanho máximo é de 2.048 caracteres.
structuredDataHash

string

O hash de dados estruturados do item de acordo com o repositório. Se especificado, será usado para determinar como modificar o status do item. Definir este campo e o campo type resulta em um 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, será usado para determinar como modificar o status do item. Definir este campo e o campo type resulta em um erro de argumento. O tamanho 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 alternativo do repositório 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 os detalhes do erro do conector ou do repositório. Essas informações são exibidas no Admin Console. Esse campo só pode ser preenchido quando type for 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 para o estado MODIFIED. Se ele for chamado em um item que não existe, o status vai mudar 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 vai definir o status para o estado ACCEPTED.
REPOSITORY_ERROR O conector está enfrentando um erro de repositório relacionado a este item. Altera o status para o estado REPOSITORY_ERROR. A reserva do item foi cancelada e o item foi reprogramado em um momento futuro determinado pela espera exponencial.
REQUEUE Envie por push com REQUEUE apenas os itens que foram reservados. Esta ação cancela a reserva do item e redefine seu horário disponível para o horário real.