Method: indexing.datasources.items.push

Przesyła element do kolejki w celu późniejszego odczytu i aktualizacji.

Do wykonania tej operacji wymagane jest konto administratora lub konto usługi. Używane konto usługi to to, które znajduje się 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 item, którą chcesz dodać do kolejki indeksowania.

Format: datasources/{sourceId}/items/{ID}

To pole jest wymagane. Maksymalna długość to 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 zachowanie push.
item.metadataHash

string

Hasz metadanych elementu według repozytorium. Jeśli jest podany, służy do określenia sposobu modyfikacji stanu tego elementu. Ustawienie tego pola i pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
item.structuredDataHash

string

Hasz uporządkowanych danych elementu zgodnie z repozytorium. Jeśli jest podany, służy do określenia sposobu modyfikacji stanu tego elementu. Ustawienie tego pola i pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
item.contentHash

string

Hasz treści elementu według repozytorium. Jeśli jest podany, służy do określenia sposobu modyfikacji stanu tego elementu. Ustawienie tego pola i pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
item.payload

string (bytes format)

Zawiera dodatkowe informacje o stanie dokumentu dla danego łącznika, takie jak alternatywny identyfikator repozytorium i inne metadane. Maksymalna długość to 8192 bajtów.

Ciąg znaków zakodowany w formacie Base64.
item.queue

string

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

object (RepositoryError)

Wypełnij to pole, aby przechowywać szczegóły błędów w połączeniu lub repozytorium. Te informacje są wyświetlane w konsoli administracyjnej. To pole może być wypełnione tylko wtedy, gdy type ma wartość REPOSITORY_ERROR.
connectorName

string

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

Format: datasources/{sourceId}/connectors/{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 OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.

PushItem

Reprezentuje element, który ma zostać przesłany 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 item, którą chcesz dodać do kolejki indeksowania.

Format: datasources/{sourceId}/items/{ID}

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

enum (PushItem.Type)

Typ operacji push, która określa zachowanie push.
metadataHash

string

Hasz metadanych elementu według repozytorium. Jeśli jest podany, służy do określenia sposobu modyfikacji stanu tego elementu. Ustawienie tego pola i pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
structuredDataHash

string

Hasz uporządkowanych danych elementu zgodnie z repozytorium. Jeśli jest określony, służy do określenia sposobu modyfikacji stanu tego elementu. Ustawienie tego pola i pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
contentHash

string

Hasz treści elementu według repozytorium. Jeśli jest podany, służy do określenia sposobu modyfikacji stanu tego elementu. Ustawienie tego pola i pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
payload

string (bytes format)

Zawiera dodatkowe informacje o stanie dokumentu dla danego łącznika, takie jak alternatywny identyfikator repozytorium i inne metadane. Maksymalna długość to 8192 bajtów.

Ciąg znaków zakodowany w formacie Base64.
queue

string

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

object (RepositoryError)

Wypełnij to pole, aby przechowywać szczegóły błędów w połączeniu lub repozytorium. Te informacje są wyświetlane w konsoli administracyjnej. To pole może być wypełnione tylko wtedy, gdy type ma wartość REPOSITORY_ERROR.

PushItem.Type

Typ operacji push, która określa zachowanie push.

Wartości w polu enum
UNSPECIFIED Domyślnie UNSPECIFIED. Określa, że operacja push nie powinna modyfikować ItemStatus
MODIFIED Wskazuje, że dokument repozytorium został zmodyfikowany lub zaktualizowany od czasu poprzedniego wywołania funkcji update. W ten sposób zmienisz stan istniejącego elementu na MODIFIED. Jeśli metoda jest wywoływana w przypadku elementu, którego nie ma, stan zmienia się na NEW_ITEM.
NOT_MODIFIED Od ostatniego wywołania funkcji aktualizacji element w repozytorium nie został zmodyfikowany. Ta operacja push spowoduje ustawienie stanu na ACCEPTED.
REPOSITORY_ERROR W przypadku tego elementu wystąpił błąd repozytorium. Zmień stan na REPOSITORY_ERROR. Element jest odrezerwowany i zaplanowany na przyszłość zgodnie ze wzrastającym czasem do ponowienia.
REQUEUE Wywołania push z opcją DODAĆ DO KOLEJKI tylko w przypadku zarezerwowanych elementów. To działanie powoduje anulowanie rezerwacji i zresetowanie czasu dostępności do czasu zegara.