Method: indexing.datasources.items.push

Przekazuje element do kolejki na potrzeby późniejszego odpytywania i aktualizowania.

Ten interfejs API wymaga do działania konta administratora lub konta usługi. Używane konto usługi jest kontem umieszczonym na białej liście w odpowiednim źródle danych.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
item.name

string

Nazwa obiektu item, który ma zostać przekazany do kolejki indeksowania.

Format: źródła danych/{sourceId}/items/{ID}

To pole jest wymagane. Maksymalna długość wynosi 1536 znaków.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis 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)
  }
}
Pola
item.type

enum (PushItem.Type)

Typ operacji push, która określa działanie tej operacji.
item.metadataHash

string

Hasz metadanych elementu zgodnie z informacjami z repozytorium. Jeśli zostanie określony, będzie służyć do określania sposobu zmiany stanu elementu. Ustawienie tego pola oraz pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
item.structuredDataHash

string

Skrót uporządkowanych danych elementu zgodnie z repozytorium. Jeśli zostanie określony, będzie służyć do określania sposobu zmiany stanu elementu. Ustawienie tego pola oraz pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
item.contentHash

string

Skrót zawartości elementu zgodnie z repozytorium. Jeśli zostanie określony, będzie służyć do określania sposobu zmiany stanu elementu. Ustawienie tego pola oraz pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
item.payload

string (bytes format)

Zawiera dodatkowe informacje o stanie dokumentów oprogramowania sprzęgającego, takie jak alternatywny identyfikator repozytorium i inne metadane. Maksymalna długość to 8192 bajty.

Ciąg zakodowany w formacie base64.
item.queue

string

Kolejka, do której należy ten element. Jeśli to pole nie jest określone, zostanie wybrana kolejka default. Maksymalna długość to 512 znaków.
item.repositoryError

object (RepositoryError)

Wypełnij to pole, aby zapisać szczegóły błędu oprogramowania sprzęgającego lub repozytorium. Te informacje są wyświetlane w konsoli administracyjnej. To pole można wypełniać tylko wtedy, gdy type ma wartość REPOSITORY_ERROR.
connectorName

string

Nazwa oprogramowania sprzęgającego tworzącego to wywołanie.

Format: źródła danych/{sourceId}/łączniki/{ID}
debugOptions

object (DebugOptions)

Typowe opcje debugowania.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Item.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.

PushItem

Reprezentuje element, który ma zostać przekazany do kolejki indeksowania.

Zapis JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Pola
name

string

Nazwa obiektu item, który ma zostać przekazany do kolejki indeksowania.

Format: źródła danych/{sourceId}/items/{ID}

To pole jest wymagane. Maksymalna długość wynosi 1536 znaków.
type

enum (PushItem.Type)

Typ operacji push, która określa działanie tej operacji.
metadataHash

string

Hasz metadanych elementu zgodnie z informacjami z repozytorium. Jeśli zostanie określony, będzie służyć do określania sposobu zmiany stanu elementu. Ustawienie tego pola oraz pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
structuredDataHash

string

Skrót uporządkowanych danych elementu zgodnie z repozytorium. Jeśli zostanie określony, będzie służyć do określania sposobu zmiany stanu elementu. Ustawienie tego pola oraz pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
contentHash

string

Skrót zawartości elementu zgodnie z repozytorium. Jeśli zostanie określony, będzie służyć do określania sposobu zmiany stanu elementu. Ustawienie tego pola oraz pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
payload

string (bytes format)

Zawiera dodatkowe informacje o stanie dokumentów oprogramowania sprzęgającego, takie jak alternatywny identyfikator repozytorium i inne metadane. Maksymalna długość to 8192 bajty.

Ciąg zakodowany w formacie base64.
queue

string

Kolejka, do której należy ten element. Jeśli to pole nie jest określone, zostanie wybrana kolejka default. Maksymalna długość to 512 znaków.
repositoryError

object (RepositoryError)

Wypełnij to pole, aby zapisać szczegóły błędu oprogramowania sprzęgającego lub repozytorium. Te informacje są wyświetlane w konsoli administracyjnej. To pole można wypełniać tylko wtedy, gdy type ma wartość REPOSITORY_ERROR.

PushItem.Type

Typ operacji push, która określa działanie tej operacji.

Wartości w polu enum
UNSPECIFIED Domyślna wartość: UNSPECIFIED. Określa, że operacja push nie powinna modyfikować ItemStatus
MODIFIED Wskazuje, że dokument repozytorium został zmodyfikowany lub zaktualizowany od poprzedniego wywołania update. Spowoduje to zmianę stanu istniejącego elementu na MODIFIED. Jeśli ta funkcja zostanie wywołana w przypadku nieistniejącego elementu, stan zostanie zmieniony na NEW_ITEM.
NOT_MODIFIED Element w repozytorium nie został zmodyfikowany od ostatniego wywołania aktualizacji. Ta operacja push ustawi stan ACCEPTED.
REPOSITORY_ERROR Oprogramowanie sprzęgające napotka błąd repozytorium dotyczący tego elementu. Zmień stan na REPOSITORY_ERROR. Element nie został zarezerwowany i przesunięto na późniejszy termin, który zależy od rosnącego wykładniczego czasu do ponowienia.
REQUEUE Wywołaj polecenie push z poleceniem REQUEUE tylko w przypadku elementów, które zostały zarezerwowane. To działanie spowoduje anulowanie rezerwacji elementu i przywrócenie jego dostępności do zegara ściennego.