com.microsoft.azure.batch.protocol.models

Class JobReleaseTask

java.lang.Object

com.microsoft.azure.batch.protocol.models.JobReleaseTask

public class JobReleaseTask
extends Object

A Job Release task to run on job completion on any compute node where the job has run. The Job Release task runs when the job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the job is still active, the job's maximum wall clock time constraint is reached, and the job is still active, or the job's Job Manager task completed, and the job is configured to terminate when the Job Manager completes. The Job Release task runs on each compute node where tasks of the job have run and the Job Preparation task ran and completed. If you reimage a compute node after it has run the Job Preparation task, and the job ends without any further tasks of the job running on that compute node (and hence the Job Preparation task does not re-run), then the Job Release task does not run on that node. If a compute node reboots while the Job Release task is still running, the Job Release task runs again when the compute node starts up. The job is not marked as complete until all Job Release tasks have completed. The Job Release task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the maxTasksPerNode limit specified on the pool.

Constructor Summary

Constructors

Constructor and Description
JobReleaseTask()

Method Summary

Modifier and Type	Method and Description
String	commandLine() Get the commandLine value.
TaskContainerSettings	containerSettings() Get the containerSettings value.
List<EnvironmentSetting>	environmentSettings() Get the environmentSettings value.
String	id() Get the id value.
org.joda.time.Period	maxWallClockTime() Get the maxWallClockTime value.
List<ResourceFile>	resourceFiles() Get the resourceFiles value.
org.joda.time.Period	retentionTime() Get the retentionTime value.
UserIdentity	userIdentity() Get the userIdentity value.
JobReleaseTask	withCommandLine(String commandLine) Set the commandLine value.
JobReleaseTask	withContainerSettings(TaskContainerSettings containerSettings) Set the containerSettings value.
JobReleaseTask	withEnvironmentSettings(List<EnvironmentSetting> environmentSettings) Set the environmentSettings value.
JobReleaseTask	withId(String id) Set the id value.
JobReleaseTask	withMaxWallClockTime(org.joda.time.Period maxWallClockTime) Set the maxWallClockTime value.
JobReleaseTask	withResourceFiles(List<ResourceFile> resourceFiles) Set the resourceFiles value.
JobReleaseTask	withRetentionTime(org.joda.time.Period retentionTime) Set the retentionTime value.
JobReleaseTask	withUserIdentity(UserIdentity userIdentity) Set the userIdentity value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobReleaseTask

public JobReleaseTask()

Method Detail

id

public String id()

Get the id value.

Returns:

the id value

withId

public JobReleaseTask withId(String id)

Set the id value.

Parameters:

id - the id value to set

Returns:

the JobReleaseTask object itself.

commandLine

public String commandLine()

Get the commandLine value.

Returns:

the commandLine value

withCommandLine

public JobReleaseTask withCommandLine(String commandLine)

Set the commandLine value.

Parameters:

commandLine - the commandLine value to set

Returns:

the JobReleaseTask object itself.

containerSettings

public TaskContainerSettings containerSettings()

Get the containerSettings value.

Returns:

the containerSettings value

withContainerSettings

public JobReleaseTask withContainerSettings(TaskContainerSettings containerSettings)

Set the containerSettings value.

Parameters:

containerSettings - the containerSettings value to set

Returns:

the JobReleaseTask object itself.

resourceFiles

public List<ResourceFile> resourceFiles()

Get the resourceFiles value.

Returns:

the resourceFiles value

withResourceFiles

public JobReleaseTask withResourceFiles(List<ResourceFile> resourceFiles)

Set the resourceFiles value.

Parameters:

resourceFiles - the resourceFiles value to set

Returns:

the JobReleaseTask object itself.

environmentSettings

public List<EnvironmentSetting> environmentSettings()

Get the environmentSettings value.

Returns:

the environmentSettings value

withEnvironmentSettings

public JobReleaseTask withEnvironmentSettings(List<EnvironmentSetting> environmentSettings)

Set the environmentSettings value.

Parameters:

environmentSettings - the environmentSettings value to set

Returns:

the JobReleaseTask object itself.

maxWallClockTime

public org.joda.time.Period maxWallClockTime()

Get the maxWallClockTime value.

Returns:

the maxWallClockTime value

withMaxWallClockTime

public JobReleaseTask withMaxWallClockTime(org.joda.time.Period maxWallClockTime)

Set the maxWallClockTime value.

Parameters:

maxWallClockTime - the maxWallClockTime value to set

Returns:

the JobReleaseTask object itself.

retentionTime

public org.joda.time.Period retentionTime()

Get the retentionTime value.

Returns:

the retentionTime value

withRetentionTime

public JobReleaseTask withRetentionTime(org.joda.time.Period retentionTime)

Set the retentionTime value.

Parameters:

retentionTime - the retentionTime value to set

Returns:

the JobReleaseTask object itself.

userIdentity

public UserIdentity userIdentity()

Get the userIdentity value.

Returns:

the userIdentity value

withUserIdentity

public JobReleaseTask withUserIdentity(UserIdentity userIdentity)

Set the userIdentity value.

Parameters:

userIdentity - the userIdentity value to set

Returns:

the JobReleaseTask object itself.