IJob

All Known Implementing Classes:

Job
```
public interface IJob
```
Represents a group of tasks in the system.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addTask(Task task)` Adds a task to Job.
`void`	`cancel()` Cancels all tasks in this job.
`void`	`cancel(boolean listenForCancellationEvent)` Cancels all tasks in this job.
`AgentSelectionType`	`getAgentSelectionPreference()` Gets the agent selection preference.
`boolean`	`getCancelOnClientDisconnection()` Gets a value indicating whether to cancel the tasks of this Job when the client disconnects.
`boolean`	`getCancelOnTaskFailure()` Gets a value indicating whether to cancel other tasks on this Job if another `Task` fails.
`java.lang.String`	`getDescription()` Gets the Job description.
`boolean`	`getExclusiveExecution()` Gets a value indicating whether the tasks on this job should have exclusive access to the resource it is running on.
`boolean`	`getFailIfPreconditionsNotSatisfied()` Gets a value indicating whether to fail all tasks immediately of this Job if the precondition is not satisfied.
`java.util.UUID`	`getId()` Gets the job's id.
`boolean`	`getIsCanceled()` Gets a value indicating whether this job has been canceled.
`short`	`getMaxTaskInterruptedRetryAttempts()` Gets the maximum number of times task will be retried if task gets interrupted.
`boolean`	`getMinimizeClientMessaging()` Gets a value indicating whether to minimize sending some messages from the Coordinator.
`java.lang.String`	`getName()` Gets the Job name.
`TaskEnvironment`	`getTaskEnvironment()` Gets Job's `TaskEnvironment` (`get` / `set`) By default, an instance of `DefaultTaskEnvironment` is set as the task environment of a new job.
`int`	`getTaskExecutionTimeout()` Gets the timeout for task execution in milliseconds.
`void`	`setAgentSelectionPreference(AgentSelectionType value)` Sets the agent selection preference.
`void`	`setCancelOnClientDisconnection(boolean value)` Sets a value indicating whether to cancel the tasks of this Job when the client disconnects.
`void`	`setCancelOnTaskFailure(boolean value)` Sets a value indicating whether to cancel other tasks on this Job if another `Task` fails.
`void`	`setDescription(java.lang.String value)` Sets the Job description.
`void`	`setExclusiveExecution(boolean value)` Sets a value indicating whether the tasks on this job should have exclusive access to the resource it is running on.
`void`	`setFailIfPreconditionsNotSatisfied(boolean value)` Sets a value indicating whether to fail all tasks immediately of this Job if the precondition is not satisfied.
`void`	`setMaxTaskInterruptedRetryAttempts(short value)` Sets the maximum number of times task will be retried if task gets interrupted.
`void`	`setMinimizeClientMessaging(boolean value)` Sets a value indicating whether to minimize sending some messages from the Coordinator.
`void`	`setName(java.lang.String name)` Sets the Job name.
`void`	`setTaskEnvironment(TaskEnvironment value)` Sets Job's `TaskEnvironment` (`get` / `set`)
`void`	`setTaskExecutionTimeout(int value)` Sets the timeout for task execution in milliseconds.
`void`	`submit()` Submits job to job scheduler.
`boolean`	`waitUntilDone()` Blocks until all tasks in this job complete.
`boolean`	`waitUntilDone(int millisecondsTimeout)` Blocks until all tasks in this job complete or the operation times out.
`boolean`	`waitUntilDone(int millisecondsTimeout, java.lang.Runnable heartbeatCallback, int millisecondsHeartbeat)` Blocks until all tasks in this job complete or the operation times out.

- Method Detail
  - getId
```
java.util.UUID getId()
```
    Gets the job's id.
    
    Returns:
    
    The job id.
  - getTaskEnvironment
```
TaskEnvironment getTaskEnvironment()
```
    Gets Job's TaskEnvironment (get / set) By default, an instance of DefaultTaskEnvironment is set as the task environment of a new job.
    
    Returns:
    
    The task environment.
  - setTaskEnvironment
```
void setTaskEnvironment(TaskEnvironment value)
```
    Sets Job's TaskEnvironment (get / set)
    By default, an instance of DefaultTaskEnvironment is set as the task environment of a new job.
    
    Parameters:
    
    value - The task environment.
  - getCancelOnClientDisconnection
```
boolean getCancelOnClientDisconnection()
```
    Gets a value indicating whether to cancel the tasks of this Job when the client disconnects.
    CancelOnClientDisconnection ensures that a task does not remain in the coordinator's task queue if the client is no longer connected. If a client disconnects unexpectedly, all tasks in the job are canceled. This is useful for interactive jobs which only makes sense to run if the client is connected and is waiting to process the result of the task.
    
    Returns:
    
    true if task should be canceled when the client disconnects. false otherwise.
  - setCancelOnClientDisconnection
```
void setCancelOnClientDisconnection(boolean value)
```
    Sets a value indicating whether to cancel the tasks of this Job when the client disconnects.
    CancelOnClientDisconnection ensures that a task does not remain in the coordinator's task queue if the client is no longer connected. If a client disconnects unexpectedly, all tasks in the job are canceled. This is useful for interactive jobs which only makes sense to run if the client is connected and is waiting to process the result of the task.
    
    Parameters:
    
    value - true if task should be canceled when the client disconnects. false otherwise.
  - getCancelOnTaskFailure
```
boolean getCancelOnTaskFailure()
```
    Gets a value indicating whether to cancel other tasks on this Job if another Task fails.
    CancelOnTaskFailure ensures that a task does not remain in the coordinator's task queue if the task fails. This is useful for jobs which are considered logically successful if all the tasks are successful. That is, if a single task fails, then the whole job should be considered a failure.
  - setCancelOnTaskFailure
```
void setCancelOnTaskFailure(boolean value)
```
    Sets a value indicating whether to cancel other tasks on this Job if another Task fails.
    CancelOnTaskFailure ensures that a task does not remain in the coordinator's task queue if the task fails. This is useful for jobs which are considered logically successful if all the tasks are successful. That is, if a single task fails, then the whole job should be considered a failure.
  - getFailIfPreconditionsNotSatisfied
```
boolean getFailIfPreconditionsNotSatisfied()
```
    Gets a value indicating whether to fail all tasks immediately of this Job if the precondition is not satisfied.
    FailIfPreconditionsNotSatisfied ensures that a task does not remain in the coordinator's task queue if there are currently no agents which meet the preconditions. This is useful for applications which would rather fail fast if a job can't be run rather than wait for certain conditions to become true in the future.
  - setFailIfPreconditionsNotSatisfied
```
void setFailIfPreconditionsNotSatisfied(boolean value)
```
    Sets a value indicating whether to fail all tasks immediately of this Job if the precondition is not satisfied.
    FailIfPreconditionsNotSatisfied ensures that a task does not remain in the coordinator's task queue if there are currently no agents which meet the preconditions. This is useful for applications which would rather fail fast if a job can't be run rather than wait for certain conditions to become true in the future.
  - getMinimizeClientMessaging
```
boolean getMinimizeClientMessaging()
```
    Gets a value indicating whether to minimize sending some messages from the Coordinator.
  - setMinimizeClientMessaging
```
void setMinimizeClientMessaging(boolean value)
```
    Sets a value indicating whether to minimize sending some messages from the Coordinator.
  - getMaxTaskInterruptedRetryAttempts
```
short getMaxTaskInterruptedRetryAttempts()
```
    Gets the maximum number of times task will be retried if task gets interrupted.
    While executing a task, there are a number of system errors that may occur that may happen no matter how well your task is coded. Some examples include the host process exiting abnormally or an agent disconnecting from the coordinator while the agent "owns" a task. Normally, these errors are recoverable; if the task was retried again the task may succeed. As such, the system will try to reassign the task for execution for as many times as MaxTaskInterruptedRetryAttempts is specified.
    Setting the maximum task interrupted retry attempts to 0 means that the task will never be retried if there is a system exception while executing the task.
  - setMaxTaskInterruptedRetryAttempts
```
void setMaxTaskInterruptedRetryAttempts(short value)
```
    Sets the maximum number of times task will be retried if task gets interrupted.
    While executing a task, there are a number of system errors that may occur that may happen no matter how well your task is coded. Some examples include the host process exiting abnormally or an agent disconnecting from the coordinator while the agent "owns" a task. Normally, these errors are recoverable; if the task was retried again the task may succeed. As such, the system will try to reassign the task for execution for as many times as MaxTaskInterruptedRetryAttempts is specified.
    Setting the maximum task interrupted retry attempts to 0 means that the task will never be retried if there is a system exception while executing the task.
    
    Throws:
    
    java.lang.IllegalArgumentException - Value must be equal or greater than 0.
  - getExclusiveExecution
```
boolean getExclusiveExecution()
```
    Gets a value indicating whether the tasks on this job should have exclusive access to the resource it is running on.
    Tasks can either consume a single core of all the cores of an agent. An exclusive job means that all the task of a job will consume all the cores of an agent. The ExclusiveExecution flag prevents any other task to be executed concurrently.
  - setExclusiveExecution
```
void setExclusiveExecution(boolean value)
```
    Sets a value indicating whether the tasks on this job should have exclusive access to the resource it is running on.
    Tasks can either consume a single core of all the cores of an agent. An exclusive job means that all the task of a job will consume all the cores of an agent. The ExclusiveExecution flag prevents any other task to be executed concurrently.
  - getTaskExecutionTimeout
```
int getTaskExecutionTimeout()
```
    Gets the timeout for task execution in milliseconds.
    TaskExecutionTimeout is the number of milliseconds that a task can run before it is considered timed out. The TaskExecutionTimeout applies to the task execution, it does not include TaskEnvironment setup time or the time duration that passes after a task has been submitted.
  - setTaskExecutionTimeout
```
void setTaskExecutionTimeout(int value)
```
    Sets the timeout for task execution in milliseconds.
    TaskExecutionTimeout is the number of milliseconds that a task can run before it is considered timed out. The TaskExecutionTimeout applies to the task execution, it does not include TaskEnvironment setup time or the time duration that passes after a task has been submitted.
    
    Parameters:
    
    value - Timeout (in milliseconds)
  - getAgentSelectionPreference
```
AgentSelectionType getAgentSelectionPreference()
```
    Gets the agent selection preference.
    
    Returns:
    
    The agent selection preference.
  - setAgentSelectionPreference
```
void setAgentSelectionPreference(AgentSelectionType value)
```
    Sets the agent selection preference.
    
    Parameters:
    
    value - The agent selection preference.
  - getName
```
java.lang.String getName()
```
    Gets the Job name.
    
    Returns:
    
    Job name.
  - setName
```
void setName(java.lang.String name)
```
    Sets the Job name.
    
    Parameters:
    
    name - Job name.
  - getDescription
```
java.lang.String getDescription()
```
    Gets the Job description.
    
    Returns:
    
    The description.
  - setDescription
```
void setDescription(java.lang.String value)
```
    Sets the Job description.
    
    Parameters:
    
    value - The description.
  - getIsCanceled
```
boolean getIsCanceled()
```
    Gets a value indicating whether this job has been canceled.
    
    Returns:
    
    true if the job is canceled; otherwise, false.
  - addTask
```
void addTask(Task task)
```
    Adds a task to Job.
    
    Parameters:
    
    task - The task to be added to Job.
  - submit
```
void submit()
     throws JobSchedulerException
```
    Submits job to job scheduler.
    
    Throws:
    
    JobSchedulerException - If error occurs with job scheduler.
  - waitUntilDone
```
boolean waitUntilDone()
               throws JobSchedulerException
```
    Blocks until all tasks in this job complete.
    
    Returns:
    
    True if the call completed without timing out.
    
    Throws:
    
    JobSchedulerException - If error occurs with job scheduler such as the client timing out.
  - waitUntilDone
```
boolean waitUntilDone(int millisecondsTimeout)
               throws JobSchedulerException
```
    Blocks until all tasks in this job complete or the operation times out.
    
    Parameters:
    
    millisecondsTimeout - The number of milliseconds to wait. Pass to wait indefinitely.
    
    Returns:
    
    True if the call completed without timing out.
    
    Throws:
    
    JobSchedulerException - If error occurs with job scheduler such as the client timing out.
  - waitUntilDone
```
boolean waitUntilDone(int millisecondsTimeout,
                      java.lang.Runnable heartbeatCallback,
                      int millisecondsHeartbeat)
               throws JobSchedulerException
```
    Blocks until all tasks in this job complete or the operation times out. The callback passed in for the heartbeat is called with the period specified by the millisecondsHeartbeat argument.
    
    Parameters:
    
    millisecondsTimeout - The timeout (in milliseconds).
    
    heartbeatCallback - The heartbeat callback.
    
    millisecondsHeartbeat - The heartbeat period (in milliseconds).
    
    Returns:
    
    true if job completed, false if timed-out.
    
    Throws:
    
    JobSchedulerException - If error occurs with job scheduler such as the client timing out.
  - cancel
```
void cancel()
     throws JobSchedulerException
```
    Cancels all tasks in this job. Will not listen for cancellation events.
    
    Throws:
    
    JobSchedulerException
  - cancel
```
void cancel(boolean listenForCancellationEvent)
     throws JobSchedulerException
```
    Cancels all tasks in this job.
    
    Parameters:
    
    listenForCancellationEvent - if set to true, client will listen for the cancellation event. Otherwise, cancellation events can be ignored.
    
    Throws:
    
    JobSchedulerException

Interface IJob

Method Summary

Method Detail

getId

getTaskEnvironment

setTaskEnvironment

getCancelOnClientDisconnection

setCancelOnClientDisconnection

getCancelOnTaskFailure

setCancelOnTaskFailure

getFailIfPreconditionsNotSatisfied

setFailIfPreconditionsNotSatisfied

getMinimizeClientMessaging

setMinimizeClientMessaging

getMaxTaskInterruptedRetryAttempts

setMaxTaskInterruptedRetryAttempts

getExclusiveExecution

setExclusiveExecution

getTaskExecutionTimeout

setTaskExecutionTimeout

getAgentSelectionPreference

setAgentSelectionPreference

getName

setName

getDescription

setDescription

getIsCanceled

addTask

submit

waitUntilDone

waitUntilDone

waitUntilDone

cancel

cancel