REST Resource: projects.databases.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" }

วิธีการ

cancel

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

delete

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

get

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

list

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