Task class
代表Task的類別。
建構函式
| Task(Batch |
建立工作。 |
方法
建構函式詳細資料
Task(BatchServiceClientContext)
方法詳細資料
add(string, TaskAddParameter, ServiceCallback<void>)
function add(jobId: string, task: TaskAddParameter, callback: ServiceCallback<void>)參數
- jobId
-
string
要加入工作之作業的標識碼。
- task
- TaskAddParameter
要加入的工作。
- callback
-
ServiceCallback<void>
回呼
add(string, TaskAddParameter, TaskAddOptionalParams)
從完成到完成的工作最長存留期為 180 天。 如果工作尚未在新增的 180 天內完成，Batch 服務將會終止工作，並在當時處於任何狀態。
function add(jobId: string, task: TaskAddParameter, options?: TaskAddOptionalParams): Promise<TaskAddResponse>參數
- jobId
-
string
要加入工作之作業的標識碼。
- task
- TaskAddParameter
要加入的工作。
- options
- TaskAddOptionalParams
選擇性參數
傳回
Promise<TaskAddResponse>
承諾<Models.TaskAddResponse>
add(string, TaskAddParameter, TaskAddOptionalParams, ServiceCallback<void>)
function add(jobId: string, task: TaskAddParameter, options: TaskAddOptionalParams, callback: ServiceCallback<void>)參數
- jobId
-
string
要加入工作之作業的標識碼。
- task
- TaskAddParameter
要加入的工作。
- options
- TaskAddOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
addCollection(string, TaskAddParameter[], ServiceCallback<TaskAddCollectionResult>)
function addCollection(jobId: string, value: TaskAddParameter[], callback: ServiceCallback<TaskAddCollectionResult>)參數
- jobId
-
string
要加入Task集合之作業的標識碼。
- value
要加入之 Tasks 的集合。 工作的最大計數為 100。 這個集合的總串行化大小必須小於 1MB。 如果大於 1MB（例如，如果每個工作都有 100 個的資源檔或環境變數），則要求會失敗，且程式代碼為 'RequestBodyTooLarge'，而且應該以較少的工作重試。
- callback
回呼
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams)
請注意，每個工作都必須有唯一標識符。 Batch 服務可能不會依照此要求中提交工作的順序，傳回每個工作的結果。 如果伺服器在要求期間逾時或連接已關閉，則要求可能已部分或完全處理，或完全未處理。 在這種情況下，用戶應該重新發出要求。 請注意，重新發出要求時，用戶必須正確地處理失敗。 例如，您應該在重試期間使用相同的工作標識符，如此一來，如果先前的作業成功，重試將不會意外建立額外的工作。 如果回應包含任何無法新增的工作，用戶端可以重試要求。 在重試中，只重新提交無法新增的工作，並省略第一次嘗試時成功新增的工作是最有效率的。 從完成到完成的工作最長存留期為 180 天。 如果工作尚未在新增的 180 天內完成，Batch 服務將會終止工作，並在當時處於任何狀態。
function addCollection(jobId: string, value: TaskAddParameter[], options?: TaskAddCollectionOptionalParams): Promise<TaskAddCollectionResponse>參數
- jobId
-
string
要加入Task集合之作業的標識碼。
- value
要加入之 Tasks 的集合。 工作的最大計數為 100。 這個集合的總串行化大小必須小於 1MB。 如果大於 1MB（例如，如果每個工作都有 100 個的資源檔或環境變數），則要求會失敗，且程式代碼為 'RequestBodyTooLarge'，而且應該以較少的工作重試。
- options
- TaskAddCollectionOptionalParams
選擇性參數
傳回
Promise<TaskAddCollectionResponse>
承諾<Models.TaskAddCollectionResponse>
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams, ServiceCallback<TaskAddCollectionResult>)
function addCollection(jobId: string, value: TaskAddParameter[], options: TaskAddCollectionOptionalParams, callback: ServiceCallback<TaskAddCollectionResult>)參數
- jobId
-
string
要加入Task集合之作業的標識碼。
- value
要加入之 Tasks 的集合。 工作的最大計數為 100。 這個集合的總串行化大小必須小於 1MB。 如果大於 1MB（例如，如果每個工作都有 100 個的資源檔或環境變數），則要求會失敗，且程式代碼為 'RequestBodyTooLarge'，而且應該以較少的工作重試。
- options
- TaskAddCollectionOptionalParams
選擇性參數
- callback
回呼
deleteMethod(string, string, ServiceCallback<void>)
function deleteMethod(jobId: string, taskId: string, callback: ServiceCallback<void>)參數
- jobId
-
string
要從中刪除工作的作業標識碼。
- taskId
-
string
要刪除之工作的識別碼。
- callback
-
ServiceCallback<void>
回呼
deleteMethod(string, string, TaskDeleteMethodOptionalParams)
刪除工作時，也會刪除其所在計算節點上其目錄中的所有檔案（不論保留時間為何）。 針對多重實例工作，刪除工作作業會同步套用至主要工作;子工作及其檔案接著會在背景以異步方式刪除。
function deleteMethod(jobId: string, taskId: string, options?: TaskDeleteMethodOptionalParams): Promise<TaskDeleteResponse>參數
- jobId
-
string
要從中刪除工作的作業標識碼。
- taskId
-
string
要刪除之工作的識別碼。
- options
- TaskDeleteMethodOptionalParams
選擇性參數
傳回
Promise<TaskDeleteResponse>
承諾<模型.TaskDelete回應>
deleteMethod(string, string, TaskDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(jobId: string, taskId: string, options: TaskDeleteMethodOptionalParams, callback: ServiceCallback<void>)參數
- jobId
-
string
要從中刪除工作的作業標識碼。
- taskId
-
string
要刪除之工作的識別碼。
- options
- TaskDeleteMethodOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
get(string, string, ServiceCallback<CloudTask>)
function get(jobId: string, taskId: string, callback: ServiceCallback<CloudTask>)參數
- jobId
-
string
包含工作之作業的識別碼。
- taskId
-
string
要取得相關信息之工作的標識碼。
- callback
回呼
get(string, string, TaskGetOptionalParams)
針對多重實例工作，affinityId、executionInfo 和 nodeInfo 等資訊會參考主要工作。 使用清單子工作 API 來擷取子工作的相關信息。
function get(jobId: string, taskId: string, options?: TaskGetOptionalParams): Promise<TaskGetResponse>參數
- jobId
-
string
包含工作之作業的識別碼。
- taskId
-
string
要取得相關信息之工作的標識碼。
- options
- TaskGetOptionalParams
選擇性參數
傳回
Promise<TaskGetResponse>
承諾<Models.TaskGetResponse>
get(string, string, TaskGetOptionalParams, ServiceCallback<CloudTask>)
function get(jobId: string, taskId: string, options: TaskGetOptionalParams, callback: ServiceCallback<CloudTask>)參數
- jobId
-
string
包含工作之作業的識別碼。
- taskId
-
string
要取得相關信息之工作的標識碼。
- options
- TaskGetOptionalParams
選擇性參數
- callback
回呼
list(string, ServiceCallback<CloudTaskListResult>)
function list(jobId: string, callback: ServiceCallback<CloudTaskListResult>)參數
- jobId
-
string
作業的標識碼。
- callback
回呼
list(string, TaskListOptionalParams)
針對多重實例工作，affinityId、executionInfo 和 nodeInfo 等資訊會參考主要工作。 使用清單子工作 API 來擷取子工作的相關信息。
function list(jobId: string, options?: TaskListOptionalParams): Promise<TaskListResponse>參數
- jobId
-
string
作業的標識碼。
- options
- TaskListOptionalParams
選擇性參數
傳回
Promise<TaskListResponse>
承諾<模型.TaskListResponse>
list(string, TaskListOptionalParams, ServiceCallback<CloudTaskListResult>)
function list(jobId: string, options: TaskListOptionalParams, callback: ServiceCallback<CloudTaskListResult>)參數
- jobId
-
string
作業的標識碼。
- options
- TaskListOptionalParams
選擇性參數
- callback
回呼
listNext(string, ServiceCallback<CloudTaskListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudTaskListResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
- callback
回呼
listNext(string, TaskListNextOptionalParams)
針對多重實例工作，affinityId、executionInfo 和 nodeInfo 等資訊會參考主要工作。 使用清單子工作 API 來擷取子工作的相關信息。
function listNext(nextPageLink: string, options?: TaskListNextOptionalParams): Promise<TaskListResponse>參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
- options
- TaskListNextOptionalParams
選擇性參數
傳回
Promise<TaskListResponse>
承諾<模型.TaskListResponse>
listNext(string, TaskListNextOptionalParams, ServiceCallback<CloudTaskListResult>)
function listNext(nextPageLink: string, options: TaskListNextOptionalParams, callback: ServiceCallback<CloudTaskListResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
- options
- TaskListNextOptionalParams
選擇性參數
- callback
回呼
listSubtasks(string, string, ServiceCallback<CloudTaskListSubtasksResult>)
function listSubtasks(jobId: string, taskId: string, callback: ServiceCallback<CloudTaskListSubtasksResult>)參數
- jobId
-
string
作業的標識碼。
- taskId
-
string
工作的標識碼。
- callback
回呼
listSubtasks(string, string, TaskListSubtasksOptionalParams)
如果Task不是多重實例Task，則這會傳回空集合。
function listSubtasks(jobId: string, taskId: string, options?: TaskListSubtasksOptionalParams): Promise<TaskListSubtasksResponse>參數
- jobId
-
string
作業的標識碼。
- taskId
-
string
工作的標識碼。
- options
- TaskListSubtasksOptionalParams
選擇性參數
傳回
Promise<TaskListSubtasksResponse>
Promise<Models.TaskListSubtasks回應>
listSubtasks(string, string, TaskListSubtasksOptionalParams, ServiceCallback<CloudTaskListSubtasksResult>)
function listSubtasks(jobId: string, taskId: string, options: TaskListSubtasksOptionalParams, callback: ServiceCallback<CloudTaskListSubtasksResult>)參數
- jobId
-
string
作業的標識碼。
- taskId
-
string
工作的標識碼。
- options
- TaskListSubtasksOptionalParams
選擇性參數
- callback
回呼
reactivate(string, string, ServiceCallback<void>)
function reactivate(jobId: string, taskId: string, callback: ServiceCallback<void>)參數
- jobId
-
string
包含工作之作業的識別碼。
- taskId
-
string
要重新啟用之工作的識別碼。
- callback
-
ServiceCallback<void>
回呼
reactivate(string, string, TaskReactivateOptionalParams)
重新啟用可讓工作重新重試，最多達到重試計數上限。 工作的狀態會變更為作用中。 由於工作已不再處於已完成狀態，任何先前的結束代碼或失敗資訊都無法在重新啟用之後再使用。 每次重新啟動工作時，其重試計數會重設為 0。 未完成或先前成功完成的工作將會重新啟動失敗（結束代碼為 0）。 此外，如果作業已完成（或正在終止或刪除），它將會失敗。
function reactivate(jobId: string, taskId: string, options?: TaskReactivateOptionalParams): Promise<TaskReactivateResponse>參數
- jobId
-
string
包含工作之作業的識別碼。
- taskId
-
string
要重新啟用之工作的識別碼。
- options
- TaskReactivateOptionalParams
選擇性參數
傳回
Promise<TaskReactivateResponse>
Promise<Models.TaskReactivateResponse>
reactivate(string, string, TaskReactivateOptionalParams, ServiceCallback<void>)
function reactivate(jobId: string, taskId: string, options: TaskReactivateOptionalParams, callback: ServiceCallback<void>)參數
- jobId
-
string
包含工作之作業的識別碼。
- taskId
-
string
要重新啟用之工作的識別碼。
- options
- TaskReactivateOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
terminate(string, string, ServiceCallback<void>)
function terminate(jobId: string, taskId: string, callback: ServiceCallback<void>)參數
- jobId
-
string
包含工作之作業的識別碼。
- taskId
-
string
要終止之工作的標識碼。
- callback
-
ServiceCallback<void>
回呼
terminate(string, string, TaskTerminateOptionalParams)
當工作終止時，它會移至已完成狀態。 針對多重實例工作，終止工作作業會同步套用至主要工作;子工作接著會在背景以異步方式終止。
function terminate(jobId: string, taskId: string, options?: TaskTerminateOptionalParams): Promise<TaskTerminateResponse>參數
- jobId
-
string
包含工作之作業的識別碼。
- taskId
-
string
要終止之工作的標識碼。
- options
- TaskTerminateOptionalParams
選擇性參數
傳回
Promise<TaskTerminateResponse>
承諾<Models.TaskTerminateResponse>
terminate(string, string, TaskTerminateOptionalParams, ServiceCallback<void>)
function terminate(jobId: string, taskId: string, options: TaskTerminateOptionalParams, callback: ServiceCallback<void>)參數
- jobId
-
string
包含工作之作業的識別碼。
- taskId
-
string
要終止之工作的標識碼。
- options
- TaskTerminateOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
update(string, string, ServiceCallback<void>)
function update(jobId: string, taskId: string, callback: ServiceCallback<void>)參數
- jobId
-
string
包含工作之作業的識別碼。
- taskId
-
string
要更新之工作的識別碼。
- callback
-
ServiceCallback<void>
回呼
update(string, string, TaskUpdateOptionalParams)
更新指定之工作的屬性。
function update(jobId: string, taskId: string, options?: TaskUpdateOptionalParams): Promise<TaskUpdateResponse>參數
- jobId
-
string
包含工作之作業的識別碼。
- taskId
-
string
要更新之工作的識別碼。
- options
- TaskUpdateOptionalParams
選擇性參數
傳回
Promise<TaskUpdateResponse>
承諾<模型.TaskUpdateResponse>
update(string, string, TaskUpdateOptionalParams, ServiceCallback<void>)
function update(jobId: string, taskId: string, options: TaskUpdateOptionalParams, callback: ServiceCallback<void>)參數
- jobId
-
string
包含工作之作業的識別碼。
- taskId
-
string
要更新之工作的識別碼。
- options
- TaskUpdateOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼