BatchJob

正在進行非同步處理的 修改 清單。變更是由使用者上傳。變更內容無法讀取,而且只能使用 BatchJobService.ListBatchJobResults 讀取工作結果。

JSON 表示法
{
  "resourceName": string,
  "metadata": {
    object (BatchJobMetadata)
  },
  "status": enum (BatchJobStatus),
  "id": string,
  "nextAddSequenceToken": string,
  "longRunningOperation": string
}
欄位
resourceName

string

無法變更。批次工作的資源名稱。批次工作資源名稱的格式為:

customers/{customerId}/batchJobs/{batch_job_id}

metadata

object (BatchJobMetadata)

僅供輸出。包含此批次工作的其他資訊。

status

enum (BatchJobStatus)

僅供輸出。這項批次工作的狀態。

id

string (int64 format)

僅供輸出。此批次工作的 ID。

nextAddSequenceToken

string

僅供輸出。新增作業時要使用的下一個序列符記。只有在批次工作狀態為「待處理」時才會設定。

longRunningOperation

string

僅供輸出。可用來輪詢長時間執行作業的資源名稱。只有在批次工作狀態為「執行中」或「完成」時才會設定。

BatchJobMetadata

批次工作的其他資訊。這則訊息也會做為批次工作長時間執行作業傳回的中繼資料使用。

JSON 表示法
{
  "creationDateTime": string,
  "startDateTime": string,
  "completionDateTime": string,
  "estimatedCompletionRatio": number,
  "operationCount": string,
  "executedOperationCount": string,
  "executionLimitSeconds": integer
}
欄位
creationDateTime

string

僅供輸出。建立這項批次工作的時間。格式為 yyyy-mm-dd hh:mm:ss。例如:「2018-03-05 09:15:00」

startDateTime

string

僅供輸出。這項批次工作開始執行的時間。格式為 yyyy-mm-dd hh:mm:ss。例如:「2018-03-05 09:15:30」

completionDateTime

string

僅供輸出。這項批次工作完成的時間。格式為 yyyy-MM-dd HH:mm:ss。例如:「2018-03-05 09:16:00」

estimatedCompletionRatio

number

僅供輸出。已處理的變更比率 (介於 0.0 到 1.0)。如果工作尚未開始執行,這一欄就會留空。

operationCount

string (int64 format)

僅供輸出。批次工作中的 change 作業數量。

executedOperationCount

string (int64 format)

僅供輸出。批次工作執行的 Change 作業數量。只有在工作已開始執行時才會顯示。

executionLimitSeconds

integer

無法變更。批次工作可執行的時間長度約略上限 (以秒為單位)。如果工作執行的時間超過指定的上限,系統就會取消工作。

BatchJobStatus

批次工作狀態。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅適用於傳回值。代表此版本中未知的值。
PENDING 工作目前並未執行。
RUNNING 工作正在執行中。
DONE 工作已完成,