Package google.longrunning

ดัชนี

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

จัดการการดำเนินการที่ใช้เวลานานด้วยบริการ API

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

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

(ปัจจุบันยังไม่รองรับ) เริ่มการยกเลิกแบบไม่พร้อมกันในการดำเนินการที่ใช้เวลานาน

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

(ปัจจุบันยังไม่รองรับ) ลบการดำเนินการที่ใช้เวลานาน

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc GetOperation(GetOperationRequest) returns (Operation)

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

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform
สิทธิ์ IAM

ต้องใช้สิทธิ์ IAM ต่อไปนี้ในทรัพยากร name

  • routeoptimization.operations.get

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบ IAM
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

(ปัจจุบันยังไม่รองรับ) แสดงรายการการดำเนินการที่ตรงกับตัวกรองที่ระบุในคำขอ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc WaitOperation(WaitOperationRequest) returns (Operation)

(ปัจจุบันยังไม่รองรับ) รอจนกว่าการดำเนินการที่ใช้เวลานานที่ระบุจะเสร็จสมบูรณ์หรือถึงการหมดเวลาที่ระบุ โดยจะแสดงสถานะล่าสุด

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

CancelOperationRequest

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

ช่อง
name

string

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

DeleteOperationRequest

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

ช่อง
name

string

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

GetOperationRequest

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

ช่อง
name

string

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

ListOperationsRequest

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

ช่อง
name

string

ชื่อทรัพยากรระดับบนสุดของการดำเนินการ
filter

string

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

int32

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

string

โทเค็นหน้าของรายการมาตรฐาน
return_partial_success

bool

เมื่อตั้งค่าเป็น true ระบบจะแสดงผลการดำเนินการที่เข้าถึงได้ตามปกติ และแสดงผลการดำเนินการที่เข้าถึงไม่ได้ในช่อง ListOperationsResponse.unreachable

ค่านี้จะเป็น true ได้ก็ต่อเมื่ออ่านข้อมูลจากคอลเล็กชัน เช่น เมื่อตั้งค่า parent เป็น "projects/example/locations/-"

ระบบไม่รองรับช่องนี้โดยค่าเริ่มต้น และจะแสดงข้อผิดพลาด UNIMPLEMENTED หากมีการตั้งค่า เว้นแต่จะมีการระบุไว้เป็นอย่างอื่นอย่างชัดเจนในเอกสารประกอบเฉพาะบริการหรือผลิตภัณฑ์

ListOperationsResponse

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

ช่อง
operations[]

Operation

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

string

โทเค็นหน้าถัดไปของรายการมาตรฐาน
unreachable[]

string

รายการที่ไม่เรียงลำดับ ทรัพยากรที่เข้าถึงไม่ได้ จะมีการป้อนข้อมูลเมื่อคำขอตั้งค่า ListOperationsRequest.return_partial_success และอ่านข้อมูลจากคอลเล็กชัน เช่น เมื่อพยายามแสดงรายการทรัพยากรทั้งหมดในสถานที่ตั้งที่รองรับทั้งหมด

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

ทรัพยากรนี้แสดงการดำเนินการที่ใช้เวลานานซึ่งเป็นผลลัพธ์ของการเรียก 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

WaitOperationRequest

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

ช่อง
name

string

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

Duration

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