TaskAddResult Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.TaskAddResult

public class TaskAddResult

Result for a single task added as part of an add task collection operation.

Method Summary

Modifier and Type Method and Description
BatchError error()

Get the error value.
String eTag()

Get 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.
DateTime lastModified()

Get the lastModified value.
String location()

Get the location value.
TaskAddStatus status()

Get possible values include: 'success', 'clientError', 'serverError'.
String taskId()

Get the taskId value.
TaskAddResult withError(BatchError error)

Set the error value.
TaskAddResult withETag(String eTag)

Set 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.
TaskAddResult withLastModified(DateTime lastModified)

Set the lastModified value.
TaskAddResult withLocation(String location)

Set the location value.
TaskAddResult withStatus(TaskAddStatus status)

Set possible values include: 'success', 'clientError', 'serverError'.
TaskAddResult withTaskId(String taskId)

Set the taskId value.

Method Details

error

public BatchError error()

Get the error value.

Returns:

the error value

eTag

public String eTag()

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

Returns:

the eTag value

lastModified

public DateTime lastModified()

Get the lastModified value.

Returns:

the lastModified value

location

public String location()

Get the location value.

Returns:

the location value

status

public TaskAddStatus status()

Get possible values include: 'success', 'clientError', 'serverError'.

Returns:

the status value

taskId

public String taskId()

Get the taskId value.

Returns:

the taskId value

withError

public TaskAddResult withError(BatchError error)

Set the error value.

Parameters:

error - the error value to set

Returns:

the TaskAddResult object itself.

withETag

public TaskAddResult withETag(String eTag)

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

Parameters:

eTag - the eTag value to set

Returns:

the TaskAddResult object itself.

withLastModified

public TaskAddResult withLastModified(DateTime lastModified)

Set the lastModified value.

Parameters:

lastModified - the lastModified value to set

Returns:

the TaskAddResult object itself.

withLocation

public TaskAddResult withLocation(String location)

Set the location value.

Parameters:

location - the location value to set

Returns:

the TaskAddResult object itself.

withStatus

public TaskAddResult withStatus(TaskAddStatus status)

Set possible values include: 'success', 'clientError', 'serverError'.

Parameters:

status - the status value to set

Returns:

the TaskAddResult object itself.

withTaskId

public TaskAddResult withTaskId(String taskId)

Set the taskId value.

Parameters:

taskId - the taskId value to set

Returns:

the TaskAddResult object itself.

Applies to