JobPreparationTask (Microsoft Azure Libraries for Java)

java.lang.Object
- com.microsoft.azure.batch.protocol.models.JobPreparationTask

```
public class JobPreparationTask
extends Object
```
A Job Preparation task to run before any tasks of the job on any given compute node. You can use Job Preparation to prepare a compute node to run tasks for the job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the tasks in the job. The Job Preparation task can download these common resource files to the shared location on the compute node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service on the compute node so that all tasks of that job can communicate with it. If the Job Preparation task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run tasks of this job on the compute node. The node remains ineligible to run tasks of this job until it is reimaged. The node remains active and can be used for other jobs. The Job Preparation task can run multiple times on the same compute node. Therefore, you should write the Job Preparation task to handle re-execution. If the compute node is rebooted, the Job Preparation task is run again on the node before scheduling any other task of the job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task did not previously complete. If the compute node is reimaged, the Job Preparation task is run again before scheduling any task of the job.

Constructor Summary

Constructors
Constructor and Description

JobPreparationTask()

Constructors
Constructor and Description
`JobPreparationTask()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`commandLine()` Get the commandLine value.
`TaskConstraints`	`constraints()` Get the constraints value.
`TaskContainerSettings`	`containerSettings()` Get the containerSettings value.
`List<EnvironmentSetting>`	`environmentSettings()` Get the environmentSettings value.
`String`	`id()` Get the id value.
`Boolean`	`rerunOnNodeRebootAfterSuccess()` Get the rerunOnNodeRebootAfterSuccess value.
`List<ResourceFile>`	`resourceFiles()` Get the resourceFiles value.
`UserIdentity`	`userIdentity()` Get the userIdentity value.
`Boolean`	`waitForSuccess()` Get the waitForSuccess value.
`JobPreparationTask`	`withCommandLine(String commandLine)` Set the commandLine value.
`JobPreparationTask`	`withConstraints(TaskConstraints constraints)` Set the constraints value.
`JobPreparationTask`	`withContainerSettings(TaskContainerSettings containerSettings)` Set the containerSettings value.
`JobPreparationTask`	`withEnvironmentSettings(List<EnvironmentSetting> environmentSettings)` Set the environmentSettings value.
`JobPreparationTask`	`withId(String id)` Set the id value.
`JobPreparationTask`	`withRerunOnNodeRebootAfterSuccess(Boolean rerunOnNodeRebootAfterSuccess)` Set the rerunOnNodeRebootAfterSuccess value.
`JobPreparationTask`	`withResourceFiles(List<ResourceFile> resourceFiles)` Set the resourceFiles value.
`JobPreparationTask`	`withUserIdentity(UserIdentity userIdentity)` Set the userIdentity value.
`JobPreparationTask`	`withWaitForSuccess(Boolean waitForSuccess)` Set the waitForSuccess value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JobPreparationTask
```
public JobPreparationTask()
```
- Method Detail
  - id
```
public String id()
```
    Get the id value.
    
    Returns:
    
    the id value
  - withId
```
public JobPreparationTask withId(String id)
```
    Set the id value.
    
    Parameters:
    
    id - the id value to set
    
    Returns:
    
    the JobPreparationTask object itself.
  - commandLine
```
public String commandLine()
```
    Get the commandLine value.
    
    Returns:
    
    the commandLine value
  - withCommandLine
```
public JobPreparationTask withCommandLine(String commandLine)
```
    Set the commandLine value.
    
    Parameters:
    
    commandLine - the commandLine value to set
    
    Returns:
    
    the JobPreparationTask object itself.
  - containerSettings
```
public TaskContainerSettings containerSettings()
```
    Get the containerSettings value.
    
    Returns:
    
    the containerSettings value
  - withContainerSettings
```
public JobPreparationTask withContainerSettings(TaskContainerSettings containerSettings)
```
    Set the containerSettings value.
    
    Parameters:
    
    containerSettings - the containerSettings value to set
    
    Returns:
    
    the JobPreparationTask object itself.
  - resourceFiles
```
public List<ResourceFile> resourceFiles()
```
    Get the resourceFiles value.
    
    Returns:
    
    the resourceFiles value
  - withResourceFiles
```
public JobPreparationTask withResourceFiles(List<ResourceFile> resourceFiles)
```
    Set the resourceFiles value.
    
    Parameters:
    
    resourceFiles - the resourceFiles value to set
    
    Returns:
    
    the JobPreparationTask object itself.
  - environmentSettings
```
public List<EnvironmentSetting> environmentSettings()
```
    Get the environmentSettings value.
    
    Returns:
    
    the environmentSettings value
  - withEnvironmentSettings
```
public JobPreparationTask withEnvironmentSettings(List<EnvironmentSetting> environmentSettings)
```
    Set the environmentSettings value.
    
    Parameters:
    
    environmentSettings - the environmentSettings value to set
    
    Returns:
    
    the JobPreparationTask object itself.
  - constraints
```
public TaskConstraints constraints()
```
    Get the constraints value.
    
    Returns:
    
    the constraints value
  - withConstraints
```
public JobPreparationTask withConstraints(TaskConstraints constraints)
```
    Set the constraints value.
    
    Parameters:
    
    constraints - the constraints value to set
    
    Returns:
    
    the JobPreparationTask object itself.
  - waitForSuccess
```
public Boolean waitForSuccess()
```
    Get the waitForSuccess value.
    
    Returns:
    
    the waitForSuccess value
  - withWaitForSuccess
```
public JobPreparationTask withWaitForSuccess(Boolean waitForSuccess)
```
    Set the waitForSuccess value.
    
    Parameters:
    
    waitForSuccess - the waitForSuccess value to set
    
    Returns:
    
    the JobPreparationTask object itself.
  - userIdentity
```
public UserIdentity userIdentity()
```
    Get the userIdentity value.
    
    Returns:
    
    the userIdentity value
  - withUserIdentity
```
public JobPreparationTask withUserIdentity(UserIdentity userIdentity)
```
    Set the userIdentity value.
    
    Parameters:
    
    userIdentity - the userIdentity value to set
    
    Returns:
    
    the JobPreparationTask object itself.
  - rerunOnNodeRebootAfterSuccess
```
public Boolean rerunOnNodeRebootAfterSuccess()
```
    Get the rerunOnNodeRebootAfterSuccess value.
    
    Returns:
    
    the rerunOnNodeRebootAfterSuccess value
  - withRerunOnNodeRebootAfterSuccess
```
public JobPreparationTask withRerunOnNodeRebootAfterSuccess(Boolean rerunOnNodeRebootAfterSuccess)
```
    Set the rerunOnNodeRebootAfterSuccess value.
    
    Parameters:
    
    rerunOnNodeRebootAfterSuccess - the rerunOnNodeRebootAfterSuccess value to set
    
    Returns:
    
    the JobPreparationTask object itself.

Class JobPreparationTask

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobPreparationTask

Method Detail

id

withId

commandLine

withCommandLine

containerSettings

withContainerSettings

resourceFiles

withResourceFiles

environmentSettings

withEnvironmentSettings

constraints

withConstraints

waitForSuccess

withWaitForSuccess

userIdentity

withUserIdentity

rerunOnNodeRebootAfterSuccess

withRerunOnNodeRebootAfterSuccess