Task class

Paquete:

@azure/batch

Clase que representa una tarea.

Constructores

Task(BatchServiceClientContext)

Cree una tarea.

Métodos

add(string, TaskAddParameter, ServiceCallback<void>)
add(string, TaskAddParameter, TaskAddOptionalParams)	La duración máxima de una tarea a partir de la finalización es de 180 días. Si el servicio Batch no ha completado una tarea en un plazo de 180 días después de agregarla, el servicio Batch finalizará y se dejará en cualquier estado en el que estuviera en ese momento.
add(string, TaskAddParameter, TaskAddOptionalParams, ServiceCallback<void>)
addCollection(string, TaskAddParameter[], ServiceCallback<TaskAddCollectionResult>)
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams)	Tenga en cuenta que cada tarea debe tener un identificador único. Es posible que el servicio Batch no devuelva los resultados de cada tarea en el mismo orden en que se enviaron las tareas en esta solicitud. Si el servidor agota el tiempo de espera o la conexión se cierra durante la solicitud, es posible que la solicitud se haya procesado parcialmente o totalmente, o no en absoluto. En tales casos, el usuario debe volver a emitir la solicitud. Tenga en cuenta que es necesario que el usuario controle correctamente los errores al volver a emitir una solicitud. Por ejemplo, debe usar los mismos identificadores de tarea durante un reintento para que, si la operación anterior se realizó correctamente, el reintento no creará tareas adicionales inesperadamente. Si la respuesta contiene cualquier tarea que no se pudo agregar, un cliente puede reintentar la solicitud. En un reintento, es más eficaz volver a enviar solo tareas que no se pudieron agregar y omitir tareas que se agregaron correctamente en el primer intento. La duración máxima de una tarea a partir de la finalización es de 180 días. Si el servicio Batch no ha completado una tarea en un plazo de 180 días después de agregarla, el servicio Batch finalizará y se dejará en cualquier estado en el que estuviera en ese momento.
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams, ServiceCallback<TaskAddCollectionResult>)
deleteMethod(string, string, ServiceCallback<void>)
deleteMethod(string, string, TaskDeleteMethodOptionalParams)	Cuando se elimina una tarea, todos los archivos de su directorio en el nodo de proceso donde se ejecutó también se eliminan (independientemente del tiempo de retención). En el caso de las tareas de varias instancias, la operación eliminar tarea se aplica sincrónicamente a la tarea principal; Las subtareas y sus archivos se eliminan de forma asincrónica en segundo plano.
deleteMethod(string, string, TaskDeleteMethodOptionalParams, ServiceCallback<void>)
get(string, string, ServiceCallback<CloudTask>)
get(string, string, TaskGetOptionalParams)	Para tareas de varias instancias, la información como affinityId, executionInfo y nodeInfo hacen referencia a la tarea principal. Use la API de subtareas de lista para recuperar información sobre las subtareas.
get(string, string, TaskGetOptionalParams, ServiceCallback<CloudTask>)
list(string, ServiceCallback<CloudTaskListResult>)
list(string, TaskListOptionalParams)	Para tareas de varias instancias, la información como affinityId, executionInfo y nodeInfo hacen referencia a la tarea principal. Use la API de subtareas de lista para recuperar información sobre las subtareas.
list(string, TaskListOptionalParams, ServiceCallback<CloudTaskListResult>)
listNext(string, ServiceCallback<CloudTaskListResult>)
listNext(string, TaskListNextOptionalParams)	Para tareas de varias instancias, la información como affinityId, executionInfo y nodeInfo hacen referencia a la tarea principal. Use la API de subtareas de lista para recuperar información sobre las subtareas.
listNext(string, TaskListNextOptionalParams, ServiceCallback<CloudTaskListResult>)
listSubtasks(string, string, ServiceCallback<CloudTaskListSubtasksResult>)
listSubtasks(string, string, TaskListSubtasksOptionalParams)	Si la tarea no es una tarea de varias instancias, devuelve una colección vacía.
listSubtasks(string, string, TaskListSubtasksOptionalParams, ServiceCallback<CloudTaskListSubtasksResult>)
reactivate(string, string, ServiceCallback<void>)
reactivate(string, string, TaskReactivateOptionalParams)	La reactivación hace que una tarea sea apta para reintentarse de nuevo hasta su recuento máximo de reintentos. El estado de la tarea se cambia a activo. Dado que la tarea ya no está en el estado completado, cualquier código de salida o información de error anterior ya no está disponible después de la reactivación. Cada vez que se reactiva una tarea, su recuento de reintentos se restablece a 0. Se producirá un error en la reactivación de las tareas que no se hayan completado o que se hayan completado correctamente (con un código de salida de 0). Además, se producirá un error si el trabajo se ha completado (o está finalizando o eliminando).
reactivate(string, string, TaskReactivateOptionalParams, ServiceCallback<void>)
terminate(string, string, ServiceCallback<void>)
terminate(string, string, TaskTerminateOptionalParams)	Cuando se ha terminado la tarea, se mueve al estado completado. Para las tareas de varias instancias, la operación finalizar tarea se aplica sincrónicamente a la tarea principal; Las subtareas se finalizan de forma asincrónica en segundo plano.
terminate(string, string, TaskTerminateOptionalParams, ServiceCallback<void>)
update(string, string, ServiceCallback<void>)
update(string, string, TaskUpdateOptionalParams)	Actualiza las propiedades de la tarea especificada.
update(string, string, TaskUpdateOptionalParams, ServiceCallback<void>)

Detalles del constructor

Task(BatchServiceClientContext)

Cree una tarea.

new Task(client: BatchServiceClientContext)

Parámetros

client

BatchServiceClientContext

Referencia al cliente de servicio.

Detalles del método

add(string, TaskAddParameter, ServiceCallback<void>)

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

Parámetros

jobId

string

Identificador del trabajo al que se va a agregar la tarea.

task

TaskAddParameter

Tarea que se va a agregar.

callback

ServiceCallback<void>

Devolución de llamada

add(string, TaskAddParameter, TaskAddOptionalParams)

La duración máxima de una tarea a partir de la finalización es de 180 días. Si el servicio Batch no ha completado una tarea en un plazo de 180 días después de agregarla, el servicio Batch finalizará y se dejará en cualquier estado en el que estuviera en ese momento.

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

Parámetros

jobId

string

Identificador del trabajo al que se va a agregar la tarea.

task

TaskAddParameter

Tarea que se va a agregar.

options

TaskAddOptionalParams

Los parámetros opcionales

Devoluciones

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

Identificador del trabajo al que se va a agregar la tarea.

task

TaskAddParameter

Tarea que se va a agregar.

options

TaskAddOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

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

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

Parámetros

jobId

string

Identificador del trabajo al que se va a agregar la colección Task.

value

TaskAddParameter[]

Colección de Tareas que se van a agregar. El número máximo de tareas es 100. El tamaño total serializado de esta colección debe ser inferior a 1 MB. Si es mayor que 1 MB (por ejemplo, si cada tarea tiene 100 de archivos de recursos o variables de entorno), la solicitud producirá un error con el código "RequestBodyTooLarge" y se volverá a intentar con menos tareas.

callback

ServiceCallback<TaskAddCollectionResult>

Devolución de llamada

addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams)

Tenga en cuenta que cada tarea debe tener un identificador único. Es posible que el servicio Batch no devuelva los resultados de cada tarea en el mismo orden en que se enviaron las tareas en esta solicitud. Si el servidor agota el tiempo de espera o la conexión se cierra durante la solicitud, es posible que la solicitud se haya procesado parcialmente o totalmente, o no en absoluto. En tales casos, el usuario debe volver a emitir la solicitud. Tenga en cuenta que es necesario que el usuario controle correctamente los errores al volver a emitir una solicitud. Por ejemplo, debe usar los mismos identificadores de tarea durante un reintento para que, si la operación anterior se realizó correctamente, el reintento no creará tareas adicionales inesperadamente. Si la respuesta contiene cualquier tarea que no se pudo agregar, un cliente puede reintentar la solicitud. En un reintento, es más eficaz volver a enviar solo tareas que no se pudieron agregar y omitir tareas que se agregaron correctamente en el primer intento. La duración máxima de una tarea a partir de la finalización es de 180 días. Si el servicio Batch no ha completado una tarea en un plazo de 180 días después de agregarla, el servicio Batch finalizará y se dejará en cualquier estado en el que estuviera en ese momento.

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

Parámetros

jobId

string

Identificador del trabajo al que se va a agregar la colección Task.

value

TaskAddParameter[]

Colección de Tareas que se van a agregar. El número máximo de tareas es 100. El tamaño total serializado de esta colección debe ser inferior a 1 MB. Si es mayor que 1 MB (por ejemplo, si cada tarea tiene 100 de archivos de recursos o variables de entorno), la solicitud producirá un error con el código "RequestBodyTooLarge" y se volverá a intentar con menos tareas.

options

TaskAddCollectionOptionalParams

Los parámetros opcionales

Devoluciones

Promise<TaskAddCollectionResponse>

Modelos de promesas.TaskAddCollectionResponse<>

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

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

Parámetros

jobId

string

Identificador del trabajo al que se va a agregar la colección Task.

value

TaskAddParameter[]

Colección de Tareas que se van a agregar. El número máximo de tareas es 100. El tamaño total serializado de esta colección debe ser inferior a 1 MB. Si es mayor que 1 MB (por ejemplo, si cada tarea tiene 100 de archivos de recursos o variables de entorno), la solicitud producirá un error con el código "RequestBodyTooLarge" y se volverá a intentar con menos tareas.

options

TaskAddCollectionOptionalParams

Los parámetros opcionales

callback

ServiceCallback<TaskAddCollectionResult>

Devolución de llamada

deleteMethod(string, string, ServiceCallback<void>)

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

Parámetros

jobId

string

Identificador del trabajo del que se va a eliminar la tarea.

taskId

string

Identificador de la tarea que se va a eliminar.

callback

ServiceCallback<void>

Devolución de llamada

deleteMethod(string, string, TaskDeleteMethodOptionalParams)

Cuando se elimina una tarea, todos los archivos de su directorio en el nodo de proceso donde se ejecutó también se eliminan (independientemente del tiempo de retención). En el caso de las tareas de varias instancias, la operación eliminar tarea se aplica sincrónicamente a la tarea principal; Las subtareas y sus archivos se eliminan de forma asincrónica en segundo plano.

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

Parámetros

jobId

string

Identificador del trabajo del que se va a eliminar la tarea.

taskId

string

Identificador de la tarea que se va a eliminar.

options

TaskDeleteMethodOptionalParams

Los parámetros opcionales

Devoluciones

Promise<TaskDeleteResponse>

Modelos de promesas.TaskDeleteResponse<>

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

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

Parámetros

jobId

string

Identificador del trabajo del que se va a eliminar la tarea.

taskId

string

Identificador de la tarea que se va a eliminar.

options

TaskDeleteMethodOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

get(string, string, ServiceCallback<CloudTask>)

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

Parámetros

jobId

string

Identificador del trabajo que contiene la tarea.

taskId

string

Identificador de la tarea para obtener información sobre.

callback

ServiceCallback<CloudTask>

Devolución de llamada

get(string, string, TaskGetOptionalParams)

Para tareas de varias instancias, la información como affinityId, executionInfo y nodeInfo hacen referencia a la tarea principal. Use la API de subtareas de lista para recuperar información sobre las subtareas.

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

Parámetros

jobId

string

Identificador del trabajo que contiene la tarea.

taskId

string

Identificador de la tarea para obtener información sobre.

options

TaskGetOptionalParams

Los parámetros opcionales

Devoluciones

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

Identificador del trabajo que contiene la tarea.

taskId

string

Identificador de la tarea para obtener información sobre.

options

TaskGetOptionalParams

Los parámetros opcionales

callback

ServiceCallback<CloudTask>

Devolución de llamada

list(string, ServiceCallback<CloudTaskListResult>)

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

Parámetros

jobId

string

Identificador del trabajo.

callback

ServiceCallback<CloudTaskListResult>

Devolución de llamada

list(string, TaskListOptionalParams)

Para tareas de varias instancias, la información como affinityId, executionInfo y nodeInfo hacen referencia a la tarea principal. Use la API de subtareas de lista para recuperar información sobre las subtareas.

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

Parámetros

jobId

string

Identificador del trabajo.

options

TaskListOptionalParams

Los parámetros opcionales

Devoluciones

Promise<TaskListResponse>

< Promise>Models.TaskListResponse

list(string, TaskListOptionalParams, ServiceCallback<CloudTaskListResult>)

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

Parámetros

jobId

string

Identificador del trabajo.

options

TaskListOptionalParams

Los parámetros opcionales

callback

ServiceCallback<CloudTaskListResult>

Devolución de llamada

listNext(string, ServiceCallback<CloudTaskListResult>)

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

Parámetros

nextPageLink

string

NextLink de la llamada correcta anterior a la operación List.

callback

ServiceCallback<CloudTaskListResult>

Devolución de llamada

listNext(string, TaskListNextOptionalParams)

Para tareas de varias instancias, la información como affinityId, executionInfo y nodeInfo hacen referencia a la tarea principal. Use la API de subtareas de lista para recuperar información sobre las subtareas.

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

Parámetros

nextPageLink

string

NextLink de la llamada correcta anterior a la operación List.

options

TaskListNextOptionalParams

Los parámetros opcionales

Devoluciones

Promise<TaskListResponse>

< Promise>Models.TaskListResponse

listNext(string, TaskListNextOptionalParams, ServiceCallback<CloudTaskListResult>)

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

Parámetros

nextPageLink

string

NextLink de la llamada correcta anterior a la operación List.

options

TaskListNextOptionalParams

Los parámetros opcionales

callback

ServiceCallback<CloudTaskListResult>

Devolución de llamada

listSubtasks(string, string, ServiceCallback<CloudTaskListSubtasksResult>)

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

Parámetros

jobId

string

Identificador del trabajo.

taskId

string

Identificador de la tarea.

callback

ServiceCallback<CloudTaskListSubtasksResult>

Devolución de llamada

listSubtasks(string, string, TaskListSubtasksOptionalParams)

Si la tarea no es una tarea de varias instancias, devuelve una colección vacía.

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

Parámetros

jobId

string

Identificador del trabajo.

taskId

string

Identificador de la tarea.

options

TaskListSubtasksOptionalParams

Los parámetros opcionales

Devoluciones

Promise<TaskListSubtasksResponse>

Modelos de promesas.TaskListSubtasksResponse<>

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

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

Parámetros

jobId

string

Identificador del trabajo.

taskId

string

Identificador de la tarea.

options

TaskListSubtasksOptionalParams

Los parámetros opcionales

callback

ServiceCallback<CloudTaskListSubtasksResult>

Devolución de llamada

reactivate(string, string, ServiceCallback<void>)

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

Parámetros

jobId

string

Identificador del trabajo que contiene la tarea.

taskId

string

Identificador de la tarea que se va a reactivar.

callback

ServiceCallback<void>

Devolución de llamada

reactivate(string, string, TaskReactivateOptionalParams)

La reactivación hace que una tarea sea apta para reintentarse de nuevo hasta su recuento máximo de reintentos. El estado de la tarea se cambia a activo. Dado que la tarea ya no está en el estado completado, cualquier código de salida o información de error anterior ya no está disponible después de la reactivación. Cada vez que se reactiva una tarea, su recuento de reintentos se restablece a 0. Se producirá un error en la reactivación de las tareas que no se hayan completado o que se hayan completado correctamente (con un código de salida de 0). Además, se producirá un error si el trabajo se ha completado (o está finalizando o eliminando).

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

Parámetros

jobId

string

Identificador del trabajo que contiene la tarea.

taskId

string

Identificador de la tarea que se va a reactivar.

options

TaskReactivateOptionalParams

Los parámetros opcionales

Devoluciones

Promise<TaskReactivateResponse>

Modelos de promesa.TaskReactivateResponse<>

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

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

Parámetros

jobId

string

Identificador del trabajo que contiene la tarea.

taskId

string

Identificador de la tarea que se va a reactivar.

options

TaskReactivateOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

terminate(string, string, ServiceCallback<void>)

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

Parámetros

jobId

string

Identificador del trabajo que contiene la tarea.

taskId

string

Identificador de la tarea que se va a finalizar.

callback

ServiceCallback<void>

Devolución de llamada

terminate(string, string, TaskTerminateOptionalParams)

Cuando se ha terminado la tarea, se mueve al estado completado. Para las tareas de varias instancias, la operación finalizar tarea se aplica sincrónicamente a la tarea principal; Las subtareas se finalizan de forma asincrónica en segundo plano.

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

Parámetros

jobId

string

Identificador del trabajo que contiene la tarea.

taskId

string

Identificador de la tarea que se va a finalizar.

options

TaskTerminateOptionalParams

Los parámetros opcionales

Devoluciones

Promise<TaskTerminateResponse>

Modelos de promesas.TaskTerminateResponse<>

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

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

Parámetros

jobId

string

Identificador del trabajo que contiene la tarea.

taskId

string

Identificador de la tarea que se va a finalizar.

options

TaskTerminateOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

update(string, string, ServiceCallback<void>)

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

Parámetros

jobId

string

Identificador del trabajo que contiene la tarea.

taskId

string

Identificador de la tarea que se va a actualizar.

callback

ServiceCallback<void>

Devolución de llamada

update(string, string, TaskUpdateOptionalParams)

Actualiza las propiedades de la tarea especificada.

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

Parámetros

jobId

string

Identificador del trabajo que contiene la tarea.

taskId

string

Identificador de la tarea que se va a actualizar.

options

TaskUpdateOptionalParams

Los parámetros opcionales

Devoluciones

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

Identificador del trabajo que contiene la tarea.

taskId

string

Identificador de la tarea que se va a actualizar.

options

TaskUpdateOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada