Package google.longrunning

ดัชนี

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

จัดการการดำเนินงานระยะยาวด้วยบริการ API

เมื่อวิธี API โดยปกติใช้เวลานานในการดำเนินการให้เสร็จสมบูรณ์ สามารถออกแบบให้ส่งคืน Operation ยังไคลเอ็นต์ได้ และไคลเอ็นต์สามารถใช้อินเทอร์เฟซนี้เพื่อรับการตอบสนองที่แท้จริงแบบอะซิงโครนัสโดยการโพลทรัพยากรการดำเนินการ หรือส่งทรัพยากรการดำเนินการไปยัง API อื่น ( เช่น Pub/Sub API) เพื่อรับการตอบกลับ บริการ API ใดๆ ที่ส่งคืนการดำเนินการที่ใช้เวลานานควรใช้อินเทอร์เฟซ Operations เพื่อให้นักพัฒนาสามารถมีประสบการณ์ไคลเอนต์ที่สอดคล้องกัน

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

rpc CancelOperation( CancelOperationRequest ) returns ( Empty )

เริ่มการยกเลิกแบบอะซิงโครนัสในการดำเนินการที่ใช้เวลานาน เซิร์ฟเวอร์พยายามอย่างเต็มที่ในการยกเลิกการดำเนินการ แต่ไม่รับประกันความสำเร็จ หากเซิร์ฟเวอร์ไม่รองรับวิธีนี้ จะส่งกลับ google.rpc.Code.UNIMPLEMENTED ลูกค้าสามารถใช้ Operations.GetOperation หรือวิธีการอื่นๆ เพื่อตรวจสอบว่าการยกเลิกสำเร็จหรือไม่ หรือการดำเนินการเสร็จสมบูรณ์แล้วแม้จะมีการยกเลิกหรือไม่ เมื่อยกเลิกสำเร็จ การดำเนินการจะไม่ถูกลบ แต่จะกลายเป็นการดำเนินการที่มีค่า Operation.error โดยมี google.rpc.Status.code เป็น 1 ซึ่งสอดคล้องกับ Code.CANCELLED แทน

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์

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

rpc DeleteOperation( DeleteOperationRequest ) returns ( Empty )

ลบการดำเนินการที่ใช้เวลานาน วิธีการนี้บ่งชี้ว่าลูกค้าไม่สนใจผลการดำเนินงานอีกต่อไป มันไม่ได้ยกเลิกการดำเนินการ หากเซิร์ฟเวอร์ไม่รองรับวิธีนี้ จะส่งกลับ google.rpc.Code.UNIMPLEMENTED

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์

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

rpc GetOperation( GetOperationRequest ) returns ( Operation )

รับสถานะล่าสุดของการดำเนินการที่ใช้เวลานาน ลูกค้าสามารถใช้วิธีนี้เพื่อสำรวจผลการดำเนินการตามช่วงเวลาที่บริการ API แนะนำ

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์

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

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

แสดงรายการการดำเนินการที่ตรงกับตัวกรองที่ระบุในคำขอ หากเซิร์ฟเวอร์ไม่รองรับวิธีนี้ จะส่งกลับ UNIMPLEMENTED

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์

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

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

รอจนกว่าการดำเนินการที่ใช้เวลานานที่ระบุจะเสร็จสิ้นหรือถึงระยะหมดเวลาที่ระบุมากที่สุด โดยส่งคืนสถานะล่าสุด หากการดำเนินการเสร็จสิ้นแล้ว สถานะล่าสุดจะถูกส่งกลับทันที หากการหมดเวลาที่ระบุมากกว่าการหมดเวลา HTTP/RPC เริ่มต้น ระบบจะใช้การหมดเวลา HTTP/RPC หากเซิร์ฟเวอร์ไม่รองรับวิธีนี้ จะส่งกลับ google.rpc.Code.UNIMPLEMENTED โปรดทราบว่าวิธีนี้ใช้ความพยายามอย่างดีที่สุด อาจส่งคืนสถานะล่าสุดก่อนหมดเวลาที่ระบุ (รวมถึงทันที) ซึ่งหมายความว่าแม้แต่การตอบสนองในทันทีก็ไม่รับประกันว่าการดำเนินการจะเสร็จสิ้น

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์

ยกเลิกคำขอดำเนินการ

ข้อความคำขอสำหรับ Operations.CancelOperation

เขตข้อมูล
name

string

ชื่อของทรัพยากรการดำเนินงานที่จะถูกยกเลิก

ลบคำขอการดำเนินการ

ข้อความคำขอสำหรับ Operations.DeleteOperation

เขตข้อมูล
name

string

ชื่อของทรัพยากรการดำเนินงานที่จะลบ

รับคำขอการดำเนินการ

ข้อความคำขอสำหรับ Operations.GetOperation

เขตข้อมูล
name

string

ชื่อของทรัพยากรการดำเนินงาน

คำขอการดำเนินการรายการ

ข้อความคำขอสำหรับ Operations.ListOperations

เขตข้อมูล
name

string

ชื่อของทรัพยากรหลักของการดำเนินงาน

filter

string

ตัวกรองรายการมาตรฐาน

page_size

int32

ขนาดหน้ารายการมาตรฐาน

page_token

string

โทเค็นหน้ารายการมาตรฐาน

รายการ OperationsResponse

ข้อความตอบกลับสำหรับ Operations.ListOperations

เขตข้อมูล
operations[]

Operation

รายการการดำเนินการที่ตรงกับตัวกรองที่ระบุในคำขอ

next_page_token

string

รายการมาตรฐานโทเค็นหน้าถัดไป

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

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

เขตข้อมูล
name

string

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

metadata

Any

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

done

bool

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

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

รอการดำเนินการคำขอ

ข้อความคำขอสำหรับ Operations.WaitOperation

เขตข้อมูล
name

string

ชื่อของทรัพยากรการดำเนินงานที่จะรอ

timeout

Duration

ระยะเวลาสูงสุดที่จะรอก่อนที่จะหมดเวลา หากเว้นว่างไว้ การรอจะเป็นเวลาสูงสุดที่อนุญาตโดยโปรโตคอล HTTP/RPC ที่เกี่ยวข้อง หากมีการระบุกำหนดเวลาบริบท RPC ไว้ด้วย ระบบจะใช้กำหนดเวลาที่สั้นกว่า