Task class
Classe que representa uma Tarefa.
Construtores
| Task(Batch |
Criar uma tarefa. |
Métodos
| add(string, Task |
|
| add(string, Task |
O tempo de vida máximo de uma Tarefa desde a adição até a conclusão é de 180 dias. Se uma tarefa não tiver sido concluída no prazo de 180 dias após ser adicionada, ela será encerrada pelo serviço do Lote e deixada em qualquer estado em que estava naquele momento. |
| add(string, Task |
|
| add |
|
| add |
Observe que cada tarefa deve ter uma ID exclusiva. O serviço lote pode não retornar os resultados de cada Tarefa na mesma ordem em que as Tarefas foram enviadas nesta solicitação. Se o servidor atingir o tempo limite ou a conexão for fechada durante a solicitação, a solicitação poderá ter sido parcial ou totalmente processada ou não. Nesses casos, o usuário deve emitir novamente a solicitação. Observe que cabe ao usuário lidar corretamente com falhas ao emitir novamente uma solicitação. Por exemplo, você deve usar as mesmas IDs de tarefa durante uma repetição para que, se a operação anterior tiver sido bem-sucedida, a repetição não criará tarefas extras inesperadamente. Se a resposta contiver tarefas que não foram adicionadas, um cliente poderá repetir a solicitação. Em uma repetição, é mais eficiente reenviar somente tarefas que não foram adicionadas e omitir tarefas que foram adicionadas com êxito na primeira tentativa. O tempo de vida máximo de uma Tarefa desde a adição até a conclusão é de 180 dias. Se uma tarefa não tiver sido concluída no prazo de 180 dias após ser adicionada, ela será encerrada pelo serviço do Lote e deixada em qualquer estado em que estava naquele momento. |
| add |
|
| delete |
|
| delete |
Quando uma Tarefa é excluída, todos os arquivos em seu diretório no Nó de Computação em que ele foi executado também são excluídos (independentemente do tempo de retenção). Para tarefas de várias instâncias, a operação excluir Tarefa aplica-se de forma síncrona à tarefa primária; as subtarefas e seus arquivos são excluídos de forma assíncrona em segundo plano. |
| delete |
|
| get(string, string, Service |
|
| get(string, string, Task |
Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa primária. Use a API de subtarefas de lista para recuperar informações sobre subtarefas. |
| get(string, string, Task |
|
| list(string, Service |
|
| list(string, Task |
Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa primária. Use a API de subtarefas de lista para recuperar informações sobre subtarefas. |
| list(string, Task |
|
| list |
|
| list |
Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa primária. Use a API de subtarefas de lista para recuperar informações sobre subtarefas. |
| list |
|
| list |
|
| list |
Se a Tarefa não for uma Tarefa de várias instâncias, isso retornará uma coleção vazia. |
| list |
|
| reactivate(string, string, Service |
|
| reactivate(string, string, Task |
A reativação torna uma tarefa elegível para ser repetidamente até sua contagem máxima de repetição. O estado da Tarefa é alterado para ativo. Como a Tarefa não está mais no estado concluído, qualquer código de saída anterior ou informações de falha não estão mais disponíveis após a reativação. Cada vez que uma tarefa é reativada, sua contagem de repetição é redefinida para 0. A reativação falhará para tarefas que não foram concluídas ou que foram concluídas com êxito (com um código de saída de 0). Além disso, ele falhará se o Trabalho tiver sido concluído (ou estiver encerrando ou excluindo). |
| reactivate(string, string, Task |
|
| terminate(string, string, Service |
|
| terminate(string, string, Task |
Quando a Tarefa foi encerrada, ela passa para o estado concluído. Para tarefas de várias instâncias, a operação encerrar Tarefa se aplica de forma síncrona à tarefa primária; As subtarefas são então encerradas de forma assíncrona em segundo plano. |
| terminate(string, string, Task |
|
| update(string, string, Service |
|
| update(string, string, Task |
Atualiza as propriedades da Tarefa especificada. |
| update(string, string, Task |
Detalhes do construtor
Task(BatchServiceClientContext)
Criar uma tarefa.
new Task(client: BatchServiceClientContext)Parâmetros
- client
- BatchServiceClientContext
Referência ao cliente de serviço.
Detalhes do método
add(string, TaskAddParameter, ServiceCallback<void>)
function add(jobId: string, task: TaskAddParameter, callback: ServiceCallback<void>)Parâmetros
- jobId
-
string
A ID do trabalho ao qual a Tarefa deve ser adicionada.
- task
- TaskAddParameter
A Tarefa a ser adicionada.
- callback
-
ServiceCallback<void>
O retorno de chamada
add(string, TaskAddParameter, TaskAddOptionalParams)
O tempo de vida máximo de uma Tarefa desde a adição até a conclusão é de 180 dias. Se uma tarefa não tiver sido concluída no prazo de 180 dias após ser adicionada, ela será encerrada pelo serviço do Lote e deixada em qualquer estado em que estava naquele momento.
function add(jobId: string, task: TaskAddParameter, options?: TaskAddOptionalParams): Promise<TaskAddResponse>Parâmetros
- jobId
-
string
A ID do trabalho ao qual a Tarefa deve ser adicionada.
- task
- TaskAddParameter
A Tarefa a ser adicionada.
- options
- TaskAddOptionalParams
Os parâmetros opcionais
Retornos
Promise<TaskAddResponse>
< Promise>Models.TaskAddResponse
add(string, TaskAddParameter, TaskAddOptionalParams, ServiceCallback<void>)
function add(jobId: string, task: TaskAddParameter, options: TaskAddOptionalParams, callback: ServiceCallback<void>)Parâmetros
- jobId
-
string
A ID do trabalho ao qual a Tarefa deve ser adicionada.
- task
- TaskAddParameter
A Tarefa a ser adicionada.
- options
- TaskAddOptionalParams
Os parâmetros opcionais
- callback
-
ServiceCallback<void>
O retorno de chamada
addCollection(string, TaskAddParameter[], ServiceCallback<TaskAddCollectionResult>)
function addCollection(jobId: string, value: TaskAddParameter[], callback: ServiceCallback<TaskAddCollectionResult>)Parâmetros
- jobId
-
string
A ID do trabalho ao qual a coleção Task deve ser adicionada.
- value
A coleção de Tarefas a serem adicionadas. A contagem máxima de Tarefas é 100. O tamanho total serializado dessa coleção deve ser menor que 1 MB. Se for maior que 1 MB (por exemplo, se cada Tarefa tiver 100 s de arquivos de recurso ou variáveis de ambiente), a solicitação falhará com o código 'RequestBodyTooLarge' e deverá ser repetidamente com menos Tarefas.
- callback
O retorno de chamada
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams)
Observe que cada tarefa deve ter uma ID exclusiva. O serviço lote pode não retornar os resultados de cada Tarefa na mesma ordem em que as Tarefas foram enviadas nesta solicitação. Se o servidor atingir o tempo limite ou a conexão for fechada durante a solicitação, a solicitação poderá ter sido parcial ou totalmente processada ou não. Nesses casos, o usuário deve emitir novamente a solicitação. Observe que cabe ao usuário lidar corretamente com falhas ao emitir novamente uma solicitação. Por exemplo, você deve usar as mesmas IDs de tarefa durante uma repetição para que, se a operação anterior tiver sido bem-sucedida, a repetição não criará tarefas extras inesperadamente. Se a resposta contiver tarefas que não foram adicionadas, um cliente poderá repetir a solicitação. Em uma repetição, é mais eficiente reenviar somente tarefas que não foram adicionadas e omitir tarefas que foram adicionadas com êxito na primeira tentativa. O tempo de vida máximo de uma Tarefa desde a adição até a conclusão é de 180 dias. Se uma tarefa não tiver sido concluída no prazo de 180 dias após ser adicionada, ela será encerrada pelo serviço do Lote e deixada em qualquer estado em que estava naquele momento.
function addCollection(jobId: string, value: TaskAddParameter[], options?: TaskAddCollectionOptionalParams): Promise<TaskAddCollectionResponse>Parâmetros
- jobId
-
string
A ID do trabalho ao qual a coleção Task deve ser adicionada.
- value
A coleção de Tarefas a serem adicionadas. A contagem máxima de Tarefas é 100. O tamanho total serializado dessa coleção deve ser menor que 1 MB. Se for maior que 1 MB (por exemplo, se cada Tarefa tiver 100 s de arquivos de recurso ou variáveis de ambiente), a solicitação falhará com o código 'RequestBodyTooLarge' e deverá ser repetidamente com menos Tarefas.
- options
- TaskAddCollectionOptionalParams
Os parâmetros opcionais
Retornos
Promise<TaskAddCollectionResponse>
< Promise>Models.TaskAddCollectionResponse
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams, ServiceCallback<TaskAddCollectionResult>)
function addCollection(jobId: string, value: TaskAddParameter[], options: TaskAddCollectionOptionalParams, callback: ServiceCallback<TaskAddCollectionResult>)Parâmetros
- jobId
-
string
A ID do trabalho ao qual a coleção Task deve ser adicionada.
- value
A coleção de Tarefas a serem adicionadas. A contagem máxima de Tarefas é 100. O tamanho total serializado dessa coleção deve ser menor que 1 MB. Se for maior que 1 MB (por exemplo, se cada Tarefa tiver 100 s de arquivos de recurso ou variáveis de ambiente), a solicitação falhará com o código 'RequestBodyTooLarge' e deverá ser repetidamente com menos Tarefas.
- options
- TaskAddCollectionOptionalParams
Os parâmetros opcionais
- callback
O retorno de chamada
deleteMethod(string, string, ServiceCallback<void>)
function deleteMethod(jobId: string, taskId: string, callback: ServiceCallback<void>)Parâmetros
- jobId
-
string
A ID do trabalho do qual excluir a Tarefa.
- taskId
-
string
A ID da Tarefa a ser excluída.
- callback
-
ServiceCallback<void>
O retorno de chamada
deleteMethod(string, string, TaskDeleteMethodOptionalParams)
Quando uma Tarefa é excluída, todos os arquivos em seu diretório no Nó de Computação em que ele foi executado também são excluídos (independentemente do tempo de retenção). Para tarefas de várias instâncias, a operação excluir Tarefa aplica-se de forma síncrona à tarefa primária; as subtarefas e seus arquivos são excluídos de forma assíncrona em segundo plano.
function deleteMethod(jobId: string, taskId: string, options?: TaskDeleteMethodOptionalParams): Promise<TaskDeleteResponse>Parâmetros
- jobId
-
string
A ID do trabalho do qual excluir a Tarefa.
- taskId
-
string
A ID da Tarefa a ser excluída.
- options
- TaskDeleteMethodOptionalParams
Os parâmetros opcionais
Retornos
Promise<TaskDeleteResponse>
< Promise>Models.TaskDeleteResponse
deleteMethod(string, string, TaskDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(jobId: string, taskId: string, options: TaskDeleteMethodOptionalParams, callback: ServiceCallback<void>)Parâmetros
- jobId
-
string
A ID do trabalho do qual excluir a Tarefa.
- taskId
-
string
A ID da Tarefa a ser excluída.
- options
- TaskDeleteMethodOptionalParams
Os parâmetros opcionais
- callback
-
ServiceCallback<void>
O retorno de chamada
get(string, string, ServiceCallback<CloudTask>)
function get(jobId: string, taskId: string, callback: ServiceCallback<CloudTask>)Parâmetros
- jobId
-
string
A ID do trabalho que contém a Tarefa.
- taskId
-
string
A ID da Tarefa sobre a qual obter informações.
- callback
O retorno de chamada
get(string, string, TaskGetOptionalParams)
Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa primária. Use a API de subtarefas de lista para recuperar informações sobre subtarefas.
function get(jobId: string, taskId: string, options?: TaskGetOptionalParams): Promise<TaskGetResponse>Parâmetros
- jobId
-
string
A ID do trabalho que contém a Tarefa.
- taskId
-
string
A ID da Tarefa sobre a qual obter informações.
- options
- TaskGetOptionalParams
Os parâmetros opcionais
Retornos
Promise<TaskGetResponse>
< Promise>Models.TaskGetResponse
get(string, string, TaskGetOptionalParams, ServiceCallback<CloudTask>)
function get(jobId: string, taskId: string, options: TaskGetOptionalParams, callback: ServiceCallback<CloudTask>)Parâmetros
- jobId
-
string
A ID do trabalho que contém a Tarefa.
- taskId
-
string
A ID da Tarefa sobre a qual obter informações.
- options
- TaskGetOptionalParams
Os parâmetros opcionais
- callback
O retorno de chamada
list(string, ServiceCallback<CloudTaskListResult>)
function list(jobId: string, callback: ServiceCallback<CloudTaskListResult>)Parâmetros
- jobId
-
string
A ID do trabalho.
- callback
O retorno de chamada
list(string, TaskListOptionalParams)
Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa primária. Use a API de subtarefas de lista para recuperar informações sobre subtarefas.
function list(jobId: string, options?: TaskListOptionalParams): Promise<TaskListResponse>Parâmetros
- jobId
-
string
A ID do trabalho.
- options
- TaskListOptionalParams
Os parâmetros opcionais
Retornos
Promise<TaskListResponse>
< Promise>Models.TaskListResponse
list(string, TaskListOptionalParams, ServiceCallback<CloudTaskListResult>)
function list(jobId: string, options: TaskListOptionalParams, callback: ServiceCallback<CloudTaskListResult>)Parâmetros
- jobId
-
string
A ID do trabalho.
- options
- TaskListOptionalParams
Os parâmetros opcionais
- callback
O retorno de chamada
listNext(string, ServiceCallback<CloudTaskListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudTaskListResult>)Parâmetros
- nextPageLink
-
string
O NextLink da chamada com êxito anterior para a operação List.
- callback
O retorno de chamada
listNext(string, TaskListNextOptionalParams)
Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa primária. Use a API de subtarefas de lista para recuperar informações sobre subtarefas.
function listNext(nextPageLink: string, options?: TaskListNextOptionalParams): Promise<TaskListResponse>Parâmetros
- nextPageLink
-
string
O NextLink da chamada com êxito anterior para a operação List.
- options
- TaskListNextOptionalParams
Os parâmetros opcionais
Retornos
Promise<TaskListResponse>
< Promise>Models.TaskListResponse
listNext(string, TaskListNextOptionalParams, ServiceCallback<CloudTaskListResult>)
function listNext(nextPageLink: string, options: TaskListNextOptionalParams, callback: ServiceCallback<CloudTaskListResult>)Parâmetros
- nextPageLink
-
string
O NextLink da chamada com êxito anterior para a operação List.
- options
- TaskListNextOptionalParams
Os parâmetros opcionais
- callback
O retorno de chamada
listSubtasks(string, string, ServiceCallback<CloudTaskListSubtasksResult>)
function listSubtasks(jobId: string, taskId: string, callback: ServiceCallback<CloudTaskListSubtasksResult>)Parâmetros
- jobId
-
string
A ID do trabalho.
- taskId
-
string
A ID da Tarefa.
- callback
O retorno de chamada
listSubtasks(string, string, TaskListSubtasksOptionalParams)
Se a Tarefa não for uma Tarefa de várias instâncias, isso retornará uma coleção vazia.
function listSubtasks(jobId: string, taskId: string, options?: TaskListSubtasksOptionalParams): Promise<TaskListSubtasksResponse>Parâmetros
- jobId
-
string
A ID do trabalho.
- taskId
-
string
A ID da Tarefa.
- options
- TaskListSubtasksOptionalParams
Os parâmetros opcionais
Retornos
Promise<TaskListSubtasksResponse>
< Promise>Models.TaskListSubtasksResponse
listSubtasks(string, string, TaskListSubtasksOptionalParams, ServiceCallback<CloudTaskListSubtasksResult>)
function listSubtasks(jobId: string, taskId: string, options: TaskListSubtasksOptionalParams, callback: ServiceCallback<CloudTaskListSubtasksResult>)Parâmetros
- jobId
-
string
A ID do trabalho.
- taskId
-
string
A ID da Tarefa.
- options
- TaskListSubtasksOptionalParams
Os parâmetros opcionais
- callback
O retorno de chamada
reactivate(string, string, ServiceCallback<void>)
function reactivate(jobId: string, taskId: string, callback: ServiceCallback<void>)Parâmetros
- jobId
-
string
A ID do trabalho que contém a Tarefa.
- taskId
-
string
A ID da Tarefa a ser reativada.
- callback
-
ServiceCallback<void>
O retorno de chamada
reactivate(string, string, TaskReactivateOptionalParams)
A reativação torna uma tarefa elegível para ser repetidamente até sua contagem máxima de repetição. O estado da Tarefa é alterado para ativo. Como a Tarefa não está mais no estado concluído, qualquer código de saída anterior ou informações de falha não estão mais disponíveis após a reativação. Cada vez que uma tarefa é reativada, sua contagem de repetição é redefinida para 0. A reativação falhará para tarefas que não foram concluídas ou que foram concluídas com êxito (com um código de saída de 0). Além disso, ele falhará se o Trabalho tiver sido concluído (ou estiver encerrando ou excluindo).
function reactivate(jobId: string, taskId: string, options?: TaskReactivateOptionalParams): Promise<TaskReactivateResponse>Parâmetros
- jobId
-
string
A ID do trabalho que contém a Tarefa.
- taskId
-
string
A ID da Tarefa a ser reativada.
- options
- TaskReactivateOptionalParams
Os parâmetros opcionais
Retornos
Promise<TaskReactivateResponse>
< Promise>Models.TaskReactivateResponse
reactivate(string, string, TaskReactivateOptionalParams, ServiceCallback<void>)
function reactivate(jobId: string, taskId: string, options: TaskReactivateOptionalParams, callback: ServiceCallback<void>)Parâmetros
- jobId
-
string
A ID do trabalho que contém a Tarefa.
- taskId
-
string
A ID da Tarefa a ser reativada.
- options
- TaskReactivateOptionalParams
Os parâmetros opcionais
- callback
-
ServiceCallback<void>
O retorno de chamada
terminate(string, string, ServiceCallback<void>)
function terminate(jobId: string, taskId: string, callback: ServiceCallback<void>)Parâmetros
- jobId
-
string
A ID do trabalho que contém a Tarefa.
- taskId
-
string
A ID da Tarefa a ser encerrada.
- callback
-
ServiceCallback<void>
O retorno de chamada
terminate(string, string, TaskTerminateOptionalParams)
Quando a Tarefa foi encerrada, ela passa para o estado concluído. Para tarefas de várias instâncias, a operação encerrar Tarefa se aplica de forma síncrona à tarefa primária; As subtarefas são então encerradas de forma assíncrona em segundo plano.
function terminate(jobId: string, taskId: string, options?: TaskTerminateOptionalParams): Promise<TaskTerminateResponse>Parâmetros
- jobId
-
string
A ID do trabalho que contém a Tarefa.
- taskId
-
string
A ID da Tarefa a ser encerrada.
- options
- TaskTerminateOptionalParams
Os parâmetros opcionais
Retornos
Promise<TaskTerminateResponse>
< Promise>Models.TaskTerminateResponse
terminate(string, string, TaskTerminateOptionalParams, ServiceCallback<void>)
function terminate(jobId: string, taskId: string, options: TaskTerminateOptionalParams, callback: ServiceCallback<void>)Parâmetros
- jobId
-
string
A ID do trabalho que contém a Tarefa.
- taskId
-
string
A ID da Tarefa a ser encerrada.
- options
- TaskTerminateOptionalParams
Os parâmetros opcionais
- callback
-
ServiceCallback<void>
O retorno de chamada
update(string, string, ServiceCallback<void>)
function update(jobId: string, taskId: string, callback: ServiceCallback<void>)Parâmetros
- jobId
-
string
A ID do trabalho que contém a Tarefa.
- taskId
-
string
A ID da Tarefa a ser atualizada.
- callback
-
ServiceCallback<void>
O retorno de chamada
update(string, string, TaskUpdateOptionalParams)
Atualiza as propriedades da Tarefa especificada.
function update(jobId: string, taskId: string, options?: TaskUpdateOptionalParams): Promise<TaskUpdateResponse>Parâmetros
- jobId
-
string
A ID do trabalho que contém a Tarefa.
- taskId
-
string
A ID da Tarefa a ser atualizada.
- options
- TaskUpdateOptionalParams
Os parâmetros opcionais
Retornos
Promise<TaskUpdateResponse>
< Promise>Models.TaskUpdateResponse
update(string, string, TaskUpdateOptionalParams, ServiceCallback<void>)
function update(jobId: string, taskId: string, options: TaskUpdateOptionalParams, callback: ServiceCallback<void>)Parâmetros
- jobId
-
string
A ID do trabalho que contém a Tarefa.
- taskId
-
string
A ID da Tarefa a ser atualizada.
- options
- TaskUpdateOptionalParams
Os parâmetros opcionais
- callback
-
ServiceCallback<void>
O retorno de chamada