Method: indexing.datasources.items.push

Bir öğeyi daha sonra yoklama ve güncelleme için sıraya aktarır.

Bu API'nin yürütülebilmesi için yönetici veya hizmet hesabı gerekir. Kullanılan hizmet hesabı, ilgili veri kaynağında beyaz listeye eklenen hesaptır.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
item.name

string

Dizine ekleme sırasına aktarılacak item öğesinin adı.

Biçim: veri kaynakları/{kaynakKimliği}/öğeler/{Kimlik}

Bu alanının doldurulması zorunludur. Maksimum uzunluk 1536 karakterdir.

İstek içeriği

İstek gövdesi, aşağıdaki yapıyla birlikte veriler içerir:

JSON gösterimi 
{
  "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)
  }
}
Alanlar
item.type

enum (PushItem.Type)

İtme davranışını tanımlayan aktarma işleminin türü.
item.metadataHash

string

Depoya göre öğenin meta veri karması. Belirtilmişse bu öğe, durumunun nasıl değiştirileceğini belirlemek için kullanılır. Bu ve type alanının ayarlanması bağımsız değişken hatasına neden olur. Maksimum uzunluk 2048 karakterdir.
item.structuredDataHash

string

Depoya göre öğenin yapılandırılmış veri karması. Belirtilmişse bu öğe, durumunun nasıl değiştirileceğini belirlemek için kullanılır. Bu ve type alanının ayarlanması bağımsız değişken hatasına neden olur. Maksimum uzunluk 2048 karakterdir.
item.contentHash

string

Depoya göre öğenin içerik karma değeri. Belirtilmişse bu öğe, durumunun nasıl değiştirileceğini belirlemek için kullanılır. Bu ve type alanının ayarlanması bağımsız değişken hatasına neden olur. Maksimum uzunluk 2048 karakterdir.
item.payload

string (bytes format)

Bağlayıcı için alternatif depo kimliği ve diğer meta veriler gibi ek belge durumu bilgileri sağlar. Maksimum uzunluk 8.192 bayttır.

Base64 olarak kodlanmış bir dize.
item.queue

string

Bu öğenin ait olduğu sıra. Bu alan belirtilmezse default sırası seçilir. Maksimum uzunluk 512 karakterdir.
item.repositoryError

object (RepositoryError)

Bağlayıcı veya depo hata ayrıntılarını depolamak için bu alanı doldurun. Bu bilgiler Yönetici Konsolu'nda gösterilir. Bu alan yalnızca type REPOSITORY_ERROR olduğunda doldurulabilir.
connectorName

string

Bu çağrıyı yapan bağlayıcının adı.

Biçim: veri kaynakları/{kaynakKimliği}/bağlayıcılar/{Kimlik}
debugOptions

object (DebugOptions)

Yaygın hata ayıklama seçenekleri.

Yanıt gövdesi

Başarılıysa yanıt metni, Item öğesinin bir örneğini içerir.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzuna göz atın.

PushItem

Dizine ekleme sırasına aktarılacak bir öğeyi temsil eder.

JSON gösterimi 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Alanlar
name

string

Dizine ekleme sırasına aktarılacak item öğesinin adı.

Biçim: veri kaynakları/{kaynakKimliği}/öğeler/{Kimlik}

Bu alanının doldurulması zorunludur. Maksimum uzunluk 1536 karakterdir.
type

enum (PushItem.Type)

İtme davranışını tanımlayan aktarma işleminin türü.
metadataHash

string

Depoya göre öğenin meta veri karması. Belirtilmişse bu öğe, durumunun nasıl değiştirileceğini belirlemek için kullanılır. Bu ve type alanının ayarlanması bağımsız değişken hatasına neden olur. Maksimum uzunluk 2048 karakterdir.
structuredDataHash

string

Depoya göre öğenin yapılandırılmış veri karması. Belirtilmişse bu öğe, durumunun nasıl değiştirileceğini belirlemek için kullanılır. Bu ve type alanının ayarlanması bağımsız değişken hatasına neden olur. Maksimum uzunluk 2048 karakterdir.
contentHash

string

Depoya göre öğenin içerik karma değeri. Belirtilmişse bu öğe, durumunun nasıl değiştirileceğini belirlemek için kullanılır. Bu ve type alanının ayarlanması bağımsız değişken hatasına neden olur. Maksimum uzunluk 2048 karakterdir.
payload

string (bytes format)

Bağlayıcı için alternatif depo kimliği ve diğer meta veriler gibi ek belge durumu bilgileri sağlar. Maksimum uzunluk 8.192 bayttır.

Base64 olarak kodlanmış bir dize.
queue

string

Bu öğenin ait olduğu sıra. Bu alan belirtilmezse default sırası seçilir. Maksimum uzunluk 512 karakterdir.
repositoryError

object (RepositoryError)

Bağlayıcı veya depo hata ayrıntılarını depolamak için bu alanı doldurun. Bu bilgiler Yönetici Konsolu'nda gösterilir. Bu alan yalnızca type REPOSITORY_ERROR olduğunda doldurulabilir.

PushItem.Type

İtme davranışını tanımlayan aktarma işleminin türü.

Sıralamalar
UNSPECIFIED Varsayılan olarak UNSPECIFIED. Push işleminin, ItemStatus öğesini değiştirmemesi gerektiğini belirtir.
MODIFIED Kod deposu dokümanının, önceki update çağrısından bu yana değiştirildiğini veya güncellendiğini belirtir. Mevcut bir öğenin durumu MODIFIED olarak değiştirilir. Bu işlev, mevcut olmayan bir öğede çağrılırsa durum NEW_ITEM olarak değiştirilir.
NOT_MODIFIED Kod deposundaki öğe, son güncelleme çağrısından bu yana değiştirilmedi. Bu aktarma işlemi, durumu ACCEPTED durumuna ayarlar.
REPOSITORY_ERROR Bağlayıcı, bu öğeyle ilgili bir depo hatasıyla karşılaşıyor. Durumu REPOSITORY_ERROR olarak değiştirin. Öğe ayrılmamış ve üstel geri çekilme ile belirlenen gelecekteki bir zamana yeniden planlanmıştır.
REQUEUE REQUEUE ile yalnızca ayrılmış öğeler için push bildirimi çağırın. Bu işlem, öğenin rezervasyonunu iptal eder ve kullanılabilir süresini gerçek zamana sıfırlar.