- HTTP isteği
- Yol parametreleri
- İstek metni
- Yanıt metni
- Yetkilendirme Kapsamları
- PushItem
- PushItem.Type
- Deneyin.
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 |
Dizine ekleme sırasına aktarılacak 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 ( |
Alanlar | |
---|---|
item.type |
İtme davranışını tanımlayan aktarma işleminin türü. |
item.metadataHash |
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 |
item.structuredDataHash |
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 |
item.contentHash |
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 |
item.payload |
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 |
Bu öğenin ait olduğu sıra. Bu alan belirtilmezse |
item.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 |
connectorName |
Bu çağrıyı yapan bağlayıcının adı. Biçim: veri kaynakları/{kaynakKimliği}/bağlayıcılar/{Kimlik} |
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 ( |
Alanlar | |
---|---|
name |
Dizine ekleme sırasına aktarılacak Biçim: veri kaynakları/{kaynakKimliği}/öğeler/{Kimlik} Bu alanının doldurulması zorunludur. Maksimum uzunluk 1536 karakterdir. |
type |
İtme davranışını tanımlayan aktarma işleminin türü. |
metadataHash |
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 |
structuredDataHash |
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 |
contentHash |
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 |
payload |
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 |
Bu öğenin ait olduğu sıra. Bu alan belirtilmezse |
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 |
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. |