Partilhar via


Task class

Classe que representa uma Tarefa.

Construtores

Task(BatchServiceClientContext)

Crie uma tarefa.

Métodos

add(string, TaskAddParameter, ServiceCallback<void>)
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 for concluída dentro de 180 dias após ser adicionada, ela será encerrada pelo serviço de Lote e deixada em qualquer estado em que estivesse naquele momento.

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

Observe que cada Tarefa deve ter uma ID exclusiva. O serviço de 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 expirar ou a conexão for fechada durante a solicitação, a solicitação pode ter sido parcial ou totalmente processada, ou não ter sido processada de todo. Nesses casos, o utilizador deve voltar a emitir o pedido. Observe que cabe ao usuário lidar corretamente com as falhas ao reemitir uma solicitação. Por exemplo, você deve usar as mesmas IDs de Tarefa durante uma nova tentativa para que, se a operação anterior for bem-sucedida, a nova tentativa não crie Tarefas extras inesperadamente. Se a resposta contiver quaisquer Tarefas que não foram adicionadas, um cliente pode repetir a solicitação. Em uma nova tentativa, é mais eficiente reenviar apenas Tarefas que falharam ao adicionar 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 for concluída dentro de 180 dias após ser adicionada, ela será encerrada pelo serviço de Lote e deixada em qualquer estado em que estivesse naquele momento.

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

Quando uma Tarefa é excluída, todos os arquivos em seu diretório no Nó de Computação onde ela foi executada 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 principal; As subtarefas e seus arquivos são excluídos de forma assíncrona em segundo plano.

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

Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à tarefa principal. Use a API de subtarefas de lista para recuperar informações sobre subtarefas.

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

Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à tarefa principal. Use a API de subtarefas de lista para recuperar informações sobre subtarefas.

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

Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à tarefa principal. Use a API de subtarefas de lista para recuperar informações sobre subtarefas.

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

Se a Tarefa não for uma Tarefa de várias instâncias, isso retornará uma coleção vazia.

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

A reativação torna uma Tarefa elegível para ser repetida novamente até sua contagem máxima de tentativas. 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 tentativas é redefinida para 0. A reativação falhará para Tarefas que não foram concluídas ou que foram concluídas anteriormente 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 terminando ou excluindo).

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

Quando a Tarefa for encerrada, ela será movida para o estado concluído. Para Tarefas de várias instâncias, a operação Encerrar Tarefa aplica-se de forma síncrona à tarefa principal; As subtarefas são então encerradas de forma assíncrona em segundo plano.

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

Atualiza as propriedades da Tarefa especificada.

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

Detalhes do Construtor

Task(BatchServiceClientContext)

Crie uma tarefa.

new Task(client: BatchServiceClientContext)

Parâmetros

client
BatchServiceClientContext

Referência ao cliente do serviço.

Detalhes de 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 for concluída dentro de 180 dias após ser adicionada, ela será encerrada pelo serviço de Lote e deixada em qualquer estado em que estivesse 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

Devoluções

Promise<TaskAddResponse>

Modelos de promessa.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 Job ao qual a coleção Task deve ser adicionada.

value

TaskAddParameter[]

A coleção de Tarefas a serem adicionadas. A contagem máxima de tarefas é 100. O tamanho total serializado desta coleção deve ser inferior a 1MB. Se for maior que 1MB (por exemplo, se cada Tarefa tiver 100 de arquivos de recursos ou variáveis de ambiente), a solicitação falhará com o código 'RequestBodyTooLarge' e deverá ser repetida novamente com menos Tarefas.

callback

ServiceCallback<TaskAddCollectionResult>

O retorno de chamada

addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams)

Observe que cada Tarefa deve ter uma ID exclusiva. O serviço de 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 expirar ou a conexão for fechada durante a solicitação, a solicitação pode ter sido parcial ou totalmente processada, ou não ter sido processada de todo. Nesses casos, o utilizador deve voltar a emitir o pedido. Observe que cabe ao usuário lidar corretamente com as falhas ao reemitir uma solicitação. Por exemplo, você deve usar as mesmas IDs de Tarefa durante uma nova tentativa para que, se a operação anterior for bem-sucedida, a nova tentativa não crie Tarefas extras inesperadamente. Se a resposta contiver quaisquer Tarefas que não foram adicionadas, um cliente pode repetir a solicitação. Em uma nova tentativa, é mais eficiente reenviar apenas Tarefas que falharam ao adicionar 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 for concluída dentro de 180 dias após ser adicionada, ela será encerrada pelo serviço de Lote e deixada em qualquer estado em que estivesse naquele momento.

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

Parâmetros

jobId

string

A ID do Job ao qual a coleção Task deve ser adicionada.

value

TaskAddParameter[]

A coleção de Tarefas a serem adicionadas. A contagem máxima de tarefas é 100. O tamanho total serializado desta coleção deve ser inferior a 1MB. Se for maior que 1MB (por exemplo, se cada Tarefa tiver 100 de arquivos de recursos ou variáveis de ambiente), a solicitação falhará com o código 'RequestBodyTooLarge' e deverá ser repetida novamente com menos Tarefas.

options
TaskAddCollectionOptionalParams

Os parâmetros opcionais

Devoluções

Modelos de promessa.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 Job ao qual a coleção Task deve ser adicionada.

value

TaskAddParameter[]

A coleção de Tarefas a serem adicionadas. A contagem máxima de tarefas é 100. O tamanho total serializado desta coleção deve ser inferior a 1MB. Se for maior que 1MB (por exemplo, se cada Tarefa tiver 100 de arquivos de recursos ou variáveis de ambiente), a solicitação falhará com o código 'RequestBodyTooLarge' e deverá ser repetida novamente com menos Tarefas.

options
TaskAddCollectionOptionalParams

Os parâmetros opcionais

callback

ServiceCallback<TaskAddCollectionResult>

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 onde ela foi executada 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 principal; 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

Devoluções

Modelos de Promessa.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

ServiceCallback<CloudTask>

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 principal. 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

Devoluções

Promise<TaskGetResponse>

Modelos de promessa.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

ServiceCallback<CloudTask>

O retorno de chamada

list(string, ServiceCallback<CloudTaskListResult>)

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

Parâmetros

jobId

string

A ID do trabalho.

callback

ServiceCallback<CloudTaskListResult>

O retorno de chamada

list(string, TaskListOptionalParams)

Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à tarefa principal. 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

Devoluções

Promise<TaskListResponse>

Modelos de Promessa.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

ServiceCallback<CloudTaskListResult>

O retorno de chamada

listNext(string, ServiceCallback<CloudTaskListResult>)

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

Parâmetros

nextPageLink

string

O NextLink da operação anterior de chamada bem-sucedida para List.

callback

ServiceCallback<CloudTaskListResult>

O retorno de chamada

listNext(string, TaskListNextOptionalParams)

Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à tarefa principal. 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 operação anterior de chamada bem-sucedida para List.

options
TaskListNextOptionalParams

Os parâmetros opcionais

Devoluções

Promise<TaskListResponse>

Modelos de Promessa.TaskListResponse<>

listNext(string, TaskListNextOptionalParams, ServiceCallback<CloudTaskListResult>)

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

Parâmetros

nextPageLink

string

O NextLink da operação anterior de chamada bem-sucedida para List.

options
TaskListNextOptionalParams

Os parâmetros opcionais

callback

ServiceCallback<CloudTaskListResult>

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

ServiceCallback<CloudTaskListSubtasksResult>

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

Devoluções

Modelos de Promessa.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

ServiceCallback<CloudTaskListSubtasksResult>

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 repetida novamente até sua contagem máxima de tentativas. 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 tentativas é redefinida para 0. A reativação falhará para Tarefas que não foram concluídas ou que foram concluídas anteriormente 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 terminando 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

Devoluções

Modelos de Promessa.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 for encerrada, ela será movida para o estado concluído. Para Tarefas de várias instâncias, a operação Encerrar Tarefa aplica-se de forma síncrona à tarefa principal; 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

Devoluções

Modelos de Promessa.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

Devoluções

Modelos de promessa.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