Package google.longrunning

ดัชนี

การดำเนินการ

ทรัพยากรนี้แสดงถึงการดําเนินการที่ยาวนานซึ่งเป็นผลมาจากการเรียก API ของเครือข่าย

ช่อง
name

string

ชื่อที่เซิร์ฟเวอร์กําหนด ซึ่งจะไม่ซ้ํากันภายในบริการเดียวกันซึ่งส่งคืนมาตั้งแต่แรกเท่านั้น หากคุณใช้การแมป HTTP เริ่มต้น name ควรเป็นชื่อทรัพยากรที่ลงท้ายด้วย operations/{unique_id}

metadata

Any

ข้อมูลเมตาเฉพาะบริการที่เชื่อมโยงกับการดําเนินการ ซึ่งมักจะมีข้อมูลความคืบหน้าและข้อมูลเมตาทั่วไป เช่น เวลาที่สร้าง บริการบางอย่างอาจไม่ได้ให้ข้อมูลเมตาดังกล่าว เมธอดที่แสดงการดําเนินการที่ยาวนานควรบันทึกประเภทข้อมูลเมตา หากมี

done

bool

หากค่าเป็น false หมายความว่าการดําเนินการยังไม่เสร็จสมบูรณ์ หากเป็น true แสดงว่าการดําเนินการเสร็จสมบูรณ์และมี error หรือ response พร้อมใช้งาน

ช่อง Union result ผลการดําเนินการซึ่งอาจเป็น error หรือ response ที่ถูกต้อง หาก done == false แสดงว่าไม่มีการตั้งค่า error และ response หาก done == true แสดงว่ากําหนด error หรือ response เพียงรายการเดียว result ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้เท่านั้น
error

Status

ผลข้อผิดพลาดของการดําเนินการในกรณีที่เกิดความล้มเหลวหรือการยกเลิก

response

Any

การตอบสนองปกติของการดําเนินการในกรณีที่ประสบความสําเร็จ หากวิธีการเดิมไม่แสดงข้อมูลความสําเร็จ เช่น Delete การตอบกลับจะเป็น google.protobuf.Empty หากวิธีเดิมเป็นแบบมาตรฐาน Get/Create/Update คําตอบควรเป็นทรัพยากร สําหรับวิธีการอื่นๆ การตอบกลับควรมีประเภท XxxResponse โดยที่ Xxx เป็นชื่อเมธอดเดิม เช่น หากชื่อเมธอดเดิมคือ TakeSnapshot() ประเภทคําตอบที่สรุปคือ TakeSnapshotResponse