ทรัพยากร: การดำเนินงาน
ทรัพยากรนี้แสดงถึงการดำเนินการที่ใช้เวลานานซึ่งเป็นผลมาจากการเรียก API เครือข่าย
ฟิลด์ response
ของการดำเนินการจะเป็น UploadReleaseResponse
การเป็นตัวแทน JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
เขตข้อมูล | |
---|---|
name | ชื่อที่กำหนดโดยเซิร์ฟเวอร์ ซึ่งไม่ซ้ำกันเฉพาะภายในบริการเดียวกันกับที่ส่งคืนมาแต่แรก หากคุณใช้การแมป HTTP เริ่มต้น |
metadata | ข้อมูลเมตาเฉพาะบริการที่เกี่ยวข้องกับการดำเนินการ โดยทั่วไปจะมีข้อมูลความคืบหน้าและข้อมูลเมตาทั่วไป เช่น เวลาในการสร้าง บริการบางอย่างอาจไม่ให้ข้อมูลเมตาดังกล่าว วิธีการใดๆ ที่ส่งคืนการดำเนินการที่ใช้เวลานานควรบันทึกประเภทข้อมูลเมตา ถ้ามี วัตถุที่มีฟิลด์ประเภทใดก็ได้ ฟิลด์เพิ่มเติม |
done | หากค่าเป็น |
result การแข่งขันสนามยูเนี่ยน ผลการดำเนินการซึ่งอาจเป็นได้ทั้ง error หรือ response ที่ถูกต้อง หาก done == false จะไม่มีการตั้งค่า error และ response หาก done == true อาจมีการตั้งค่า error หรือ response อย่างใดอย่างหนึ่ง บริการบางอย่างอาจไม่ให้ผลลัพธ์ result สามารถเป็นได้เพียงอย่างใดอย่างหนึ่งต่อไปนี้: | |
error | ผลลัพธ์ข้อผิดพลาดของการดำเนินการในกรณีที่เกิดความล้มเหลวหรือการยกเลิก |
response | การตอบสนองตามปกติของการดำเนินการในกรณีที่สำเร็จ ในกรณีนี้ มันจะเป็น UploadReleaseResponse |
สถานะ
ประเภท Status
จะกำหนดโมเดลข้อผิดพลาดเชิงตรรกะที่เหมาะสำหรับสภาพแวดล้อมการเขียนโปรแกรมที่แตกต่างกัน รวมถึง REST API และ RPC API มันถูกใช้โดย gRPC ข้อความ Status
แต่ละข้อความประกอบด้วยข้อมูลสามส่วน: รหัสข้อผิดพลาด ข้อความแสดงข้อผิดพลาด และรายละเอียดข้อผิดพลาด
คุณสามารถดูข้อมูลเพิ่มเติมเกี่ยวกับโมเดลข้อผิดพลาดนี้และวิธีการทำงานกับโมเดลข้อผิดพลาดนี้ได้ใน คู่มือการออกแบบ API
การเป็นตัวแทน JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
เขตข้อมูล | |
---|---|
code | รหัสสถานะ ซึ่งควรเป็นค่าแจงนับของ |
message | ข้อความแสดงข้อผิดพลาดที่ผู้พัฒนาพบ ซึ่งควรเป็นภาษาอังกฤษ ข้อความแสดงข้อผิดพลาดที่ผู้ใช้พบควรได้รับการแปลและส่งในช่อง |
details[] | รายการข้อความที่มีรายละเอียดข้อผิดพลาด มีชุดประเภทข้อความทั่วไปสำหรับ API ที่จะใช้ วัตถุที่มีฟิลด์ประเภทใดก็ได้ ฟิลด์เพิ่มเติม |
วิธีการ | |
---|---|
| รับสถานะล่าสุดของการดำเนินการที่ใช้เวลานาน |