- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- PushItem
- PushItem.Type
- ลองใช้งาน
พุชรายการไปยังคิวเพื่ออัปเดตและการอัปเดตในภายหลัง
API นี้ต้องใช้บัญชีผู้ดูแลระบบหรือบัญชีบริการจึงจะสั่งการได้ บัญชีบริการที่ใช้เป็นบัญชีที่อนุญาตพิเศษในแหล่งข้อมูลที่เกี่ยวข้อง
คำขอ HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:push
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
item.name |
ชื่อของ รูปแบบ: แหล่งข้อมูล/{sourceId}/items/{ID} นี่เป็นฟิลด์ที่ต้องระบุ ความยาวสูงสุดคือ 1536 อักขระ |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "item": { "name": string, "type": enum ( |
ช่อง | |
---|---|
item.type |
ประเภทของการดำเนินการพุชที่กำหนดลักษณะการทำงานของการพุช |
item.metadataHash |
แฮชข้อมูลเมตาของรายการตามที่เก็บ หากระบุไว้ ระบบจะใช้ข้อมูลนี้เพื่อกำหนดวิธีแก้ไขสถานะของรายการนี้ การตั้งค่าช่องนี้และช่อง |
item.structuredDataHash |
แฮชข้อมูลที่มีโครงสร้างของรายการตามที่เก็บ หากระบุไว้ ระบบจะใช้ข้อมูลนี้เพื่อกำหนดวิธีแก้ไขสถานะของรายการนี้ การตั้งค่าช่องนี้และช่อง |
item.contentHash |
แฮชเนื้อหาของรายการตามที่เก็บ หากระบุไว้ ระบบจะใช้ข้อมูลนี้เพื่อกำหนดวิธีแก้ไขสถานะของรายการนี้ การตั้งค่าช่องนี้และช่อง |
item.payload |
ระบุข้อมูลสถานะเอกสารเพิ่มเติมสำหรับเครื่องมือเชื่อมต่อ เช่น รหัสที่เก็บสำรองและข้อมูลเมตาอื่นๆ ความยาวสูงสุดคือ 8192 ไบต์ สตริงที่เข้ารหัสแบบ Base64 |
item.queue |
คิวของรายการนี้ ระบบจะเลือกคิว |
item.repositoryError |
ป้อนข้อมูลในช่องนี้เพื่อจัดเก็บรายละเอียดข้อผิดพลาดเกี่ยวกับเครื่องมือเชื่อมต่อหรือที่เก็บ ข้อมูลนี้จะแสดงในคอนโซลผู้ดูแลระบบ ระบบจะป้อนข้อมูลในช่องนี้เมื่อ |
connectorName |
ชื่อของตัวเชื่อมต่อที่เรียกใช้การเรียกนี้ รูปแบบ: แหล่งข้อมูล/{sourceId}/เครื่องมือเชื่อมต่อ/{ID} |
debugOptions |
ตัวเลือกการแก้ปัญหาทั่วไป |
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Item
ขอบเขตการให้สิทธิ์
ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์
PushItem
แสดงรายการที่จะพุชไปยังคิวการจัดทำดัชนี
การแสดง JSON |
---|
{ "name": string, "type": enum ( |
ช่อง | |
---|---|
name |
ชื่อของ รูปแบบ: แหล่งข้อมูล/{sourceId}/items/{ID} นี่เป็นฟิลด์ที่ต้องระบุ ความยาวสูงสุดคือ 1536 อักขระ |
type |
ประเภทของการดำเนินการพุชที่กำหนดลักษณะการทำงานของการพุช |
metadataHash |
แฮชข้อมูลเมตาของรายการตามที่เก็บ หากระบุไว้ ระบบจะใช้ข้อมูลนี้เพื่อกำหนดวิธีแก้ไขสถานะของรายการนี้ การตั้งค่าช่องนี้และช่อง |
structuredDataHash |
แฮชข้อมูลที่มีโครงสร้างของรายการตามที่เก็บ หากระบุไว้ ระบบจะใช้ข้อมูลนี้เพื่อกำหนดวิธีแก้ไขสถานะของรายการนี้ การตั้งค่าช่องนี้และช่อง |
contentHash |
แฮชเนื้อหาของรายการตามที่เก็บ หากระบุไว้ ระบบจะใช้ข้อมูลนี้เพื่อกำหนดวิธีแก้ไขสถานะของรายการนี้ การตั้งค่าช่องนี้และช่อง |
payload |
ระบุข้อมูลสถานะเอกสารเพิ่มเติมสำหรับเครื่องมือเชื่อมต่อ เช่น รหัสที่เก็บสำรองและข้อมูลเมตาอื่นๆ ความยาวสูงสุดคือ 8192 ไบต์ สตริงที่เข้ารหัสแบบ Base64 |
queue |
คิวของรายการนี้ ระบบจะเลือกคิว |
repositoryError |
ป้อนข้อมูลในช่องนี้เพื่อจัดเก็บรายละเอียดข้อผิดพลาดเกี่ยวกับเครื่องมือเชื่อมต่อหรือที่เก็บ ข้อมูลนี้จะแสดงในคอนโซลผู้ดูแลระบบ ระบบจะป้อนข้อมูลในช่องนี้เมื่อ |
PushItem.Type
ประเภทของการดำเนินการพุชที่กำหนดลักษณะการทำงานของการพุช
Enum | |
---|---|
UNSPECIFIED |
ไม่ระบุค่าเริ่มต้น ระบุว่าการดำเนินการพุชไม่ควรแก้ไข ItemStatus |
MODIFIED |
บ่งบอกว่าเอกสารที่เก็บมีการแก้ไขหรืออัปเดตตั้งแต่การเรียกใช้ update ก่อนหน้านี้ การดำเนินการนี้จะเปลี่ยนสถานะของรายการที่มีอยู่เป็นสถานะ MODIFIED หากมีการเรียกรายการนี้ในรายการที่ไม่มีอยู่ สถานะจะเปลี่ยนเป็น NEW_ITEM |
NOT_MODIFIED |
ไม่มีการแก้ไขรายการในที่เก็บตั้งแต่การเรียกการอัปเดตครั้งล่าสุด การดำเนินการพุชนี้จะตั้งสถานะเป็นสถานะ ACCEPTED |
REPOSITORY_ERROR |
เครื่องมือเชื่อมต่อพบข้อผิดพลาดที่เก็บเกี่ยวกับรายการนี้ เปลี่ยนสถานะเป็นรัฐREPOSITORY_ERROR รายการไม่มีการจองและกำหนดเวลาใหม่ในอนาคตซึ่งกำหนดโดย Exponential Backoff |
REQUEUE |
การพุชการเรียกโดยใช้ REQUEUE เฉพาะรายการที่จองไว้เท่านั้น การดำเนินการนี้จะยกเลิกการจองรายการและรีเซ็ตเวลาที่ใช้ได้เป็นเวลาจริง |