Method: indexing.datasources.items.push

Помещает элемент в очередь для последующего опроса и обновления.

Для выполнения этого API требуется учетная запись администратора или службы. Используемая учетная запись службы находится в белом списке соответствующего источника данных.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
item.name

string

Имя item , помещаемого в очередь индексирования.

Формат: источники данных/{sourceId}/items/{ID}

Это обязательное поле. Максимальная длина — 1536 символов.

Тело запроса

Тело запроса содержит данные следующей структуры:

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)
  }
}
Поля
item.type

enum ( PushItem.Type )

Тип операции отправки, определяющий поведение отправки.

item.metadataHash

string

Хэш метаданных элемента согласно репозиторию. Если указано, это используется для определения того, как изменить статус этого элемента. Установка этого поля и поля type приводит к ошибке аргумента. Максимальная длина — 2048 символов.

item.structuredDataHash

string

Структурированный хеш данных элемента согласно репозиторию. Если указано, это используется для определения того, как изменить статус этого элемента. Установка этого поля и поля type приводит к ошибке аргумента. Максимальная длина — 2048 символов.

item.contentHash

string

Хэш содержимого элемента согласно репозиторию. Если указано, это используется для определения того, как изменить статус этого элемента. Установка этого поля и поля type приводит к ошибке аргумента. Максимальная длина — 2048 символов.

item.payload

string ( bytes format)

Предоставляет дополнительную информацию о состоянии документа для соединителя, такую ​​как идентификатор альтернативного репозитория и другие метаданные. Максимальная длина — 8192 байта.

Строка в кодировке Base64.

item.queue

string

Очередь, к которой принадлежит этот элемент. Очередь default выбирается, если это поле не указано. Максимальная длина — 512 символов.

item.repositoryError

object ( RepositoryError )

Заполните это поле, чтобы сохранить сведения об ошибках соединителя или репозитория. Эта информация отображается в консоли администратора. Это поле может быть заполнено только в том случае, если type REPOSITORY_ERROR .

connectorName

string

Имя соединителя, выполняющего этот вызов.

Формат: источники данных/{sourceId}/коннекторы/{ID}

debugOptions

object ( DebugOptions )

Общие параметры отладки.

Тело ответа

В случае успеха тело ответа содержит экземпляр Item .

Области авторизации

Требуется одна из следующих областей OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .

Пушитем

Представляет элемент, который необходимо поместить в очередь индексирования.

JSON-представление 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Поля
name

string

Имя item , помещаемого в очередь индексирования.

Формат: источники данных/{sourceId}/items/{ID}

Это обязательное поле. Максимальная длина — 1536 символов.

type

enum ( PushItem.Type )

Тип операции отправки, определяющий поведение отправки.

metadataHash

string

Хэш метаданных элемента согласно репозиторию. Если указано, это используется для определения того, как изменить статус этого элемента. Установка этого поля и поля type приводит к ошибке аргумента. Максимальная длина — 2048 символов.

structuredDataHash

string

Структурированный хеш данных элемента согласно репозиторию. Если указано, это используется для определения того, как изменить статус этого элемента. Установка этого поля и поля type приводит к ошибке аргумента. Максимальная длина — 2048 символов.

contentHash

string

Хэш содержимого элемента согласно репозиторию. Если указано, это используется для определения того, как изменить статус этого элемента. Установка этого поля и поля type приводит к ошибке аргумента. Максимальная длина — 2048 символов.

payload

string ( bytes format)

Предоставляет дополнительную информацию о состоянии документа для соединителя, такую ​​как идентификатор альтернативного репозитория и другие метаданные. Максимальная длина — 8192 байта.

Строка в кодировке Base64.

queue

string

Очередь, к которой принадлежит этот элемент. Очередь default выбирается, если это поле не указано. Максимальная длина — 512 символов.

repositoryError

object ( RepositoryError )

Заполните это поле, чтобы сохранить сведения об ошибках соединителя или репозитория. Эта информация отображается в консоли администратора. Это поле может быть заполнено только в том случае, если type REPOSITORY_ERROR .

PushItem.Type

Тип операции отправки, определяющий поведение отправки.

Перечисления
UNSPECIFIED По умолчанию НЕ ОПРЕДЕЛЕНО. Указывает, что операция push не должна изменять ItemStatus
MODIFIED Указывает, что документ репозитория был изменен или обновлен с момента предыдущего вызова update . Это меняет статус на MODIFIED для существующего элемента. Если это вызывается для несуществующего элемента, статус меняется на NEW_ITEM .
NOT_MODIFIED Элемент в репозитории не изменялся с момента последнего вызова обновления. Эта операция push установит статус в состояние ACCEPTED .
REPOSITORY_ERROR В соединителе возникла ошибка репозитория, связанная с этим элементом. Измените статус на REPOSITORY_ERROR . Элемент не зарезервирован и перенесен на будущее время, определяемое экспоненциальной отсрочкой.
REQUEUE Вызовите push-уведомление с помощью REQUEUE только для зарезервированных элементов. Это действие отменяет резервирование элемента и сбрасывает время его доступности до времени настенных часов.