Dela via


Task class

Klass som representerar en aktivitet.

Konstruktorer

Task(BatchServiceClientContext)

Skapa en uppgift.

Metoder

add(string, TaskAddParameter, ServiceCallback<void>)
add(string, TaskAddParameter, TaskAddOptionalParams)

Den maximala livslängden för en aktivitet från tillägg till slutförande är 180 dagar. Om en aktivitet inte har slutförts inom 180 dagar efter att den har lagts till avslutas den av Batch-tjänsten och lämnas i det tillstånd den befann sig i vid den tidpunkten.

add(string, TaskAddParameter, TaskAddOptionalParams, ServiceCallback<void>)
addCollection(string, TaskAddParameter[], ServiceCallback<TaskAddCollectionResult>)
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams)

Observera att varje aktivitet måste ha ett unikt ID. Batch-tjänsten kanske inte returnerar resultaten för varje aktivitet i samma ordning som aktiviteterna skickades i den här begäran. Om servern överskrider tidsgränsen eller om anslutningen stängs under begäran kan begäran ha bearbetats helt eller delvis eller inte alls. I sådana fall bör användaren utfärda begäran igen. Observera att det är upp till användaren att hantera fel vid återutfärdande av en begäran. Du bör till exempel använda samma aktivitets-ID under ett nytt försök så att om den tidigare åtgärden lyckades skapar inte omförsöket extra aktiviteter oväntat. Om svaret innehåller aktiviteter som inte kunde läggas till kan en klient försöka begäran igen. Vid ett nytt försök är det mest effektivt att skicka in uppgifter som inte kunde läggas till på nytt och att utelämna uppgifter som har lagts till vid det första försöket. Den maximala livslängden för en aktivitet från tillägg till slutförande är 180 dagar. Om en aktivitet inte har slutförts inom 180 dagar efter att den har lagts till avslutas den av Batch-tjänsten och lämnas i det tillstånd den befann sig i vid den tidpunkten.

addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams, ServiceCallback<TaskAddCollectionResult>)
deleteMethod(string, string, ServiceCallback<void>)
deleteMethod(string, string, TaskDeleteMethodOptionalParams)

När en aktivitet tas bort tas alla filer i dess katalog på beräkningsnoden där den kördes också bort (oavsett kvarhållningstid). För aktiviteter med flera instanser tillämpas borttagningsåtgärden synkront på den primära aktiviteten. underaktiviteter och deras filer tas sedan bort asynkront i bakgrunden.

deleteMethod(string, string, TaskDeleteMethodOptionalParams, ServiceCallback<void>)
get(string, string, ServiceCallback<CloudTask>)
get(string, string, TaskGetOptionalParams)

Information om aktiviteter med flera instanser, till exempel affinityId, executionInfo och nodeInfo, refererar till den primära aktiviteten. Använd API:et för listunderaktiviteter för att hämta information om underaktiviteter.

get(string, string, TaskGetOptionalParams, ServiceCallback<CloudTask>)
list(string, ServiceCallback<CloudTaskListResult>)
list(string, TaskListOptionalParams)

Information om aktiviteter med flera instanser, till exempel affinityId, executionInfo och nodeInfo, refererar till den primära aktiviteten. Använd API:et för listunderaktiviteter för att hämta information om underaktiviteter.

list(string, TaskListOptionalParams, ServiceCallback<CloudTaskListResult>)
listNext(string, ServiceCallback<CloudTaskListResult>)
listNext(string, TaskListNextOptionalParams)

Information om aktiviteter med flera instanser, till exempel affinityId, executionInfo och nodeInfo, refererar till den primära aktiviteten. Använd API:et för listunderaktiviteter för att hämta information om underaktiviteter.

listNext(string, TaskListNextOptionalParams, ServiceCallback<CloudTaskListResult>)
listSubtasks(string, string, ServiceCallback<CloudTaskListSubtasksResult>)
listSubtasks(string, string, TaskListSubtasksOptionalParams)

Om aktiviteten inte är en aktivitet med flera instanser returnerar den en tom samling.

listSubtasks(string, string, TaskListSubtasksOptionalParams, ServiceCallback<CloudTaskListSubtasksResult>)
reactivate(string, string, ServiceCallback<void>)
reactivate(string, string, TaskReactivateOptionalParams)

Återaktivering gör en aktivitet berättigad att försöka igen upp till det maximala antalet återförsök. Aktivitetens tillstånd ändras till aktiv. Eftersom aktiviteten inte längre är i slutfört tillstånd är all tidigare slutkod eller felinformation inte längre tillgänglig efter återaktivering. Varje gång en aktivitet återaktiveras återställs antalet återförsök till 0. Återaktiveringen misslyckas för aktiviteter som inte har slutförts eller som har slutförts tidigare (med slutkoden 0). Dessutom misslyckas det om jobbet har slutförts (eller avslutar eller tar bort).

reactivate(string, string, TaskReactivateOptionalParams, ServiceCallback<void>)
terminate(string, string, ServiceCallback<void>)
terminate(string, string, TaskTerminateOptionalParams)

När aktiviteten har avslutats flyttas den till slutfört tillstånd. För aktiviteter med flera instanser gäller åtgärden Avsluta aktivitet synkront för den primära aktiviteten. underaktiviteter avslutas sedan asynkront i bakgrunden.

terminate(string, string, TaskTerminateOptionalParams, ServiceCallback<void>)
update(string, string, ServiceCallback<void>)
update(string, string, TaskUpdateOptionalParams)

Uppdaterar egenskaperna för den angivna aktiviteten.

update(string, string, TaskUpdateOptionalParams, ServiceCallback<void>)

Konstruktorinformation

Task(BatchServiceClientContext)

Skapa en uppgift.

new Task(client: BatchServiceClientContext)

Parametrar

client
BatchServiceClientContext

Referens till tjänstklienten.

Metodinformation

add(string, TaskAddParameter, ServiceCallback<void>)

function add(jobId: string, task: TaskAddParameter, callback: ServiceCallback<void>)

Parametrar

jobId

string

ID:t för jobbet som aktiviteten ska läggas till i.

task
TaskAddParameter

Uppgiften som ska läggas till.

callback

ServiceCallback<void>

Återanropet

add(string, TaskAddParameter, TaskAddOptionalParams)

Den maximala livslängden för en aktivitet från tillägg till slutförande är 180 dagar. Om en aktivitet inte har slutförts inom 180 dagar efter att den har lagts till avslutas den av Batch-tjänsten och lämnas i det tillstånd den befann sig i vid den tidpunkten.

function add(jobId: string, task: TaskAddParameter, options?: TaskAddOptionalParams): Promise<TaskAddResponse>

Parametrar

jobId

string

ID:t för jobbet som aktiviteten ska läggas till i.

task
TaskAddParameter

Uppgiften som ska läggas till.

options
TaskAddOptionalParams

De valfria parametrarna

Returer

Promise<TaskAddResponse>

Löfte<Models.TaskAddResponse>

add(string, TaskAddParameter, TaskAddOptionalParams, ServiceCallback<void>)

function add(jobId: string, task: TaskAddParameter, options: TaskAddOptionalParams, callback: ServiceCallback<void>)

Parametrar

jobId

string

ID:t för jobbet som aktiviteten ska läggas till i.

task
TaskAddParameter

Uppgiften som ska läggas till.

options
TaskAddOptionalParams

De valfria parametrarna

callback

ServiceCallback<void>

Återanropet

addCollection(string, TaskAddParameter[], ServiceCallback<TaskAddCollectionResult>)

function addCollection(jobId: string, value: TaskAddParameter[], callback: ServiceCallback<TaskAddCollectionResult>)

Parametrar

jobId

string

ID:t för jobbet som uppgiftssamlingen ska läggas till i.

value

TaskAddParameter[]

Den samling uppgifter som ska läggas till. Det maximala antalet uppgifter är 100. Den totala serialiserade storleken för den här samlingen måste vara mindre än 1 MB. Om den är större än 1 MB (till exempel om varje aktivitet har 100-talet resursfiler eller miljövariabler) misslyckas begäran med koden "RequestBodyTooLarge" och bör göras om med färre aktiviteter.

callback

ServiceCallback<TaskAddCollectionResult>

Återanropet

addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams)

Observera att varje aktivitet måste ha ett unikt ID. Batch-tjänsten kanske inte returnerar resultaten för varje aktivitet i samma ordning som aktiviteterna skickades i den här begäran. Om servern överskrider tidsgränsen eller om anslutningen stängs under begäran kan begäran ha bearbetats helt eller delvis eller inte alls. I sådana fall bör användaren utfärda begäran igen. Observera att det är upp till användaren att hantera fel vid återutfärdande av en begäran. Du bör till exempel använda samma aktivitets-ID under ett nytt försök så att om den tidigare åtgärden lyckades skapar inte omförsöket extra aktiviteter oväntat. Om svaret innehåller aktiviteter som inte kunde läggas till kan en klient försöka begäran igen. Vid ett nytt försök är det mest effektivt att skicka in uppgifter som inte kunde läggas till på nytt och att utelämna uppgifter som har lagts till vid det första försöket. Den maximala livslängden för en aktivitet från tillägg till slutförande är 180 dagar. Om en aktivitet inte har slutförts inom 180 dagar efter att den har lagts till avslutas den av Batch-tjänsten och lämnas i det tillstånd den befann sig i vid den tidpunkten.

function addCollection(jobId: string, value: TaskAddParameter[], options?: TaskAddCollectionOptionalParams): Promise<TaskAddCollectionResponse>

Parametrar

jobId

string

ID:t för jobbet som uppgiftssamlingen ska läggas till i.

value

TaskAddParameter[]

Den samling uppgifter som ska läggas till. Det maximala antalet uppgifter är 100. Den totala serialiserade storleken för den här samlingen måste vara mindre än 1 MB. Om den är större än 1 MB (till exempel om varje aktivitet har 100-talet resursfiler eller miljövariabler) misslyckas begäran med koden "RequestBodyTooLarge" och bör göras om med färre aktiviteter.

options
TaskAddCollectionOptionalParams

De valfria parametrarna

Returer

Löfte<Models.TaskAddCollectionResponse>

addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams, ServiceCallback<TaskAddCollectionResult>)

function addCollection(jobId: string, value: TaskAddParameter[], options: TaskAddCollectionOptionalParams, callback: ServiceCallback<TaskAddCollectionResult>)

Parametrar

jobId

string

ID:t för jobbet som uppgiftssamlingen ska läggas till i.

value

TaskAddParameter[]

Den samling uppgifter som ska läggas till. Det maximala antalet uppgifter är 100. Den totala serialiserade storleken för den här samlingen måste vara mindre än 1 MB. Om den är större än 1 MB (till exempel om varje aktivitet har 100-talet resursfiler eller miljövariabler) misslyckas begäran med koden "RequestBodyTooLarge" och bör göras om med färre aktiviteter.

options
TaskAddCollectionOptionalParams

De valfria parametrarna

callback

ServiceCallback<TaskAddCollectionResult>

Återanropet

deleteMethod(string, string, ServiceCallback<void>)

function deleteMethod(jobId: string, taskId: string, callback: ServiceCallback<void>)

Parametrar

jobId

string

ID:t för jobbet som aktiviteten ska tas bort från.

taskId

string

ID:t för uppgiften som ska tas bort.

callback

ServiceCallback<void>

Återanropet

deleteMethod(string, string, TaskDeleteMethodOptionalParams)

När en aktivitet tas bort tas alla filer i dess katalog på beräkningsnoden där den kördes också bort (oavsett kvarhållningstid). För aktiviteter med flera instanser tillämpas borttagningsåtgärden synkront på den primära aktiviteten. underaktiviteter och deras filer tas sedan bort asynkront i bakgrunden.

function deleteMethod(jobId: string, taskId: string, options?: TaskDeleteMethodOptionalParams): Promise<TaskDeleteResponse>

Parametrar

jobId

string

ID:t för jobbet som aktiviteten ska tas bort från.

taskId

string

ID:t för uppgiften som ska tas bort.

options
TaskDeleteMethodOptionalParams

De valfria parametrarna

Returer

Löfte<Models.TaskDeleteResponse>

deleteMethod(string, string, TaskDeleteMethodOptionalParams, ServiceCallback<void>)

function deleteMethod(jobId: string, taskId: string, options: TaskDeleteMethodOptionalParams, callback: ServiceCallback<void>)

Parametrar

jobId

string

ID:t för jobbet som aktiviteten ska tas bort från.

taskId

string

ID:t för uppgiften som ska tas bort.

options
TaskDeleteMethodOptionalParams

De valfria parametrarna

callback

ServiceCallback<void>

Återanropet

get(string, string, ServiceCallback<CloudTask>)

function get(jobId: string, taskId: string, callback: ServiceCallback<CloudTask>)

Parametrar

jobId

string

ID:t för jobbet som innehåller uppgiften.

taskId

string

ID:t för uppgiften för att få information om.

callback

ServiceCallback<CloudTask>

Återanropet

get(string, string, TaskGetOptionalParams)

Information om aktiviteter med flera instanser, till exempel affinityId, executionInfo och nodeInfo, refererar till den primära aktiviteten. Använd API:et för listunderaktiviteter för att hämta information om underaktiviteter.

function get(jobId: string, taskId: string, options?: TaskGetOptionalParams): Promise<TaskGetResponse>

Parametrar

jobId

string

ID:t för jobbet som innehåller uppgiften.

taskId

string

ID:t för uppgiften för att få information om.

options
TaskGetOptionalParams

De valfria parametrarna

Returer

Promise<TaskGetResponse>

Löfte<Models.TaskGetResponse>

get(string, string, TaskGetOptionalParams, ServiceCallback<CloudTask>)

function get(jobId: string, taskId: string, options: TaskGetOptionalParams, callback: ServiceCallback<CloudTask>)

Parametrar

jobId

string

ID:t för jobbet som innehåller uppgiften.

taskId

string

ID:t för uppgiften för att få information om.

options
TaskGetOptionalParams

De valfria parametrarna

callback

ServiceCallback<CloudTask>

Återanropet

list(string, ServiceCallback<CloudTaskListResult>)

function list(jobId: string, callback: ServiceCallback<CloudTaskListResult>)

Parametrar

jobId

string

Jobbets ID.

callback

ServiceCallback<CloudTaskListResult>

Återanropet

list(string, TaskListOptionalParams)

Information om aktiviteter med flera instanser, till exempel affinityId, executionInfo och nodeInfo, refererar till den primära aktiviteten. Använd API:et för listunderaktiviteter för att hämta information om underaktiviteter.

function list(jobId: string, options?: TaskListOptionalParams): Promise<TaskListResponse>

Parametrar

jobId

string

Jobbets ID.

options
TaskListOptionalParams

De valfria parametrarna

Returer

Promise<TaskListResponse>

Löfte<Models.TaskListResponse>

list(string, TaskListOptionalParams, ServiceCallback<CloudTaskListResult>)

function list(jobId: string, options: TaskListOptionalParams, callback: ServiceCallback<CloudTaskListResult>)

Parametrar

jobId

string

Jobbets ID.

options
TaskListOptionalParams

De valfria parametrarna

callback

ServiceCallback<CloudTaskListResult>

Återanropet

listNext(string, ServiceCallback<CloudTaskListResult>)

function listNext(nextPageLink: string, callback: ServiceCallback<CloudTaskListResult>)

Parametrar

nextPageLink

string

NextLink från det tidigare lyckade anropet till liståtgärden.

callback

ServiceCallback<CloudTaskListResult>

Återanropet

listNext(string, TaskListNextOptionalParams)

Information om aktiviteter med flera instanser, till exempel affinityId, executionInfo och nodeInfo, refererar till den primära aktiviteten. Använd API:et för listunderaktiviteter för att hämta information om underaktiviteter.

function listNext(nextPageLink: string, options?: TaskListNextOptionalParams): Promise<TaskListResponse>

Parametrar

nextPageLink

string

NextLink från det tidigare lyckade anropet till liståtgärden.

options
TaskListNextOptionalParams

De valfria parametrarna

Returer

Promise<TaskListResponse>

Löfte<Models.TaskListResponse>

listNext(string, TaskListNextOptionalParams, ServiceCallback<CloudTaskListResult>)

function listNext(nextPageLink: string, options: TaskListNextOptionalParams, callback: ServiceCallback<CloudTaskListResult>)

Parametrar

nextPageLink

string

NextLink från det tidigare lyckade anropet till liståtgärden.

options
TaskListNextOptionalParams

De valfria parametrarna

callback

ServiceCallback<CloudTaskListResult>

Återanropet

listSubtasks(string, string, ServiceCallback<CloudTaskListSubtasksResult>)

function listSubtasks(jobId: string, taskId: string, callback: ServiceCallback<CloudTaskListSubtasksResult>)

Parametrar

jobId

string

Jobbets ID.

taskId

string

ID:t för uppgiften.

listSubtasks(string, string, TaskListSubtasksOptionalParams)

Om aktiviteten inte är en aktivitet med flera instanser returnerar den en tom samling.

function listSubtasks(jobId: string, taskId: string, options?: TaskListSubtasksOptionalParams): Promise<TaskListSubtasksResponse>

Parametrar

jobId

string

Jobbets ID.

taskId

string

ID:t för uppgiften.

options
TaskListSubtasksOptionalParams

De valfria parametrarna

Returer

Löfte<Models.TaskListSubtasksResponse>

listSubtasks(string, string, TaskListSubtasksOptionalParams, ServiceCallback<CloudTaskListSubtasksResult>)

function listSubtasks(jobId: string, taskId: string, options: TaskListSubtasksOptionalParams, callback: ServiceCallback<CloudTaskListSubtasksResult>)

Parametrar

jobId

string

Jobbets ID.

taskId

string

ID:t för uppgiften.

options
TaskListSubtasksOptionalParams

De valfria parametrarna

reactivate(string, string, ServiceCallback<void>)

function reactivate(jobId: string, taskId: string, callback: ServiceCallback<void>)

Parametrar

jobId

string

ID:t för jobbet som innehåller uppgiften.

taskId

string

ID:t för uppgiften som ska återaktiveras.

callback

ServiceCallback<void>

Återanropet

reactivate(string, string, TaskReactivateOptionalParams)

Återaktivering gör en aktivitet berättigad att försöka igen upp till det maximala antalet återförsök. Aktivitetens tillstånd ändras till aktiv. Eftersom aktiviteten inte längre är i slutfört tillstånd är all tidigare slutkod eller felinformation inte längre tillgänglig efter återaktivering. Varje gång en aktivitet återaktiveras återställs antalet återförsök till 0. Återaktiveringen misslyckas för aktiviteter som inte har slutförts eller som har slutförts tidigare (med slutkoden 0). Dessutom misslyckas det om jobbet har slutförts (eller avslutar eller tar bort).

function reactivate(jobId: string, taskId: string, options?: TaskReactivateOptionalParams): Promise<TaskReactivateResponse>

Parametrar

jobId

string

ID:t för jobbet som innehåller uppgiften.

taskId

string

ID:t för uppgiften som ska återaktiveras.

options
TaskReactivateOptionalParams

De valfria parametrarna

Returer

Löfte<Models.TaskReactivateResponse>

reactivate(string, string, TaskReactivateOptionalParams, ServiceCallback<void>)

function reactivate(jobId: string, taskId: string, options: TaskReactivateOptionalParams, callback: ServiceCallback<void>)

Parametrar

jobId

string

ID:t för jobbet som innehåller uppgiften.

taskId

string

ID:t för uppgiften som ska återaktiveras.

options
TaskReactivateOptionalParams

De valfria parametrarna

callback

ServiceCallback<void>

Återanropet

terminate(string, string, ServiceCallback<void>)

function terminate(jobId: string, taskId: string, callback: ServiceCallback<void>)

Parametrar

jobId

string

ID:t för jobbet som innehåller uppgiften.

taskId

string

ID:t för uppgiften som ska avslutas.

callback

ServiceCallback<void>

Återanropet

terminate(string, string, TaskTerminateOptionalParams)

När aktiviteten har avslutats flyttas den till slutfört tillstånd. För aktiviteter med flera instanser gäller åtgärden Avsluta aktivitet synkront för den primära aktiviteten. underaktiviteter avslutas sedan asynkront i bakgrunden.

function terminate(jobId: string, taskId: string, options?: TaskTerminateOptionalParams): Promise<TaskTerminateResponse>

Parametrar

jobId

string

ID:t för jobbet som innehåller uppgiften.

taskId

string

ID:t för uppgiften som ska avslutas.

options
TaskTerminateOptionalParams

De valfria parametrarna

Returer

Löfte<Models.TaskTerminateResponse>

terminate(string, string, TaskTerminateOptionalParams, ServiceCallback<void>)

function terminate(jobId: string, taskId: string, options: TaskTerminateOptionalParams, callback: ServiceCallback<void>)

Parametrar

jobId

string

ID:t för jobbet som innehåller uppgiften.

taskId

string

ID:t för uppgiften som ska avslutas.

options
TaskTerminateOptionalParams

De valfria parametrarna

callback

ServiceCallback<void>

Återanropet

update(string, string, ServiceCallback<void>)

function update(jobId: string, taskId: string, callback: ServiceCallback<void>)

Parametrar

jobId

string

ID:t för jobbet som innehåller uppgiften.

taskId

string

ID:t för uppgiften som ska uppdateras.

callback

ServiceCallback<void>

Återanropet

update(string, string, TaskUpdateOptionalParams)

Uppdaterar egenskaperna för den angivna aktiviteten.

function update(jobId: string, taskId: string, options?: TaskUpdateOptionalParams): Promise<TaskUpdateResponse>

Parametrar

jobId

string

ID:t för jobbet som innehåller uppgiften.

taskId

string

ID:t för uppgiften som ska uppdateras.

options
TaskUpdateOptionalParams

De valfria parametrarna

Returer

Löfte<Models.TaskUpdateResponse>

update(string, string, TaskUpdateOptionalParams, ServiceCallback<void>)

function update(jobId: string, taskId: string, options: TaskUpdateOptionalParams, callback: ServiceCallback<void>)

Parametrar

jobId

string

ID:t för jobbet som innehåller uppgiften.

taskId

string

ID:t för uppgiften som ska uppdateras.

options
TaskUpdateOptionalParams

De valfria parametrarna

callback

ServiceCallback<void>

Återanropet