Jobs Interface

Package:

com.microsoft.azure.batch.protocol

public interface Jobs

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

Method Summary

Modifier and Type	Method and Description
void	add(JobAddParameter job) Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
void	add(JobAddParameter job, JobAddOptions jobAddOptions) Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
Observable<Void>	addAsync(JobAddParameter job) Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
ServiceFuture<Void>	addAsync(JobAddParameter job, final ServiceCallback<Void> serviceCallback) Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
Observable<Void>	addAsync(JobAddParameter job, JobAddOptions jobAddOptions) Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
ServiceFuture<Void>	addAsync(JobAddParameter job, JobAddOptions jobAddOptions, final ServiceCallback<Void> serviceCallback) Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
Observable<ServiceResponseWithHeaders<Void, JobAddHeaders>>	addWithServiceResponseAsync(JobAddParameter job) Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
Observable<ServiceResponseWithHeaders<Void, JobAddHeaders>>	addWithServiceResponseAsync(JobAddParameter job, JobAddOptions jobAddOptions) Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
void	delete(String jobId) Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.
void	delete(String jobId, JobDeleteOptions jobDeleteOptions) Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.
Observable<Void>	deleteAsync(String jobId) Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.
ServiceFuture<Void>	deleteAsync(String jobId, final ServiceCallback<Void> serviceCallback) Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.
Observable<Void>	deleteAsync(String jobId, JobDeleteOptions jobDeleteOptions) Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.
ServiceFuture<Void>	deleteAsync(String jobId, JobDeleteOptions jobDeleteOptions, final ServiceCallback<Void> serviceCallback) Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.
Observable<ServiceResponseWithHeaders<Void, JobDeleteHeaders>>	deleteWithServiceResponseAsync(String jobId) Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.
Observable<ServiceResponseWithHeaders<Void, JobDeleteHeaders>>	deleteWithServiceResponseAsync(String jobId, JobDeleteOptions jobDeleteOptions) Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.
void	disable(String jobId, DisableJobOption disableTasks) Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.
void	disable(String jobId, DisableJobOption disableTasks, JobDisableOptions jobDisableOptions) Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.
Observable<Void>	disableAsync(String jobId, DisableJobOption disableTasks) Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.
ServiceFuture<Void>	disableAsync(String jobId, DisableJobOption disableTasks, final ServiceCallback<Void> serviceCallback) Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.
Observable<Void>	disableAsync(String jobId, DisableJobOption disableTasks, JobDisableOptions jobDisableOptions) Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.
ServiceFuture<Void>	disableAsync(String jobId, DisableJobOption disableTasks, JobDisableOptions jobDisableOptions, final ServiceCallback<Void> serviceCallback) Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.
Observable<ServiceResponseWithHeaders<Void, JobDisableHeaders>>	disableWithServiceResponseAsync(String jobId, DisableJobOption disableTasks) Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.
Observable<ServiceResponseWithHeaders<Void, JobDisableHeaders>>	disableWithServiceResponseAsync(String jobId, DisableJobOption disableTasks, JobDisableOptions jobDisableOptions) Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.
void	enable(String jobId) Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.
void	enable(String jobId, JobEnableOptions jobEnableOptions) Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.
Observable<Void>	enableAsync(String jobId) Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.
ServiceFuture<Void>	enableAsync(String jobId, final ServiceCallback<Void> serviceCallback) Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.
Observable<Void>	enableAsync(String jobId, JobEnableOptions jobEnableOptions) Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.
ServiceFuture<Void>	enableAsync(String jobId, JobEnableOptions jobEnableOptions, final ServiceCallback<Void> serviceCallback) Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.
Observable<ServiceResponseWithHeaders<Void, JobEnableHeaders>>	enableWithServiceResponseAsync(String jobId) Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.
Observable<ServiceResponseWithHeaders<Void, JobEnableHeaders>>	enableWithServiceResponseAsync(String jobId, JobEnableOptions jobEnableOptions) Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.
CloudJob	get(String jobId) Gets information about the specified job.
CloudJob	get(String jobId, JobGetOptions jobGetOptions) Gets information about the specified job.
JobStatistics	getAllLifetimeStatistics() Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
JobStatistics	getAllLifetimeStatistics(JobGetAllLifetimeStatisticsOptions jobGetAllLifetimeStatisticsOptions) Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Observable<JobStatistics>	getAllLifetimeStatisticsAsync() Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
ServiceFuture<JobStatistics>	getAllLifetimeStatisticsAsync(final ServiceCallback<JobStatistics> serviceCallback) Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Observable<JobStatistics>	getAllLifetimeStatisticsAsync(JobGetAllLifetimeStatisticsOptions jobGetAllLifetimeStatisticsOptions) Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
ServiceFuture<JobStatistics>	getAllLifetimeStatisticsAsync(JobGetAllLifetimeStatisticsOptions jobGetAllLifetimeStatisticsOptions, final ServiceCallback<JobStatistics> serviceCallback) Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Observable<ServiceResponseWithHeaders<JobStatistics, JobGetAllLifetimeStatisticsHeaders>>	getAllLifetimeStatisticsWithServiceResponseAsync() Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Observable<ServiceResponseWithHeaders<JobStatistics, JobGetAllLifetimeStatisticsHeaders>>	getAllLifetimeStatisticsWithServiceResponseAsync(JobGetAllLifetimeStatisticsOptions jobGetAllLifetimeStatisticsOptions) Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Observable<CloudJob>	getAsync(String jobId) Gets information about the specified job.
ServiceFuture<CloudJob>	getAsync(String jobId, final ServiceCallback<CloudJob> serviceCallback) Gets information about the specified job.
Observable<CloudJob>	getAsync(String jobId, JobGetOptions jobGetOptions) Gets information about the specified job.
ServiceFuture<CloudJob>	getAsync(String jobId, JobGetOptions jobGetOptions, final ServiceCallback<CloudJob> serviceCallback) Gets information about the specified job.
TaskCounts	getTaskCounts(String jobId) Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.
TaskCounts	getTaskCounts(String jobId, JobGetTaskCountsOptions jobGetTaskCountsOptions) Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.
Observable<TaskCounts>	getTaskCountsAsync(String jobId) Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.
ServiceFuture<TaskCounts>	getTaskCountsAsync(String jobId, final ServiceCallback<TaskCounts> serviceCallback) Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.
Observable<TaskCounts>	getTaskCountsAsync(String jobId, JobGetTaskCountsOptions jobGetTaskCountsOptions) Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.
ServiceFuture<TaskCounts>	getTaskCountsAsync(String jobId, JobGetTaskCountsOptions jobGetTaskCountsOptions, final ServiceCallback<TaskCounts> serviceCallback) Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.
Observable<ServiceResponseWithHeaders<TaskCounts, JobGetTaskCountsHeaders>>	getTaskCountsWithServiceResponseAsync(String jobId) Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.
Observable<ServiceResponseWithHeaders<TaskCounts, JobGetTaskCountsHeaders>>	getTaskCountsWithServiceResponseAsync(String jobId, JobGetTaskCountsOptions jobGetTaskCountsOptions) Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.
Observable<ServiceResponseWithHeaders<CloudJob, JobGetHeaders>>	getWithServiceResponseAsync(String jobId) Gets information about the specified job.
Observable<ServiceResponseWithHeaders<CloudJob, JobGetHeaders>>	getWithServiceResponseAsync(String jobId, JobGetOptions jobGetOptions) Gets information about the specified job.
PagedList<CloudJob>	list() Lists all of the jobs in the specified account.
PagedList<CloudJob>	list(final JobListOptions jobListOptions) Lists all of the jobs in the specified account.
Observable<Page<CloudJob>>	listAsync() Lists all of the jobs in the specified account.
Observable<Page<CloudJob>>	listAsync(final JobListOptions jobListOptions) Lists all of the jobs in the specified account.
ServiceFuture<List<CloudJob>>	listAsync(final JobListOptions jobListOptions, final ListOperationCallback<CloudJob> serviceCallback) Lists all of the jobs in the specified account.
ServiceFuture<List<CloudJob>>	listAsync(final ListOperationCallback<CloudJob> serviceCallback) Lists all of the jobs in the specified account.
PagedList<CloudJob>	listFromJobSchedule(final String jobScheduleId) Lists the jobs that have been created under the specified job schedule.
PagedList<CloudJob>	listFromJobSchedule(final String jobScheduleId, final JobListFromJobScheduleOptions jobListFromJobScheduleOptions) Lists the jobs that have been created under the specified job schedule.
Observable<Page<CloudJob>>	listFromJobScheduleAsync(final String jobScheduleId) Lists the jobs that have been created under the specified job schedule.
Observable<Page<CloudJob>>	listFromJobScheduleAsync(final String jobScheduleId, final JobListFromJobScheduleOptions jobListFromJobScheduleOptions) Lists the jobs that have been created under the specified job schedule.
ServiceFuture<List<CloudJob>>	listFromJobScheduleAsync(final String jobScheduleId, final JobListFromJobScheduleOptions jobListFromJobScheduleOptions, final ListOperationCallback<CloudJob> serviceCallback) Lists the jobs that have been created under the specified job schedule.
ServiceFuture<List<CloudJob>>	listFromJobScheduleAsync(final String jobScheduleId, final ListOperationCallback<CloudJob> serviceCallback) Lists the jobs that have been created under the specified job schedule.
PagedList<CloudJob>	listFromJobScheduleNext(final String nextPageLink) Lists the jobs that have been created under the specified job schedule.
PagedList<CloudJob>	listFromJobScheduleNext(final String nextPageLink, final JobListFromJobScheduleNextOptions jobListFromJobScheduleNextOptions) Lists the jobs that have been created under the specified job schedule.
Observable<Page<CloudJob>>	listFromJobScheduleNextAsync(final String nextPageLink) Lists the jobs that have been created under the specified job schedule.
Observable<Page<CloudJob>>	listFromJobScheduleNextAsync(final String nextPageLink, final JobListFromJobScheduleNextOptions jobListFromJobScheduleNextOptions) Lists the jobs that have been created under the specified job schedule.
ServiceFuture<List<CloudJob>>	listFromJobScheduleNextAsync(final String nextPageLink, final JobListFromJobScheduleNextOptions jobListFromJobScheduleNextOptions, final ServiceFuture<List<CloudJob>> serviceFuture, final ListOperationCallback<CloudJob> serviceCallback) Lists the jobs that have been created under the specified job schedule.
ServiceFuture<List<CloudJob>>	listFromJobScheduleNextAsync(final String nextPageLink, final ServiceFuture<List<CloudJob>> serviceFuture, final ListOperationCallback<CloudJob> serviceCallback) Lists the jobs that have been created under the specified job schedule.
Observable<ServiceResponseWithHeaders<Page<CloudJob>, JobListFromJobScheduleHeaders>>	listFromJobScheduleNextWithServiceResponseAsync(final String nextPageLink) Lists the jobs that have been created under the specified job schedule.
Observable<ServiceResponseWithHeaders<Page<CloudJob>, JobListFromJobScheduleHeaders>>	listFromJobScheduleNextWithServiceResponseAsync(final String nextPageLink, final JobListFromJobScheduleNextOptions jobListFromJobScheduleNextOptions) Lists the jobs that have been created under the specified job schedule.
Observable<ServiceResponseWithHeaders<Page<CloudJob>, JobListFromJobScheduleHeaders>>	listFromJobScheduleWithServiceResponseAsync(final String jobScheduleId) Lists the jobs that have been created under the specified job schedule.
Observable<ServiceResponseWithHeaders<Page<CloudJob>, JobListFromJobScheduleHeaders>>	listFromJobScheduleWithServiceResponseAsync(final String jobScheduleId, final JobListFromJobScheduleOptions jobListFromJobScheduleOptions) Lists the jobs that have been created under the specified job schedule.
PagedList<CloudJob>	listNext(final String nextPageLink) Lists all of the jobs in the specified account.
PagedList<CloudJob>	listNext(final String nextPageLink, final JobListNextOptions jobListNextOptions) Lists all of the jobs in the specified account.
Observable<Page<CloudJob>>	listNextAsync(final String nextPageLink) Lists all of the jobs in the specified account.
Observable<Page<CloudJob>>	listNextAsync(final String nextPageLink, final JobListNextOptions jobListNextOptions) Lists all of the jobs in the specified account.
ServiceFuture<List<CloudJob>>	listNextAsync(final String nextPageLink, final JobListNextOptions jobListNextOptions, final ServiceFuture<List<CloudJob>> serviceFuture, final ListOperationCallback<CloudJob> serviceCallback) Lists all of the jobs in the specified account.
ServiceFuture<List<CloudJob>>	listNextAsync(final String nextPageLink, final ServiceFuture<List<CloudJob>> serviceFuture, final ListOperationCallback<CloudJob> serviceCallback) Lists all of the jobs in the specified account.
Observable<ServiceResponseWithHeaders<Page<CloudJob>, JobListHeaders>>	listNextWithServiceResponseAsync(final String nextPageLink) Lists all of the jobs in the specified account.
Observable<ServiceResponseWithHeaders<Page<CloudJob>, JobListHeaders>>	listNextWithServiceResponseAsync(final String nextPageLink, final JobListNextOptions jobListNextOptions) Lists all of the jobs in the specified account.
PagedList<JobPreparationAndReleaseTaskExecutionInformation>	listPreparationAndReleaseTaskStatus(final String jobId) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
PagedList<JobPreparationAndReleaseTaskExecutionInformation>	listPreparationAndReleaseTaskStatus(final String jobId, final JobListPreparationAndReleaseTaskStatusOptions jobListPreparationAndReleaseTaskStatusOptions) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
Observable<Page<JobPreparationAndReleaseTaskExecutionInformation>>	listPreparationAndReleaseTaskStatusAsync(final String jobId) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
Observable<Page<JobPreparationAndReleaseTaskExecutionInformation>>	listPreparationAndReleaseTaskStatusAsync(final String jobId, final JobListPreparationAndReleaseTaskStatusOptions jobListPreparationAndReleaseTaskStatusOptions) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
ServiceFuture<List<JobPreparationAndReleaseTaskExecutionInformation>>	listPreparationAndReleaseTaskStatusAsync(final String jobId, final JobListPreparationAndReleaseTaskStatusOptions jobListPreparationAndReleaseTaskStatusOptions, final ListOperationCallback<JobPreparationAndReleaseTaskExecutionInformation> serviceCallback) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
ServiceFuture<List<JobPreparationAndReleaseTaskExecutionInformation>>	listPreparationAndReleaseTaskStatusAsync(final String jobId, final ListOperationCallback<JobPreparationAndReleaseTaskExecutionInformation> serviceCallback) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
PagedList<JobPreparationAndReleaseTaskExecutionInformation>	listPreparationAndReleaseTaskStatusNext(final String nextPageLink) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
PagedList<JobPreparationAndReleaseTaskExecutionInformation>	listPreparationAndReleaseTaskStatusNext(final String nextPageLink, final JobListPreparationAndReleaseTaskStatusNextOptions jobListPreparationAndReleaseTaskStatusNextOptions) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
Observable<Page<JobPreparationAndReleaseTaskExecutionInformation>>	listPreparationAndReleaseTaskStatusNextAsync(final String nextPageLink) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
Observable<Page<JobPreparationAndReleaseTaskExecutionInformation>>	listPreparationAndReleaseTaskStatusNextAsync(final String nextPageLink, final JobListPreparationAndReleaseTaskStatusNextOptions jobListPreparationAndReleaseTaskStatusNextOptions) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
ServiceFuture<List<JobPreparationAndReleaseTaskExecutionInformation>>	listPreparationAndReleaseTaskStatusNextAsync(final String nextPageLink, final JobListPreparationAndReleaseTaskStatusNextOptions jobListPreparationAndReleaseTaskStatusNextOptions, final ServiceFuture<List<JobPreparationAndReleaseTaskExecutionInformation>> serviceFuture, final ListOperationCallback<JobPreparationAndReleaseTaskExecutionInformation> serviceCallback) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
ServiceFuture<List<JobPreparationAndReleaseTaskExecutionInformation>>	listPreparationAndReleaseTaskStatusNextAsync(final String nextPageLink, final ServiceFuture<List<JobPreparationAndReleaseTaskExecutionInformation>> serviceFuture, final ListOperationCallback<JobPreparationAndReleaseTaskExecutionInformation> serviceCallback) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
Observable<ServiceResponseWithHeaders<Page<JobPreparationAndReleaseTaskExecutionInformation>, JobListPreparationAndReleaseTaskStatusHeaders>>	listPreparationAndReleaseTaskStatusNextWithServiceResponseAsync(final String nextPageLink) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
Observable<ServiceResponseWithHeaders<Page<JobPreparationAndReleaseTaskExecutionInformation>, JobListPreparationAndReleaseTaskStatusHeaders>>	listPreparationAndReleaseTaskStatusNextWithServiceResponseAsync(final String nextPageLink, final JobListPreparationAndReleaseTaskStatusNextOptions jobListPreparationAndReleaseTaskStatusNextOptions) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
Observable<ServiceResponseWithHeaders<Page<JobPreparationAndReleaseTaskExecutionInformation>, JobListPreparationAndReleaseTaskStatusHeaders>>	listPreparationAndReleaseTaskStatusWithServiceResponseAsync(final String jobId) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
Observable<ServiceResponseWithHeaders<Page<JobPreparationAndReleaseTaskExecutionInformation>, JobListPreparationAndReleaseTaskStatusHeaders>>	listPreparationAndReleaseTaskStatusWithServiceResponseAsync(final String jobId, final JobListPreparationAndReleaseTaskStatusOptions jobListPreparationAndReleaseTaskStatusOptions) Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
Observable<ServiceResponseWithHeaders<Page<CloudJob>, JobListHeaders>>	listWithServiceResponseAsync() Lists all of the jobs in the specified account.
Observable<ServiceResponseWithHeaders<Page<CloudJob>, JobListHeaders>>	listWithServiceResponseAsync(final JobListOptions jobListOptions) Lists all of the jobs in the specified account.
void	patch(String jobId, JobPatchParameter jobPatchParameter) Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.
void	patch(String jobId, JobPatchParameter jobPatchParameter, JobPatchOptions jobPatchOptions) Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.
Observable<Void>	patchAsync(String jobId, JobPatchParameter jobPatchParameter) Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.
ServiceFuture<Void>	patchAsync(String jobId, JobPatchParameter jobPatchParameter, final ServiceCallback<Void> serviceCallback) Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.
Observable<Void>	patchAsync(String jobId, JobPatchParameter jobPatchParameter, JobPatchOptions jobPatchOptions) Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.
ServiceFuture<Void>	patchAsync(String jobId, JobPatchParameter jobPatchParameter, JobPatchOptions jobPatchOptions, final ServiceCallback<Void> serviceCallback) Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.
Observable<ServiceResponseWithHeaders<Void, JobPatchHeaders>>	patchWithServiceResponseAsync(String jobId, JobPatchParameter jobPatchParameter) Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.
Observable<ServiceResponseWithHeaders<Void, JobPatchHeaders>>	patchWithServiceResponseAsync(String jobId, JobPatchParameter jobPatchParameter, JobPatchOptions jobPatchOptions) Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.
void	terminate(String jobId) Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.
void	terminate(String jobId, String terminateReason, JobTerminateOptions jobTerminateOptions) Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.
Observable<Void>	terminateAsync(String jobId) Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.
ServiceFuture<Void>	terminateAsync(String jobId, final ServiceCallback<Void> serviceCallback) Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.
Observable<Void>	terminateAsync(String jobId, String terminateReason, JobTerminateOptions jobTerminateOptions) Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.
ServiceFuture<Void>	terminateAsync(String jobId, String terminateReason, JobTerminateOptions jobTerminateOptions, final ServiceCallback<Void> serviceCallback) Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.
Observable<ServiceResponseWithHeaders<Void, JobTerminateHeaders>>	terminateWithServiceResponseAsync(String jobId) Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.
Observable<ServiceResponseWithHeaders<Void, JobTerminateHeaders>>	terminateWithServiceResponseAsync(String jobId, String terminateReason, JobTerminateOptions jobTerminateOptions) Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.
void	update(String jobId, JobUpdateParameter jobUpdateParameter) Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.
void	update(String jobId, JobUpdateParameter jobUpdateParameter, JobUpdateOptions jobUpdateOptions) Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.
Observable<Void>	updateAsync(String jobId, JobUpdateParameter jobUpdateParameter) Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.
ServiceFuture<Void>	updateAsync(String jobId, JobUpdateParameter jobUpdateParameter, final ServiceCallback<Void> serviceCallback) Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.
Observable<Void>	updateAsync(String jobId, JobUpdateParameter jobUpdateParameter, JobUpdateOptions jobUpdateOptions) Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.
ServiceFuture<Void>	updateAsync(String jobId, JobUpdateParameter jobUpdateParameter, JobUpdateOptions jobUpdateOptions, final ServiceCallback<Void> serviceCallback) Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.
Observable<ServiceResponseWithHeaders<Void, JobUpdateHeaders>>	updateWithServiceResponseAsync(String jobId, JobUpdateParameter jobUpdateParameter) Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.
Observable<ServiceResponseWithHeaders<Void, JobUpdateHeaders>>	updateWithServiceResponseAsync(String jobId, JobUpdateParameter jobUpdateParameter, JobUpdateOptions jobUpdateOptions) Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

Method Details

add

public void add(JobAddParameter job)

Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

Parameters:

job - The job to be added.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

add

public void add(JobAddParameter job, JobAddOptions jobAddOptions)

Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

Parameters:

job - The job to be added.

jobAddOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addAsync

public Observable addAsync(JobAddParameter job)

Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

Parameters:

job - The job to be added.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addAsync

public ServiceFuture addAsync(JobAddParameter job, final ServiceCallback serviceCallback)

Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

Parameters:

job - The job to be added.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addAsync

public Observable addAsync(JobAddParameter job, JobAddOptions jobAddOptions)

Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

Parameters:

job - The job to be added.

jobAddOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addAsync

public ServiceFuture addAsync(JobAddParameter job, JobAddOptions jobAddOptions, final ServiceCallback serviceCallback)

Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

Parameters:

job - The job to be added.

jobAddOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addWithServiceResponseAsync

public Observable> addWithServiceResponseAsync(JobAddParameter job)

Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

Parameters:

job - The job to be added.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addWithServiceResponseAsync

public Observable> addWithServiceResponseAsync(JobAddParameter job, JobAddOptions jobAddOptions)

Adds a job to the specified account. The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

Parameters:

job - The job to be added.

jobAddOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

delete

public void delete(String jobId)

Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.

Parameters:

jobId - The ID of the job to delete.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

delete

public void delete(String jobId, JobDeleteOptions jobDeleteOptions)

Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.

Parameters:

jobId - The ID of the job to delete.

jobDeleteOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteAsync

public Observable deleteAsync(String jobId)

Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.

Parameters:

jobId - The ID of the job to delete.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAsync

public ServiceFuture deleteAsync(String jobId, final ServiceCallback serviceCallback)

Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.

Parameters:

jobId - The ID of the job to delete.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAsync

public Observable deleteAsync(String jobId, JobDeleteOptions jobDeleteOptions)

Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.

Parameters:

jobId - The ID of the job to delete.

jobDeleteOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAsync

public ServiceFuture deleteAsync(String jobId, JobDeleteOptions jobDeleteOptions, final ServiceCallback serviceCallback)

Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.

Parameters:

jobId - The ID of the job to delete.

jobDeleteOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteWithServiceResponseAsync

public Observable> deleteWithServiceResponseAsync(String jobId)

Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.

Parameters:

jobId - The ID of the job to delete.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteWithServiceResponseAsync

public Observable> deleteWithServiceResponseAsync(String jobId, JobDeleteOptions jobDeleteOptions)

Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.

Parameters:

jobId - The ID of the job to delete.

jobDeleteOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

disable

public void disable(String jobId, DisableJobOption disableTasks)

Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.

Parameters:

jobId - The ID of the job to disable.

disableTasks - What to do with active tasks associated with the job. Possible values include: 'requeue', 'terminate', 'wait'

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

disable

public void disable(String jobId, DisableJobOption disableTasks, JobDisableOptions jobDisableOptions)

Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.

Parameters:

jobId - The ID of the job to disable.

disableTasks - What to do with active tasks associated with the job. Possible values include: 'requeue', 'terminate', 'wait'

jobDisableOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

disableAsync

public Observable disableAsync(String jobId, DisableJobOption disableTasks)

Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.

Parameters:

jobId - The ID of the job to disable.

disableTasks - What to do with active tasks associated with the job. Possible values include: 'requeue', 'terminate', 'wait'

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

disableAsync

public ServiceFuture disableAsync(String jobId, DisableJobOption disableTasks, final ServiceCallback serviceCallback)

Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.

Parameters:

jobId - The ID of the job to disable.

disableTasks - What to do with active tasks associated with the job. Possible values include: 'requeue', 'terminate', 'wait'

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

disableAsync

public Observable disableAsync(String jobId, DisableJobOption disableTasks, JobDisableOptions jobDisableOptions)

Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.

Parameters:

jobId - The ID of the job to disable.

disableTasks - What to do with active tasks associated with the job. Possible values include: 'requeue', 'terminate', 'wait'

jobDisableOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

disableAsync

public ServiceFuture disableAsync(String jobId, DisableJobOption disableTasks, JobDisableOptions jobDisableOptions, final ServiceCallback serviceCallback)

Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.

Parameters:

jobId - The ID of the job to disable.

disableTasks - What to do with active tasks associated with the job. Possible values include: 'requeue', 'terminate', 'wait'

jobDisableOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

disableWithServiceResponseAsync

public Observable> disableWithServiceResponseAsync(String jobId, DisableJobOption disableTasks)

Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.

Parameters:

jobId - The ID of the job to disable.

disableTasks - What to do with active tasks associated with the job. Possible values include: 'requeue', 'terminate', 'wait'

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

disableWithServiceResponseAsync

public Observable> disableWithServiceResponseAsync(String jobId, DisableJobOption disableTasks, JobDisableOptions jobDisableOptions)

Disables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.

Parameters:

jobId - The ID of the job to disable.

disableTasks - What to do with active tasks associated with the job. Possible values include: 'requeue', 'terminate', 'wait'

jobDisableOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

enable

public void enable(String jobId)

Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.

Parameters:

jobId - The ID of the job to enable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

enable

public void enable(String jobId, JobEnableOptions jobEnableOptions)

Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.

Parameters:

jobId - The ID of the job to enable.

jobEnableOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

enableAsync

public Observable enableAsync(String jobId)

Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.

Parameters:

jobId - The ID of the job to enable.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

enableAsync

public ServiceFuture enableAsync(String jobId, final ServiceCallback serviceCallback)

Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.

Parameters:

jobId - The ID of the job to enable.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

enableAsync

public Observable enableAsync(String jobId, JobEnableOptions jobEnableOptions)

Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.

Parameters:

jobId - The ID of the job to enable.

jobEnableOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

enableAsync

public ServiceFuture enableAsync(String jobId, JobEnableOptions jobEnableOptions, final ServiceCallback serviceCallback)

Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.

Parameters:

jobId - The ID of the job to enable.

jobEnableOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

enableWithServiceResponseAsync

public Observable> enableWithServiceResponseAsync(String jobId)

Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.

Parameters:

jobId - The ID of the job to enable.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

enableWithServiceResponseAsync

public Observable> enableWithServiceResponseAsync(String jobId, JobEnableOptions jobEnableOptions)

Enables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.

Parameters:

jobId - The ID of the job to enable.

jobEnableOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

get

public CloudJob get(String jobId)

Gets information about the specified job.

Parameters:

jobId - The ID of the job.

Returns:

the CloudJob object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

get

public CloudJob get(String jobId, JobGetOptions jobGetOptions)

Gets information about the specified job.

Parameters:

jobId - The ID of the job.

jobGetOptions - Additional parameters for the operation

Returns:

the CloudJob object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAllLifetimeStatistics

public JobStatistics getAllLifetimeStatistics()

Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Returns:

the JobStatistics object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAllLifetimeStatistics

public JobStatistics getAllLifetimeStatistics(JobGetAllLifetimeStatisticsOptions jobGetAllLifetimeStatisticsOptions)

Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Parameters:

jobGetAllLifetimeStatisticsOptions - Additional parameters for the operation

Returns:

the JobStatistics object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAllLifetimeStatisticsAsync

public Observable getAllLifetimeStatisticsAsync()

Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Returns:

the observable to the JobStatistics object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllLifetimeStatisticsAsync

public ServiceFuture getAllLifetimeStatisticsAsync(final ServiceCallback serviceCallback)

Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Parameters:

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllLifetimeStatisticsAsync

public Observable getAllLifetimeStatisticsAsync(JobGetAllLifetimeStatisticsOptions jobGetAllLifetimeStatisticsOptions)

Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Parameters:

jobGetAllLifetimeStatisticsOptions - Additional parameters for the operation

Returns:

the observable to the JobStatistics object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllLifetimeStatisticsAsync

public ServiceFuture getAllLifetimeStatisticsAsync(JobGetAllLifetimeStatisticsOptions jobGetAllLifetimeStatisticsOptions, final ServiceCallback serviceCallback)

Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Parameters:

jobGetAllLifetimeStatisticsOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllLifetimeStatisticsWithServiceResponseAsync

public Observable> getAllLifetimeStatisticsWithServiceResponseAsync()

Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Returns:

the observable to the JobStatistics object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllLifetimeStatisticsWithServiceResponseAsync

public Observable> getAllLifetimeStatisticsWithServiceResponseAsync(JobGetAllLifetimeStatisticsOptions jobGetAllLifetimeStatisticsOptions)

Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Parameters:

jobGetAllLifetimeStatisticsOptions - Additional parameters for the operation

Returns:

the observable to the JobStatistics object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public Observable getAsync(String jobId)

Gets information about the specified job.

Parameters:

jobId - The ID of the job.

Returns:

the observable to the CloudJob object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public ServiceFuture getAsync(String jobId, final ServiceCallback serviceCallback)

Gets information about the specified job.

Parameters:

jobId - The ID of the job.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public Observable getAsync(String jobId, JobGetOptions jobGetOptions)

Gets information about the specified job.

Parameters:

jobId - The ID of the job.

jobGetOptions - Additional parameters for the operation

Returns:

the observable to the CloudJob object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public ServiceFuture getAsync(String jobId, JobGetOptions jobGetOptions, final ServiceCallback serviceCallback)

Gets information about the specified job.

Parameters:

jobId - The ID of the job.

jobGetOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getTaskCounts

public TaskCounts getTaskCounts(String jobId)

Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.

Parameters:

jobId - The ID of the job.

Returns:

the TaskCounts object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getTaskCounts

public TaskCounts getTaskCounts(String jobId, JobGetTaskCountsOptions jobGetTaskCountsOptions)

Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.

Parameters:

jobId - The ID of the job.

jobGetTaskCountsOptions - Additional parameters for the operation

Returns:

the TaskCounts object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getTaskCountsAsync

public Observable getTaskCountsAsync(String jobId)

Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.

Parameters:

jobId - The ID of the job.

Returns:

the observable to the TaskCounts object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getTaskCountsAsync

public ServiceFuture getTaskCountsAsync(String jobId, final ServiceCallback serviceCallback)

Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.

Parameters:

jobId - The ID of the job.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getTaskCountsAsync

public Observable getTaskCountsAsync(String jobId, JobGetTaskCountsOptions jobGetTaskCountsOptions)

Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.

Parameters:

jobId - The ID of the job.

jobGetTaskCountsOptions - Additional parameters for the operation

Returns:

the observable to the TaskCounts object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getTaskCountsAsync

public ServiceFuture getTaskCountsAsync(String jobId, JobGetTaskCountsOptions jobGetTaskCountsOptions, final ServiceCallback serviceCallback)

Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.

Parameters:

jobId - The ID of the job.

jobGetTaskCountsOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getTaskCountsWithServiceResponseAsync

public Observable> getTaskCountsWithServiceResponseAsync(String jobId)

Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.

Parameters:

jobId - The ID of the job.

Returns:

the observable to the TaskCounts object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getTaskCountsWithServiceResponseAsync

public Observable> getTaskCountsWithServiceResponseAsync(String jobId, JobGetTaskCountsOptions jobGetTaskCountsOptions)

Gets the task counts for the specified job. Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.

Parameters:

jobId - The ID of the job.

jobGetTaskCountsOptions - Additional parameters for the operation

Returns:

the observable to the TaskCounts object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getWithServiceResponseAsync

public Observable> getWithServiceResponseAsync(String jobId)

Gets information about the specified job.

Parameters:

jobId - The ID of the job.

Returns:

the observable to the CloudJob object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getWithServiceResponseAsync

public Observable> getWithServiceResponseAsync(String jobId, JobGetOptions jobGetOptions)

Gets information about the specified job.

Parameters:

jobId - The ID of the job.

jobGetOptions - Additional parameters for the operation

Returns:

the observable to the CloudJob object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

public PagedList list()

Lists all of the jobs in the specified account.

Returns:

the PagedList<CloudJob> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

list

public PagedList list(final JobListOptions jobListOptions)

Lists all of the jobs in the specified account.

Parameters:

jobListOptions - Additional parameters for the operation

Returns:

the PagedList<CloudJob> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listAsync

public Observable> listAsync()

Lists all of the jobs in the specified account.

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public Observable> listAsync(final JobListOptions jobListOptions)

Lists all of the jobs in the specified account.

Parameters:

jobListOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public ServiceFuture> listAsync(final JobListOptions jobListOptions, final ListOperationCallback serviceCallback)

Lists all of the jobs in the specified account.

Parameters:

jobListOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public ServiceFuture> listAsync(final ListOperationCallback serviceCallback)

Lists all of the jobs in the specified account.

Parameters:

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listFromJobSchedule

public PagedList listFromJobSchedule(final String jobScheduleId)

Lists the jobs that have been created under the specified job schedule.

Parameters:

jobScheduleId - The ID of the job schedule from which you want to get a list of jobs.

Returns:

the PagedList<CloudJob> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listFromJobSchedule

public PagedList listFromJobSchedule(final String jobScheduleId, final JobListFromJobScheduleOptions jobListFromJobScheduleOptions)

Lists the jobs that have been created under the specified job schedule.

Parameters:

jobScheduleId - The ID of the job schedule from which you want to get a list of jobs.

jobListFromJobScheduleOptions - Additional parameters for the operation

Returns:

the PagedList<CloudJob> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listFromJobScheduleAsync

public Observable> listFromJobScheduleAsync(final String jobScheduleId)

Lists the jobs that have been created under the specified job schedule.

Parameters:

jobScheduleId - The ID of the job schedule from which you want to get a list of jobs.

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listFromJobScheduleAsync

public Observable> listFromJobScheduleAsync(final String jobScheduleId, final JobListFromJobScheduleOptions jobListFromJobScheduleOptions)

Lists the jobs that have been created under the specified job schedule.

Parameters:

jobScheduleId - The ID of the job schedule from which you want to get a list of jobs.

jobListFromJobScheduleOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listFromJobScheduleAsync

public ServiceFuture> listFromJobScheduleAsync(final String jobScheduleId, final JobListFromJobScheduleOptions jobListFromJobScheduleOptions, final ListOperationCallback serviceCallback)

Lists the jobs that have been created under the specified job schedule.

Parameters:

jobScheduleId - The ID of the job schedule from which you want to get a list of jobs.

jobListFromJobScheduleOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listFromJobScheduleAsync

public ServiceFuture> listFromJobScheduleAsync(final String jobScheduleId, final ListOperationCallback serviceCallback)

Lists the jobs that have been created under the specified job schedule.

Parameters:

jobScheduleId - The ID of the job schedule from which you want to get a list of jobs.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listFromJobScheduleNext

public PagedList listFromJobScheduleNext(final String nextPageLink)

Lists the jobs that have been created under the specified job schedule.

Parameters:

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

Returns:

the PagedList<CloudJob> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listFromJobScheduleNext

public PagedList listFromJobScheduleNext(final String nextPageLink, final JobListFromJobScheduleNextOptions jobListFromJobScheduleNextOptions)

Lists the jobs that have been created under the specified job schedule.

Parameters:

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

jobListFromJobScheduleNextOptions - Additional parameters for the operation

Returns:

the PagedList<CloudJob> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listFromJobScheduleNextAsync

public Observable> listFromJobScheduleNextAsync(final String nextPageLink)

Lists the jobs that have been created under the specified job schedule.

Parameters:

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

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listFromJobScheduleNextAsync

public Observable> listFromJobScheduleNextAsync(final String nextPageLink, final JobListFromJobScheduleNextOptions jobListFromJobScheduleNextOptions)

Lists the jobs that have been created under the specified job schedule.

Parameters:

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

jobListFromJobScheduleNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listFromJobScheduleNextAsync

public ServiceFuture> listFromJobScheduleNextAsync(final String nextPageLink, final JobListFromJobScheduleNextOptions jobListFromJobScheduleNextOptions, final ServiceFuture> serviceFuture, final ListOperationCallback serviceCallback)

Lists the jobs that have been created under the specified job schedule.

Parameters:

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

jobListFromJobScheduleNextOptions - 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

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listFromJobScheduleNextAsync

public ServiceFuture> listFromJobScheduleNextAsync(final String nextPageLink, final ServiceFuture> serviceFuture, final ListOperationCallback serviceCallback)

Lists the jobs that have been created under the specified job schedule.

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listFromJobScheduleNextWithServiceResponseAsync

public Observable, JobListFromJobScheduleHeaders>> listFromJobScheduleNextWithServiceResponseAsync(final String nextPageLink)

Lists the jobs that have been created under the specified job schedule.

Parameters:

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

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listFromJobScheduleNextWithServiceResponseAsync

public Observable, JobListFromJobScheduleHeaders>> listFromJobScheduleNextWithServiceResponseAsync(final String nextPageLink, final JobListFromJobScheduleNextOptions jobListFromJobScheduleNextOptions)

Lists the jobs that have been created under the specified job schedule.

Parameters:

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

jobListFromJobScheduleNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listFromJobScheduleWithServiceResponseAsync

public Observable, JobListFromJobScheduleHeaders>> listFromJobScheduleWithServiceResponseAsync(final String jobScheduleId)

Lists the jobs that have been created under the specified job schedule.

Parameters:

jobScheduleId - The ID of the job schedule from which you want to get a list of jobs.

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listFromJobScheduleWithServiceResponseAsync

public Observable, JobListFromJobScheduleHeaders>> listFromJobScheduleWithServiceResponseAsync(final String jobScheduleId, final JobListFromJobScheduleOptions jobListFromJobScheduleOptions)

Lists the jobs that have been created under the specified job schedule.

Parameters:

jobScheduleId - The ID of the job schedule from which you want to get a list of jobs.

jobListFromJobScheduleOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNext

public PagedList listNext(final String nextPageLink)

Lists all of the jobs in the specified account.

Parameters:

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

Returns:

the PagedList<CloudJob> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listNext

public PagedList listNext(final String nextPageLink, final JobListNextOptions jobListNextOptions)

Lists all of the jobs in the specified account.

Parameters:

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

jobListNextOptions - Additional parameters for the operation

Returns:

the PagedList<CloudJob> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listNextAsync

public Observable> listNextAsync(final String nextPageLink)

Lists all of the jobs in the specified account.

Parameters:

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

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

public Observable> listNextAsync(final String nextPageLink, final JobListNextOptions jobListNextOptions)

Lists all of the jobs in the specified account.

Parameters:

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

jobListNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

public ServiceFuture> listNextAsync(final String nextPageLink, final JobListNextOptions jobListNextOptions, final ServiceFuture> serviceFuture, final ListOperationCallback serviceCallback)

Lists all of the jobs in the specified account.

Parameters:

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

jobListNextOptions - 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

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

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

Lists all of the jobs in the specified account.

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextWithServiceResponseAsync

public Observable, JobListHeaders>> listNextWithServiceResponseAsync(final String nextPageLink)

Lists all of the jobs in the specified account.

Parameters:

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

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextWithServiceResponseAsync

public Observable, JobListHeaders>> listNextWithServiceResponseAsync(final String nextPageLink, final JobListNextOptions jobListNextOptions)

Lists all of the jobs in the specified account.

Parameters:

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

jobListNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPreparationAndReleaseTaskStatus

public PagedList listPreparationAndReleaseTaskStatus(final String jobId)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

jobId - The ID of the job.

Returns:

the PagedList<JobPreparationAndReleaseTaskExecutionInformation> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listPreparationAndReleaseTaskStatus

public PagedList listPreparationAndReleaseTaskStatus(final String jobId, final JobListPreparationAndReleaseTaskStatusOptions jobListPreparationAndReleaseTaskStatusOptions)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

jobId - The ID of the job.

jobListPreparationAndReleaseTaskStatusOptions - Additional parameters for the operation

Returns:

the PagedList<JobPreparationAndReleaseTaskExecutionInformation> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listPreparationAndReleaseTaskStatusAsync

public Observable> listPreparationAndReleaseTaskStatusAsync(final String jobId)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

jobId - The ID of the job.

Returns:

the observable to the PagedList<JobPreparationAndReleaseTaskExecutionInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPreparationAndReleaseTaskStatusAsync

public Observable> listPreparationAndReleaseTaskStatusAsync(final String jobId, final JobListPreparationAndReleaseTaskStatusOptions jobListPreparationAndReleaseTaskStatusOptions)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

jobId - The ID of the job.

jobListPreparationAndReleaseTaskStatusOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<JobPreparationAndReleaseTaskExecutionInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPreparationAndReleaseTaskStatusAsync

public ServiceFuture> listPreparationAndReleaseTaskStatusAsync(final String jobId, final JobListPreparationAndReleaseTaskStatusOptions jobListPreparationAndReleaseTaskStatusOptions, final ListOperationCallback serviceCallback)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

jobId - The ID of the job.

jobListPreparationAndReleaseTaskStatusOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPreparationAndReleaseTaskStatusAsync

public ServiceFuture> listPreparationAndReleaseTaskStatusAsync(final String jobId, final ListOperationCallback serviceCallback)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

jobId - The ID of the job.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPreparationAndReleaseTaskStatusNext

public PagedList listPreparationAndReleaseTaskStatusNext(final String nextPageLink)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

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

Returns:

the PagedList<JobPreparationAndReleaseTaskExecutionInformation> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listPreparationAndReleaseTaskStatusNext

public PagedList listPreparationAndReleaseTaskStatusNext(final String nextPageLink, final JobListPreparationAndReleaseTaskStatusNextOptions jobListPreparationAndReleaseTaskStatusNextOptions)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

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

jobListPreparationAndReleaseTaskStatusNextOptions - Additional parameters for the operation

Returns:

the PagedList<JobPreparationAndReleaseTaskExecutionInformation> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listPreparationAndReleaseTaskStatusNextAsync

public Observable> listPreparationAndReleaseTaskStatusNextAsync(final String nextPageLink)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

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

Returns:

the observable to the PagedList<JobPreparationAndReleaseTaskExecutionInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPreparationAndReleaseTaskStatusNextAsync

public Observable> listPreparationAndReleaseTaskStatusNextAsync(final String nextPageLink, final JobListPreparationAndReleaseTaskStatusNextOptions jobListPreparationAndReleaseTaskStatusNextOptions)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

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

jobListPreparationAndReleaseTaskStatusNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<JobPreparationAndReleaseTaskExecutionInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPreparationAndReleaseTaskStatusNextAsync

public ServiceFuture> listPreparationAndReleaseTaskStatusNextAsync(final String nextPageLink, final JobListPreparationAndReleaseTaskStatusNextOptions jobListPreparationAndReleaseTaskStatusNextOptions, final ServiceFuture> serviceFuture, final ListOperationCallback serviceCallback)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

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

jobListPreparationAndReleaseTaskStatusNextOptions - 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

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPreparationAndReleaseTaskStatusNextAsync

public ServiceFuture> listPreparationAndReleaseTaskStatusNextAsync(final String nextPageLink, final ServiceFuture> serviceFuture, final ListOperationCallback serviceCallback)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPreparationAndReleaseTaskStatusNextWithServiceResponseAsync

public Observable, JobListPreparationAndReleaseTaskStatusHeaders>> listPreparationAndReleaseTaskStatusNextWithServiceResponseAsync(final String nextPageLink)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

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

Returns:

the observable to the PagedList<JobPreparationAndReleaseTaskExecutionInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPreparationAndReleaseTaskStatusNextWithServiceResponseAsync

public Observable, JobListPreparationAndReleaseTaskStatusHeaders>> listPreparationAndReleaseTaskStatusNextWithServiceResponseAsync(final String nextPageLink, final JobListPreparationAndReleaseTaskStatusNextOptions jobListPreparationAndReleaseTaskStatusNextOptions)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

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

jobListPreparationAndReleaseTaskStatusNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<JobPreparationAndReleaseTaskExecutionInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPreparationAndReleaseTaskStatusWithServiceResponseAsync

public Observable, JobListPreparationAndReleaseTaskStatusHeaders>> listPreparationAndReleaseTaskStatusWithServiceResponseAsync(final String jobId)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

jobId - The ID of the job.

Returns:

the observable to the PagedList<JobPreparationAndReleaseTaskExecutionInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPreparationAndReleaseTaskStatusWithServiceResponseAsync

public Observable, JobListPreparationAndReleaseTaskStatusHeaders>> listPreparationAndReleaseTaskStatusWithServiceResponseAsync(final String jobId, final JobListPreparationAndReleaseTaskStatusOptions jobListPreparationAndReleaseTaskStatusOptions)

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run. This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

Parameters:

jobId - The ID of the job.

jobListPreparationAndReleaseTaskStatusOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<JobPreparationAndReleaseTaskExecutionInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

public Observable, JobListHeaders>> listWithServiceResponseAsync()

Lists all of the jobs in the specified account.

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

public Observable, JobListHeaders>> listWithServiceResponseAsync(final JobListOptions jobListOptions)

Lists all of the jobs in the specified account.

Parameters:

jobListOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudJob> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patch

public void patch(String jobId, JobPatchParameter jobPatchParameter)

Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobPatchParameter - The parameters for the request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

patch

public void patch(String jobId, JobPatchParameter jobPatchParameter, JobPatchOptions jobPatchOptions)

Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobPatchParameter - The parameters for the request.

jobPatchOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

patchAsync

public Observable patchAsync(String jobId, JobPatchParameter jobPatchParameter)

Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobPatchParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patchAsync

public ServiceFuture patchAsync(String jobId, JobPatchParameter jobPatchParameter, final ServiceCallback serviceCallback)

Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobPatchParameter - The parameters for the request.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patchAsync

public Observable patchAsync(String jobId, JobPatchParameter jobPatchParameter, JobPatchOptions jobPatchOptions)

Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobPatchParameter - The parameters for the request.

jobPatchOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patchAsync

public ServiceFuture patchAsync(String jobId, JobPatchParameter jobPatchParameter, JobPatchOptions jobPatchOptions, final ServiceCallback serviceCallback)

Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobPatchParameter - The parameters for the request.

jobPatchOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patchWithServiceResponseAsync

public Observable> patchWithServiceResponseAsync(String jobId, JobPatchParameter jobPatchParameter)

Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobPatchParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patchWithServiceResponseAsync

public Observable> patchWithServiceResponseAsync(String jobId, JobPatchParameter jobPatchParameter, JobPatchOptions jobPatchOptions)

Updates the properties of the specified job. This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobPatchParameter - The parameters for the request.

jobPatchOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

terminate

public void terminate(String jobId)

Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.

Parameters:

jobId - The ID of the job to terminate.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

terminate

public void terminate(String jobId, String terminateReason, JobTerminateOptions jobTerminateOptions)

Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.

Parameters:

jobId - The ID of the job to terminate.

terminateReason - The text you want to appear as the job's TerminateReason. The default is 'UserTerminate'.

jobTerminateOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

terminateAsync

public Observable terminateAsync(String jobId)

Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.

Parameters:

jobId - The ID of the job to terminate.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

terminateAsync

public ServiceFuture terminateAsync(String jobId, final ServiceCallback serviceCallback)

Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.

Parameters:

jobId - The ID of the job to terminate.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

terminateAsync

public Observable terminateAsync(String jobId, String terminateReason, JobTerminateOptions jobTerminateOptions)

Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.

Parameters:

jobId - The ID of the job to terminate.

terminateReason - The text you want to appear as the job's TerminateReason. The default is 'UserTerminate'.

jobTerminateOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

terminateAsync

public ServiceFuture terminateAsync(String jobId, String terminateReason, JobTerminateOptions jobTerminateOptions, final ServiceCallback serviceCallback)

Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.

Parameters:

jobId - The ID of the job to terminate.

terminateReason - The text you want to appear as the job's TerminateReason. The default is 'UserTerminate'.

jobTerminateOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

terminateWithServiceResponseAsync

public Observable> terminateWithServiceResponseAsync(String jobId)

Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.

Parameters:

jobId - The ID of the job to terminate.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

terminateWithServiceResponseAsync

public Observable> terminateWithServiceResponseAsync(String jobId, String terminateReason, JobTerminateOptions jobTerminateOptions)

Terminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.

Parameters:

jobId - The ID of the job to terminate.

terminateReason - The text you want to appear as the job's TerminateReason. The default is 'UserTerminate'.

jobTerminateOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

update

public void update(String jobId, JobUpdateParameter jobUpdateParameter)

Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobUpdateParameter - The parameters for the request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

update

public void update(String jobId, JobUpdateParameter jobUpdateParameter, JobUpdateOptions jobUpdateOptions)

Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobUpdateParameter - The parameters for the request.

jobUpdateOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateAsync

public Observable updateAsync(String jobId, JobUpdateParameter jobUpdateParameter)

Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobUpdateParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateAsync

public ServiceFuture updateAsync(String jobId, JobUpdateParameter jobUpdateParameter, final ServiceCallback serviceCallback)

Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobUpdateParameter - The parameters for the request.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateAsync

public Observable updateAsync(String jobId, JobUpdateParameter jobUpdateParameter, JobUpdateOptions jobUpdateOptions)

Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobUpdateParameter - The parameters for the request.

jobUpdateOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateAsync

public ServiceFuture updateAsync(String jobId, JobUpdateParameter jobUpdateParameter, JobUpdateOptions jobUpdateOptions, final ServiceCallback serviceCallback)

Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobUpdateParameter - The parameters for the request.

jobUpdateOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateWithServiceResponseAsync

public Observable> updateWithServiceResponseAsync(String jobId, JobUpdateParameter jobUpdateParameter)

Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobUpdateParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateWithServiceResponseAsync

public Observable> updateWithServiceResponseAsync(String jobId, JobUpdateParameter jobUpdateParameter, JobUpdateOptions jobUpdateOptions)

Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

Parameters:

jobId - The ID of the job whose properties you want to update.

jobUpdateParameter - The parameters for the request.

jobUpdateOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation