TaskAddResult interface

Package:

@azure/batch

An interface representing TaskAddResult.

Properties

error	The error encountered while attempting to add the Task.
eTag	The ETag of the Task, if the Task was successfully added. You can use this to detect whether the Task has changed between requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take effect only if nobody else has modified the Job in the meantime.
lastModified	The last modified time of the Task.
location	The URL of the Task, if the Task was successfully added.
status	The status of the add Task request. Possible values include: 'success', 'clientError', 'serverError'
taskId	The ID of the Task for which this is the result.

Property Details

error

The error encountered while attempting to add the Task.

error?: BatchError

Property Value

BatchError

eTag

The ETag of the Task, if the Task was successfully added. You can use this to detect whether the Task has changed between requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take effect only if nobody else has modified the Job in the meantime.

eTag?: string

Property Value

string

lastModified

The last modified time of the Task.

lastModified?: Date

Property Value

Date

location

The URL of the Task, if the Task was successfully added.

location?: string

Property Value

string

status

The status of the add Task request. Possible values include: 'success', 'clientError', 'serverError'

status: TaskAddStatus

Property Value

TaskAddStatus

taskId

The ID of the Task for which this is the result.

taskId: string

Property Value

string