Tasks Interface

public interface Tasks

An instance of this class provides access to all the operations defined in Tasks.

Method Summary

Modifier and Type Method and Description
abstract void add(String jobId, TaskAddParameter task)

Adds a Task to the specified Job.

abstract void add(String jobId, TaskAddParameter task, TaskAddOptions taskAddOptions)

Adds a Task to the specified Job.

abstract rx.Observable<Void> addAsync(String jobId, TaskAddParameter task)

Adds a Task to the specified Job.

abstract rx.Observable<Void> addAsync(String jobId, TaskAddParameter task, TaskAddOptions taskAddOptions)

Adds a Task to the specified Job.

abstract com.microsoft.rest.ServiceFuture<Void> addAsync(String jobId, TaskAddParameter task, TaskAddOptions taskAddOptions, ServiceCallback<Void> serviceCallback)

Adds a Task to the specified Job.

abstract com.microsoft.rest.ServiceFuture<Void> addAsync(String jobId, TaskAddParameter task, ServiceCallback<Void> serviceCallback)

Adds a Task to the specified Job.

abstract TaskAddCollectionResult addCollection(String jobId, List<TaskAddParameter> value)

Adds a collection of Tasks to the specified Job.

abstract TaskAddCollectionResult addCollection(String jobId, List<TaskAddParameter> value, TaskAddCollectionOptions taskAddCollectionOptions)

Adds a collection of Tasks to the specified Job.

abstract rx.Observable<TaskAddCollectionResult> addCollectionAsync(String jobId, List<TaskAddParameter> value)

Adds a collection of Tasks to the specified Job.

abstract rx.Observable<TaskAddCollectionResult> addCollectionAsync(String jobId, List<TaskAddParameter> value, TaskAddCollectionOptions taskAddCollectionOptions)

Adds a collection of Tasks to the specified Job.

abstract com.microsoft.rest.ServiceFuture<TaskAddCollectionResult> addCollectionAsync(String jobId, List<TaskAddParameter> value, TaskAddCollectionOptions taskAddCollectionOptions, ServiceCallback<TaskAddCollectionResult> serviceCallback)

Adds a collection of Tasks to the specified Job.

abstract com.microsoft.rest.ServiceFuture<TaskAddCollectionResult> addCollectionAsync(String jobId, List<TaskAddParameter> value, ServiceCallback<TaskAddCollectionResult> serviceCallback)

Adds a collection of Tasks to the specified Job.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<TaskAddCollectionResult,TaskAddCollectionHeaders>> addCollectionWithServiceResponseAsync(String jobId, List<TaskAddParameter> value)

Adds a collection of Tasks to the specified Job.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<TaskAddCollectionResult,TaskAddCollectionHeaders>> addCollectionWithServiceResponseAsync(String jobId, List<TaskAddParameter> value, TaskAddCollectionOptions taskAddCollectionOptions)

Adds a collection of Tasks to the specified Job.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,TaskAddHeaders>> addWithServiceResponseAsync(String jobId, TaskAddParameter task)

Adds a Task to the specified Job.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,TaskAddHeaders>> addWithServiceResponseAsync(String jobId, TaskAddParameter task, TaskAddOptions taskAddOptions)

Adds a Task to the specified Job.

abstract void delete(String jobId, String taskId)

Deletes a Task from the specified Job.

abstract void delete(String jobId, String taskId, TaskDeleteOptions taskDeleteOptions)

Deletes a Task from the specified Job.

abstract rx.Observable<Void> deleteAsync(String jobId, String taskId)

Deletes a Task from the specified Job.

abstract rx.Observable<Void> deleteAsync(String jobId, String taskId, TaskDeleteOptions taskDeleteOptions)

Deletes a Task from the specified Job.

abstract com.microsoft.rest.ServiceFuture<Void> deleteAsync(String jobId, String taskId, TaskDeleteOptions taskDeleteOptions, ServiceCallback<Void> serviceCallback)

Deletes a Task from the specified Job.

abstract com.microsoft.rest.ServiceFuture<Void> deleteAsync(String jobId, String taskId, ServiceCallback<Void> serviceCallback)

Deletes a Task from the specified Job.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,TaskDeleteHeaders>> deleteWithServiceResponseAsync(String jobId, String taskId)

Deletes a Task from the specified Job.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,TaskDeleteHeaders>> deleteWithServiceResponseAsync(String jobId, String taskId, TaskDeleteOptions taskDeleteOptions)

Deletes a Task from the specified Job.

abstract CloudTask get(String jobId, String taskId)

Gets information about the specified Task.

abstract CloudTask get(String jobId, String taskId, TaskGetOptions taskGetOptions)

Gets information about the specified Task.

abstract rx.Observable<CloudTask> getAsync(String jobId, String taskId)

Gets information about the specified Task.

abstract rx.Observable<CloudTask> getAsync(String jobId, String taskId, TaskGetOptions taskGetOptions)

Gets information about the specified Task.

abstract com.microsoft.rest.ServiceFuture<CloudTask> getAsync(String jobId, String taskId, TaskGetOptions taskGetOptions, ServiceCallback<CloudTask> serviceCallback)

Gets information about the specified Task.

abstract com.microsoft.rest.ServiceFuture<CloudTask> getAsync(String jobId, String taskId, ServiceCallback<CloudTask> serviceCallback)

Gets information about the specified Task.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<CloudTask,TaskGetHeaders>> getWithServiceResponseAsync(String jobId, String taskId)

Gets information about the specified Task.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<CloudTask,TaskGetHeaders>> getWithServiceResponseAsync(String jobId, String taskId, TaskGetOptions taskGetOptions)

Gets information about the specified Task.

abstract com.microsoft.azure.PagedList<CloudTask> list(String jobId)

Lists all of the Tasks that are associated with the specified Job.

abstract com.microsoft.azure.PagedList<CloudTask> list(String jobId, TaskListOptions taskListOptions)

Lists all of the Tasks that are associated with the specified Job.

abstract rx.Observable<com.microsoft.azure.Page<CloudTask>> listAsync(String jobId)

Lists all of the Tasks that are associated with the specified Job.

abstract com.microsoft.rest.ServiceFuture<List<CloudTask>> listAsync(String jobId, ListOperationCallback<CloudTask> serviceCallback)

Lists all of the Tasks that are associated with the specified Job.

abstract rx.Observable<com.microsoft.azure.Page<CloudTask>> listAsync(String jobId, TaskListOptions taskListOptions)

Lists all of the Tasks that are associated with the specified Job.

abstract com.microsoft.rest.ServiceFuture<List<CloudTask>> listAsync(String jobId, TaskListOptions taskListOptions, ListOperationCallback<CloudTask> serviceCallback)

Lists all of the Tasks that are associated with the specified Job.

abstract com.microsoft.azure.PagedList<CloudTask> listNext(String nextPageLink)

Lists all of the Tasks that are associated with the specified Job.

abstract com.microsoft.azure.PagedList<CloudTask> listNext(String nextPageLink, TaskListNextOptions taskListNextOptions)

Lists all of the Tasks that are associated with the specified Job.

abstract rx.Observable<com.microsoft.azure.Page<CloudTask>> listNextAsync(String nextPageLink)

Lists all of the Tasks that are associated with the specified Job.

abstract rx.Observable<com.microsoft.azure.Page<CloudTask>> listNextAsync(String nextPageLink, TaskListNextOptions taskListNextOptions)

Lists all of the Tasks that are associated with the specified Job.

abstract com.microsoft.rest.ServiceFuture<List<CloudTask>> listNextAsync(String nextPageLink, TaskListNextOptions taskListNextOptions, ServiceFuture<List<CloudTask>> serviceFuture, ListOperationCallback<CloudTask> serviceCallback)

Lists all of the Tasks that are associated with the specified Job.

abstract com.microsoft.rest.ServiceFuture<List<CloudTask>> listNextAsync(String nextPageLink, ServiceFuture<List<CloudTask>> serviceFuture, ListOperationCallback<CloudTask> serviceCallback)

Lists all of the Tasks that are associated with the specified Job.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<com.microsoft.azure.Page<CloudTask>,TaskListHeaders>> listNextWithServiceResponseAsync(String nextPageLink)

Lists all of the Tasks that are associated with the specified Job.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<com.microsoft.azure.Page<CloudTask>,TaskListHeaders>> listNextWithServiceResponseAsync(String nextPageLink, TaskListNextOptions taskListNextOptions)

Lists all of the Tasks that are associated with the specified Job.

abstract CloudTaskListSubtasksResult listSubtasks(String jobId, String taskId)

Lists all of the subtasks that are associated with the specified multi-instance Task.

abstract CloudTaskListSubtasksResult listSubtasks(String jobId, String taskId, TaskListSubtasksOptions taskListSubtasksOptions)

Lists all of the subtasks that are associated with the specified multi-instance Task.

abstract rx.Observable<CloudTaskListSubtasksResult> listSubtasksAsync(String jobId, String taskId)

Lists all of the subtasks that are associated with the specified multi-instance Task.

abstract rx.Observable<CloudTaskListSubtasksResult> listSubtasksAsync(String jobId, String taskId, TaskListSubtasksOptions taskListSubtasksOptions)

Lists all of the subtasks that are associated with the specified multi-instance Task.

abstract com.microsoft.rest.ServiceFuture<CloudTaskListSubtasksResult> listSubtasksAsync(String jobId, String taskId, TaskListSubtasksOptions taskListSubtasksOptions, ServiceCallback<CloudTaskListSubtasksResult> serviceCallback)

Lists all of the subtasks that are associated with the specified multi-instance Task.

abstract com.microsoft.rest.ServiceFuture<CloudTaskListSubtasksResult> listSubtasksAsync(String jobId, String taskId, ServiceCallback<CloudTaskListSubtasksResult> serviceCallback)

Lists all of the subtasks that are associated with the specified multi-instance Task.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<CloudTaskListSubtasksResult,TaskListSubtasksHeaders>> listSubtasksWithServiceResponseAsync(String jobId, String taskId)

Lists all of the subtasks that are associated with the specified multi-instance Task.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<CloudTaskListSubtasksResult,TaskListSubtasksHeaders>> listSubtasksWithServiceResponseAsync(String jobId, String taskId, TaskListSubtasksOptions taskListSubtasksOptions)

Lists all of the subtasks that are associated with the specified multi-instance Task.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<com.microsoft.azure.Page<CloudTask>,TaskListHeaders>> listWithServiceResponseAsync(String jobId)

Lists all of the Tasks that are associated with the specified Job.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<com.microsoft.azure.Page<CloudTask>,TaskListHeaders>> listWithServiceResponseAsync(String jobId, TaskListOptions taskListOptions)

Lists all of the Tasks that are associated with the specified Job.

abstract void reactivate(String jobId, String taskId)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted.

abstract void reactivate(String jobId, String taskId, TaskReactivateOptions taskReactivateOptions)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted.

abstract rx.Observable<Void> reactivateAsync(String jobId, String taskId)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted.

abstract rx.Observable<Void> reactivateAsync(String jobId, String taskId, TaskReactivateOptions taskReactivateOptions)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted.

abstract com.microsoft.rest.ServiceFuture<Void> reactivateAsync(String jobId, String taskId, TaskReactivateOptions taskReactivateOptions, ServiceCallback<Void> serviceCallback)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted.

abstract com.microsoft.rest.ServiceFuture<Void> reactivateAsync(String jobId, String taskId, ServiceCallback<Void> serviceCallback)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,TaskReactivateHeaders>> reactivateWithServiceResponseAsync(String jobId, String taskId)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,TaskReactivateHeaders>> reactivateWithServiceResponseAsync(String jobId, String taskId, TaskReactivateOptions taskReactivateOptions)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted.

abstract void terminate(String jobId, String taskId)

Terminates the specified Task.

abstract void terminate(String jobId, String taskId, TaskTerminateOptions taskTerminateOptions)

Terminates the specified Task.

abstract rx.Observable<Void> terminateAsync(String jobId, String taskId)

Terminates the specified Task.

abstract rx.Observable<Void> terminateAsync(String jobId, String taskId, TaskTerminateOptions taskTerminateOptions)

Terminates the specified Task.

abstract com.microsoft.rest.ServiceFuture<Void> terminateAsync(String jobId, String taskId, TaskTerminateOptions taskTerminateOptions, ServiceCallback<Void> serviceCallback)

Terminates the specified Task.

abstract com.microsoft.rest.ServiceFuture<Void> terminateAsync(String jobId, String taskId, ServiceCallback<Void> serviceCallback)

Terminates the specified Task.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,TaskTerminateHeaders>> terminateWithServiceResponseAsync(String jobId, String taskId)

Terminates the specified Task.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,TaskTerminateHeaders>> terminateWithServiceResponseAsync(String jobId, String taskId, TaskTerminateOptions taskTerminateOptions)

Terminates the specified Task.

abstract void update(String jobId, String taskId)

Updates the properties of the specified Task.

abstract void update(String jobId, String taskId, TaskConstraints constraints, TaskUpdateOptions taskUpdateOptions)

Updates the properties of the specified Task.

abstract rx.Observable<Void> updateAsync(String jobId, String taskId)

Updates the properties of the specified Task.

abstract rx.Observable<Void> updateAsync(String jobId, String taskId, TaskConstraints constraints, TaskUpdateOptions taskUpdateOptions)

Updates the properties of the specified Task.

abstract com.microsoft.rest.ServiceFuture<Void> updateAsync(String jobId, String taskId, TaskConstraints constraints, TaskUpdateOptions taskUpdateOptions, ServiceCallback<Void> serviceCallback)

Updates the properties of the specified Task.

abstract com.microsoft.rest.ServiceFuture<Void> updateAsync(String jobId, String taskId, ServiceCallback<Void> serviceCallback)

Updates the properties of the specified Task.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,TaskUpdateHeaders>> updateWithServiceResponseAsync(String jobId, String taskId)

Updates the properties of the specified Task.

abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,TaskUpdateHeaders>> updateWithServiceResponseAsync(String jobId, String taskId, TaskConstraints constraints, TaskUpdateOptions taskUpdateOptions)

Updates the properties of the specified Task.

Method Details

add

public abstract void add(String jobId, TaskAddParameter task)

Adds a Task to the specified Job. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task is to be added.
task - The Task to be added.

add

public abstract void add(String jobId, TaskAddParameter task, TaskAddOptions taskAddOptions)

Adds a Task to the specified Job. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task is to be added.
task - The Task to be added.
taskAddOptions - Additional parameters for the operation

addAsync

public abstract Observable addAsync(String jobId, TaskAddParameter task)

Adds a Task to the specified Job. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task is to be added.
task - The Task to be added.

Returns:

the ServiceResponseWithHeaders object if successful.

addAsync

public abstract Observable addAsync(String jobId, TaskAddParameter task, TaskAddOptions taskAddOptions)

Adds a Task to the specified Job. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task is to be added.
task - The Task to be added.
taskAddOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

addAsync

public abstract ServiceFuture addAsync(String jobId, TaskAddParameter task, TaskAddOptions taskAddOptions, ServiceCallback serviceCallback)

Adds a Task to the specified Job. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task is to be added.
task - The Task to be added.
taskAddOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

addAsync

public abstract ServiceFuture addAsync(String jobId, TaskAddParameter task, ServiceCallback serviceCallback)

Adds a Task to the specified Job. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task is to be added.
task - The Task to be added.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

addCollection

public abstract TaskAddCollectionResult addCollection(String jobId, List value)

Adds a collection of Tasks to the specified Job. Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task collection is to be added.
value - The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks.

Returns:

the TaskAddCollectionResult object if successful.

addCollection

public abstract TaskAddCollectionResult addCollection(String jobId, List value, TaskAddCollectionOptions taskAddCollectionOptions)

Adds a collection of Tasks to the specified Job. Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task collection is to be added.
value - The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks.
taskAddCollectionOptions - Additional parameters for the operation

Returns:

the TaskAddCollectionResult object if successful.

addCollectionAsync

public abstract Observable addCollectionAsync(String jobId, List value)

Adds a collection of Tasks to the specified Job. Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task collection is to be added.
value - The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks.

Returns:

the observable to the TaskAddCollectionResult object

addCollectionAsync

public abstract Observable addCollectionAsync(String jobId, List value, TaskAddCollectionOptions taskAddCollectionOptions)

Adds a collection of Tasks to the specified Job. Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task collection is to be added.
value - The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks.
taskAddCollectionOptions - Additional parameters for the operation

Returns:

the observable to the TaskAddCollectionResult object

addCollectionAsync

public abstract ServiceFuture addCollectionAsync(String jobId, List value, TaskAddCollectionOptions taskAddCollectionOptions, ServiceCallback serviceCallback)

Adds a collection of Tasks to the specified Job. Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task collection is to be added.
value - The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks.
taskAddCollectionOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

addCollectionAsync

public abstract ServiceFuture addCollectionAsync(String jobId, List value, ServiceCallback serviceCallback)

Adds a collection of Tasks to the specified Job. Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task collection is to be added.
value - The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

addCollectionWithServiceResponseAsync

public abstract Observable<>> addCollectionWithServiceResponseAsync(String jobId, List value)

Adds a collection of Tasks to the specified Job. Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task collection is to be added.
value - The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks.

Returns:

the observable to the TaskAddCollectionResult object

addCollectionWithServiceResponseAsync

public abstract Observable<>> addCollectionWithServiceResponseAsync(String jobId, List value, TaskAddCollectionOptions taskAddCollectionOptions)

Adds a collection of Tasks to the specified Job. Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task collection is to be added.
value - The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks.
taskAddCollectionOptions - Additional parameters for the operation

Returns:

the observable to the TaskAddCollectionResult object

addWithServiceResponseAsync

public abstract Observable<>> addWithServiceResponseAsync(String jobId, TaskAddParameter task)

Adds a Task to the specified Job. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task is to be added.
task - The Task to be added.

Returns:

the ServiceResponseWithHeaders object if successful.

addWithServiceResponseAsync

public abstract Observable<>> addWithServiceResponseAsync(String jobId, TaskAddParameter task, TaskAddOptions taskAddOptions)

Adds a Task to the specified Job. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Parameters:

jobId - The ID of the Job to which the Task is to be added.
task - The Task to be added.
taskAddOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

delete

public abstract void delete(String jobId, String taskId)

Deletes a Task from the specified Job. When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.

Parameters:

jobId - The ID of the Job from which to delete the Task.
taskId - The ID of the Task to delete.

delete

public abstract void delete(String jobId, String taskId, TaskDeleteOptions taskDeleteOptions)

Deletes a Task from the specified Job. When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.

Parameters:

jobId - The ID of the Job from which to delete the Task.
taskId - The ID of the Task to delete.
taskDeleteOptions - Additional parameters for the operation

deleteAsync

public abstract Observable deleteAsync(String jobId, String taskId)

Deletes a Task from the specified Job. When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.

Parameters:

jobId - The ID of the Job from which to delete the Task.
taskId - The ID of the Task to delete.

Returns:

the ServiceResponseWithHeaders object if successful.

deleteAsync

public abstract Observable deleteAsync(String jobId, String taskId, TaskDeleteOptions taskDeleteOptions)

Deletes a Task from the specified Job. When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.

Parameters:

jobId - The ID of the Job from which to delete the Task.
taskId - The ID of the Task to delete.
taskDeleteOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

deleteAsync

public abstract ServiceFuture deleteAsync(String jobId, String taskId, TaskDeleteOptions taskDeleteOptions, ServiceCallback serviceCallback)

Deletes a Task from the specified Job. When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.

Parameters:

jobId - The ID of the Job from which to delete the Task.
taskId - The ID of the Task to delete.
taskDeleteOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

deleteAsync

public abstract ServiceFuture deleteAsync(String jobId, String taskId, ServiceCallback serviceCallback)

Deletes a Task from the specified Job. When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.

Parameters:

jobId - The ID of the Job from which to delete the Task.
taskId - The ID of the Task to delete.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

deleteWithServiceResponseAsync

public abstract Observable<>> deleteWithServiceResponseAsync(String jobId, String taskId)

Deletes a Task from the specified Job. When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.

Parameters:

jobId - The ID of the Job from which to delete the Task.
taskId - The ID of the Task to delete.

Returns:

the ServiceResponseWithHeaders object if successful.

deleteWithServiceResponseAsync

public abstract Observable<>> deleteWithServiceResponseAsync(String jobId, String taskId, TaskDeleteOptions taskDeleteOptions)

Deletes a Task from the specified Job. When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.

Parameters:

jobId - The ID of the Job from which to delete the Task.
taskId - The ID of the Task to delete.
taskDeleteOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

get

public abstract CloudTask get(String jobId, String taskId)

Gets information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job that contains the Task.
taskId - The ID of the Task to get information about.

Returns:

the CloudTask object if successful.

get

public abstract CloudTask get(String jobId, String taskId, TaskGetOptions taskGetOptions)

Gets information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job that contains the Task.
taskId - The ID of the Task to get information about.
taskGetOptions - Additional parameters for the operation

Returns:

the CloudTask object if successful.

getAsync

public abstract Observable getAsync(String jobId, String taskId)

Gets information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job that contains the Task.
taskId - The ID of the Task to get information about.

Returns:

the observable to the CloudTask object

getAsync

public abstract Observable getAsync(String jobId, String taskId, TaskGetOptions taskGetOptions)

Gets information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job that contains the Task.
taskId - The ID of the Task to get information about.
taskGetOptions - Additional parameters for the operation

Returns:

the observable to the CloudTask object

getAsync

public abstract ServiceFuture getAsync(String jobId, String taskId, TaskGetOptions taskGetOptions, ServiceCallback serviceCallback)

Gets information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job that contains the Task.
taskId - The ID of the Task to get information about.
taskGetOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

getAsync

public abstract ServiceFuture getAsync(String jobId, String taskId, ServiceCallback serviceCallback)

Gets information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job that contains the Task.
taskId - The ID of the Task to get information about.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

getWithServiceResponseAsync

public abstract Observable<>> getWithServiceResponseAsync(String jobId, String taskId)

Gets information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job that contains the Task.
taskId - The ID of the Task to get information about.

Returns:

the observable to the CloudTask object

getWithServiceResponseAsync

public abstract Observable<>> getWithServiceResponseAsync(String jobId, String taskId, TaskGetOptions taskGetOptions)

Gets information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job that contains the Task.
taskId - The ID of the Task to get information about.
taskGetOptions - Additional parameters for the operation

Returns:

the observable to the CloudTask object

list

public abstract PagedList list(String jobId)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job.

Returns:

the PagedList<CloudTask> object if successful.

list

public abstract PagedList list(String jobId, TaskListOptions taskListOptions)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job.
taskListOptions - Additional parameters for the operation

Returns:

the PagedList<CloudTask> object if successful.

listAsync

public abstract Observable<>> listAsync(String jobId)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job.

Returns:

the observable to the PagedList<CloudTask> object

listAsync

public abstract ServiceFuture<>> listAsync(String jobId, ListOperationCallback serviceCallback)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

listAsync

public abstract Observable<>> listAsync(String jobId, TaskListOptions taskListOptions)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job.
taskListOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudTask> object

listAsync

public abstract ServiceFuture<>> listAsync(String jobId, TaskListOptions taskListOptions, ListOperationCallback serviceCallback)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job.
taskListOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

listNext

public abstract PagedList listNext(String nextPageLink)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the PagedList<CloudTask> object if successful.

listNext

public abstract PagedList listNext(String nextPageLink, TaskListNextOptions taskListNextOptions)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.
taskListNextOptions - Additional parameters for the operation

Returns:

the PagedList<CloudTask> object if successful.

listNextAsync

public abstract Observable<>> listNextAsync(String nextPageLink)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<CloudTask> object

listNextAsync

public abstract Observable<>> listNextAsync(String nextPageLink, TaskListNextOptions taskListNextOptions)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.
taskListNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudTask> object

listNextAsync

public abstract ServiceFuture<>> listNextAsync(String nextPageLink, TaskListNextOptions taskListNextOptions, ServiceFuture<>> serviceFuture, ListOperationCallback serviceCallback)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.
taskListNextOptions - Additional parameters for the operation
serviceFuture - the ServiceFuture object tracking the Retrofit calls
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

listNextAsync

public abstract ServiceFuture<>> listNextAsync(String nextPageLink, ServiceFuture<>> serviceFuture, ListOperationCallback serviceCallback)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.
serviceFuture - the ServiceFuture object tracking the Retrofit calls
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

listNextWithServiceResponseAsync

public abstract Observable<><>,TaskListHeaders>> listNextWithServiceResponseAsync(String nextPageLink)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<CloudTask> object

listNextWithServiceResponseAsync

public abstract Observable<><>,TaskListHeaders>> listNextWithServiceResponseAsync(String nextPageLink, TaskListNextOptions taskListNextOptions)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.
taskListNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudTask> object

listSubtasks

public abstract CloudTaskListSubtasksResult listSubtasks(String jobId, String taskId)

Lists all of the subtasks that are associated with the specified multi-instance Task. If the Task is not a multi-instance Task then this returns an empty collection.

Parameters:

jobId - The ID of the Job.
taskId - The ID of the Task.

Returns:

the CloudTaskListSubtasksResult object if successful.

listSubtasks

public abstract CloudTaskListSubtasksResult listSubtasks(String jobId, String taskId, TaskListSubtasksOptions taskListSubtasksOptions)

Lists all of the subtasks that are associated with the specified multi-instance Task. If the Task is not a multi-instance Task then this returns an empty collection.

Parameters:

jobId - The ID of the Job.
taskId - The ID of the Task.
taskListSubtasksOptions - Additional parameters for the operation

Returns:

the CloudTaskListSubtasksResult object if successful.

listSubtasksAsync

public abstract Observable listSubtasksAsync(String jobId, String taskId)

Lists all of the subtasks that are associated with the specified multi-instance Task. If the Task is not a multi-instance Task then this returns an empty collection.

Parameters:

jobId - The ID of the Job.
taskId - The ID of the Task.

Returns:

the observable to the CloudTaskListSubtasksResult object

listSubtasksAsync

public abstract Observable listSubtasksAsync(String jobId, String taskId, TaskListSubtasksOptions taskListSubtasksOptions)

Lists all of the subtasks that are associated with the specified multi-instance Task. If the Task is not a multi-instance Task then this returns an empty collection.

Parameters:

jobId - The ID of the Job.
taskId - The ID of the Task.
taskListSubtasksOptions - Additional parameters for the operation

Returns:

the observable to the CloudTaskListSubtasksResult object

listSubtasksAsync

public abstract ServiceFuture listSubtasksAsync(String jobId, String taskId, TaskListSubtasksOptions taskListSubtasksOptions, ServiceCallback serviceCallback)

Lists all of the subtasks that are associated with the specified multi-instance Task. If the Task is not a multi-instance Task then this returns an empty collection.

Parameters:

jobId - The ID of the Job.
taskId - The ID of the Task.
taskListSubtasksOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

listSubtasksAsync

public abstract ServiceFuture listSubtasksAsync(String jobId, String taskId, ServiceCallback serviceCallback)

Lists all of the subtasks that are associated with the specified multi-instance Task. If the Task is not a multi-instance Task then this returns an empty collection.

Parameters:

jobId - The ID of the Job.
taskId - The ID of the Task.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

listSubtasksWithServiceResponseAsync

public abstract Observable<>> listSubtasksWithServiceResponseAsync(String jobId, String taskId)

Lists all of the subtasks that are associated with the specified multi-instance Task. If the Task is not a multi-instance Task then this returns an empty collection.

Parameters:

jobId - The ID of the Job.
taskId - The ID of the Task.

Returns:

the observable to the CloudTaskListSubtasksResult object

listSubtasksWithServiceResponseAsync

public abstract Observable<>> listSubtasksWithServiceResponseAsync(String jobId, String taskId, TaskListSubtasksOptions taskListSubtasksOptions)

Lists all of the subtasks that are associated with the specified multi-instance Task. If the Task is not a multi-instance Task then this returns an empty collection.

Parameters:

jobId - The ID of the Job.
taskId - The ID of the Task.
taskListSubtasksOptions - Additional parameters for the operation

Returns:

the observable to the CloudTaskListSubtasksResult object

listWithServiceResponseAsync

public abstract Observable<><>,TaskListHeaders>> listWithServiceResponseAsync(String jobId)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job.

Returns:

the observable to the PagedList<CloudTask> object

listWithServiceResponseAsync

public abstract Observable<><>,TaskListHeaders>> listWithServiceResponseAsync(String jobId, TaskListOptions taskListOptions)

Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Parameters:

jobId - The ID of the Job.
taskListOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudTask> object

reactivate

public abstract void reactivate(String jobId, String taskId)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted. Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to reactivate.

reactivate

public abstract void reactivate(String jobId, String taskId, TaskReactivateOptions taskReactivateOptions)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted. Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to reactivate.
taskReactivateOptions - Additional parameters for the operation

reactivateAsync

public abstract Observable reactivateAsync(String jobId, String taskId)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted. Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to reactivate.

Returns:

the ServiceResponseWithHeaders object if successful.

reactivateAsync

public abstract Observable reactivateAsync(String jobId, String taskId, TaskReactivateOptions taskReactivateOptions)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted. Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to reactivate.
taskReactivateOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

reactivateAsync

public abstract ServiceFuture reactivateAsync(String jobId, String taskId, TaskReactivateOptions taskReactivateOptions, ServiceCallback serviceCallback)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted. Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to reactivate.
taskReactivateOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

reactivateAsync

public abstract ServiceFuture reactivateAsync(String jobId, String taskId, ServiceCallback serviceCallback)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted. Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to reactivate.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

reactivateWithServiceResponseAsync

public abstract Observable<>> reactivateWithServiceResponseAsync(String jobId, String taskId)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted. Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to reactivate.

Returns:

the ServiceResponseWithHeaders object if successful.

reactivateWithServiceResponseAsync

public abstract Observable<>> reactivateWithServiceResponseAsync(String jobId, String taskId, TaskReactivateOptions taskReactivateOptions)

Reactivates a Task, allowing it to run again even if its retry count has been exhausted. Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to reactivate.
taskReactivateOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

terminate

public abstract void terminate(String jobId, String taskId)

Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to terminate.

terminate

public abstract void terminate(String jobId, String taskId, TaskTerminateOptions taskTerminateOptions)

Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to terminate.
taskTerminateOptions - Additional parameters for the operation

terminateAsync

public abstract Observable terminateAsync(String jobId, String taskId)

Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to terminate.

Returns:

the ServiceResponseWithHeaders object if successful.

terminateAsync

public abstract Observable terminateAsync(String jobId, String taskId, TaskTerminateOptions taskTerminateOptions)

Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to terminate.
taskTerminateOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

terminateAsync

public abstract ServiceFuture terminateAsync(String jobId, String taskId, TaskTerminateOptions taskTerminateOptions, ServiceCallback serviceCallback)

Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to terminate.
taskTerminateOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

terminateAsync

public abstract ServiceFuture terminateAsync(String jobId, String taskId, ServiceCallback serviceCallback)

Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to terminate.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

terminateWithServiceResponseAsync

public abstract Observable<>> terminateWithServiceResponseAsync(String jobId, String taskId)

Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to terminate.

Returns:

the ServiceResponseWithHeaders object if successful.

terminateWithServiceResponseAsync

public abstract Observable<>> terminateWithServiceResponseAsync(String jobId, String taskId, TaskTerminateOptions taskTerminateOptions)

Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to terminate.
taskTerminateOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

update

public abstract void update(String jobId, String taskId)

Updates the properties of the specified Task.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to update.

update

public abstract void update(String jobId, String taskId, TaskConstraints constraints, TaskUpdateOptions taskUpdateOptions)

Updates the properties of the specified Task.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to update.
constraints - Constraints that apply to this Task. If omitted, the Task is given the default constraints. For multi-instance Tasks, updating the retention time applies only to the primary Task and not subtasks.
taskUpdateOptions - Additional parameters for the operation

updateAsync

public abstract Observable updateAsync(String jobId, String taskId)

Updates the properties of the specified Task.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to update.

Returns:

the ServiceResponseWithHeaders object if successful.

updateAsync

public abstract Observable updateAsync(String jobId, String taskId, TaskConstraints constraints, TaskUpdateOptions taskUpdateOptions)

Updates the properties of the specified Task.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to update.
constraints - Constraints that apply to this Task. If omitted, the Task is given the default constraints. For multi-instance Tasks, updating the retention time applies only to the primary Task and not subtasks.
taskUpdateOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

updateAsync

public abstract ServiceFuture updateAsync(String jobId, String taskId, TaskConstraints constraints, TaskUpdateOptions taskUpdateOptions, ServiceCallback serviceCallback)

Updates the properties of the specified Task.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to update.
constraints - Constraints that apply to this Task. If omitted, the Task is given the default constraints. For multi-instance Tasks, updating the retention time applies only to the primary Task and not subtasks.
taskUpdateOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

updateAsync

public abstract ServiceFuture updateAsync(String jobId, String taskId, ServiceCallback serviceCallback)

Updates the properties of the specified Task.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to update.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

updateWithServiceResponseAsync

public abstract Observable<>> updateWithServiceResponseAsync(String jobId, String taskId)

Updates the properties of the specified Task.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to update.

Returns:

the ServiceResponseWithHeaders object if successful.

updateWithServiceResponseAsync

public abstract Observable<>> updateWithServiceResponseAsync(String jobId, String taskId, TaskConstraints constraints, TaskUpdateOptions taskUpdateOptions)

Updates the properties of the specified Task.

Parameters:

jobId - The ID of the Job containing the Task.
taskId - The ID of the Task to update.
constraints - Constraints that apply to this Task. If omitted, the Task is given the default constraints. For multi-instance Tasks, updating the retention time applies only to the primary Task and not subtasks.
taskUpdateOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Applies to