REST Resource: projects.operations

ทรัพยากร: การดำเนินงาน

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

การเป็นตัวแทน JSON
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
เขตข้อมูล
name

string

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

metadata

object

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

วัตถุที่มีฟิลด์ประเภทใดก็ได้ ฟิลด์เพิ่มเติม "@type" มี URI ที่ระบุประเภท ตัวอย่าง: { "id": 1234, "@type": "types.example.com/standard/id" }

done

boolean

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

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

object ( Status )

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

response

object

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

วัตถุที่มีฟิลด์ประเภทใดก็ได้ ฟิลด์เพิ่มเติม "@type" มี URI ที่ระบุประเภท ตัวอย่าง: { "id": 1234, "@type": "types.example.com/standard/id" }

วิธีการ

get

รับสถานะล่าสุดของการดำเนินการที่ใช้เวลานาน