SubtaskInformation Class

Package:

com.microsoft.azure.batch.protocol.models

Maven Artifact:

com.microsoft.azure:azure-batch:11.1.1

• java.lang.Object
• • com.microsoft.azure.batch.protocol.models.SubtaskInformation

public class SubtaskInformation

Information about an Azure Batch subtask.

Constructor Summary

Constructor	Description
SubtaskInformation()

Method Summary

Modifier and Type	Method and Description
TaskContainerExecutionInformation	containerInfo() Get this property is set only if the Task runs in a container context.
org.joda.time.DateTime	endTime() Get this property is set only if the subtask is in the Completed state.
Integer	exitCode() Get this property is set only if the subtask is in the completed state.
TaskFailureInformation	failureInfo() Get this property is set only if the Task is in the completed state and encountered a failure.
Integer	id() Get the id value.
ComputeNodeInformation	nodeInfo() Get the nodeInfo value.
SubtaskState	previousState() Get this property is not set if the subtask is in its initial running state.
org.joda.time.DateTime	previousStateTransitionTime() Get this property is not set if the subtask is in its initial running state.
TaskExecutionResult	result() Get if the value is 'failed', then the details of the failure can be found in the failureInfo property.
org.joda.time.DateTime	startTime() Get the startTime value.
SubtaskState	state() Get possible values include: 'preparing', 'running', 'completed'.
org.joda.time.DateTime	stateTransitionTime() Get the stateTransitionTime value.
SubtaskInformation	withContainerInfo(TaskContainerExecutionInformation containerInfo) Set this property is set only if the Task runs in a container context.
SubtaskInformation	withEndTime(DateTime endTime) Set this property is set only if the subtask is in the Completed state.
SubtaskInformation	withExitCode(Integer exitCode) Set this property is set only if the subtask is in the completed state.
SubtaskInformation	withFailureInfo(TaskFailureInformation failureInfo) Set this property is set only if the Task is in the completed state and encountered a failure.
SubtaskInformation	withId(Integer id) Set the id value.
SubtaskInformation	withNodeInfo(ComputeNodeInformation nodeInfo) Set the nodeInfo value.
SubtaskInformation	withPreviousState(SubtaskState previousState) Set this property is not set if the subtask is in its initial running state.
SubtaskInformation	withPreviousStateTransitionTime(DateTime previousStateTransitionTime) Set this property is not set if the subtask is in its initial running state.
SubtaskInformation	withResult(TaskExecutionResult result) Set if the value is 'failed', then the details of the failure can be found in the failureInfo property.
SubtaskInformation	withStartTime(DateTime startTime) Set the startTime value.
SubtaskInformation	withState(SubtaskState state) Set possible values include: 'preparing', 'running', 'completed'.
SubtaskInformation	withStateTransitionTime(DateTime stateTransitionTime) Set the stateTransitionTime value.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SubtaskInformation

public SubtaskInformation()

Method Details

containerInfo

public TaskContainerExecutionInformation containerInfo()

Get this property is set only if the Task runs in a container context.

Returns:

the containerInfo value

endTime

public DateTime endTime()

Get this property is set only if the subtask is in the Completed state.

Returns:

the endTime value

exitCode

public Integer exitCode()

Get this property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code.

Returns:

the exitCode value

failureInfo

public TaskFailureInformation failureInfo()

Get this property is set only if the Task is in the completed state and encountered a failure.

Returns:

the failureInfo value

id

public Integer id()

Get the id value.

Returns:

the id value

nodeInfo

public ComputeNodeInformation nodeInfo()

Get the nodeInfo value.

Returns:

the nodeInfo value

previousState

public SubtaskState previousState()

Get this property is not set if the subtask is in its initial running state. Possible values include: 'preparing', 'running', 'completed'.

Returns:

the previousState value

previousStateTransitionTime

public DateTime previousStateTransitionTime()

Get this property is not set if the subtask is in its initial running state.

Returns:

the previousStateTransitionTime value

result

public TaskExecutionResult result()

Get if the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'.

Returns:

the result value

startTime

public DateTime startTime()

Get the startTime value.

Returns:

the startTime value

state

public SubtaskState state()

Get possible values include: 'preparing', 'running', 'completed'.

Returns:

the state value

stateTransitionTime

public DateTime stateTransitionTime()

Get the stateTransitionTime value.

Returns:

the stateTransitionTime value

withContainerInfo

public SubtaskInformation withContainerInfo(TaskContainerExecutionInformation containerInfo)

Set this property is set only if the Task runs in a container context.

Parameters:

containerInfo - the containerInfo value to set

Returns:

the SubtaskInformation object itself.

withEndTime

public SubtaskInformation withEndTime(DateTime endTime)

Set this property is set only if the subtask is in the Completed state.

Parameters:

endTime - the endTime value to set

Returns:

the SubtaskInformation object itself.

withExitCode

public SubtaskInformation withExitCode(Integer exitCode)

Set this property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code.

Parameters:

exitCode - the exitCode value to set

Returns:

the SubtaskInformation object itself.

withFailureInfo

public SubtaskInformation withFailureInfo(TaskFailureInformation failureInfo)

Set this property is set only if the Task is in the completed state and encountered a failure.

Parameters:

failureInfo - the failureInfo value to set

Returns:

the SubtaskInformation object itself.

withId

public SubtaskInformation withId(Integer id)

Set the id value.

Parameters:

id - the id value to set

Returns:

the SubtaskInformation object itself.

withNodeInfo

public SubtaskInformation withNodeInfo(ComputeNodeInformation nodeInfo)

Set the nodeInfo value.

Parameters:

nodeInfo - the nodeInfo value to set

Returns:

the SubtaskInformation object itself.

withPreviousState

public SubtaskInformation withPreviousState(SubtaskState previousState)

Set this property is not set if the subtask is in its initial running state. Possible values include: 'preparing', 'running', 'completed'.

Parameters:

previousState - the previousState value to set

Returns:

the SubtaskInformation object itself.

withPreviousStateTransitionTime

public SubtaskInformation withPreviousStateTransitionTime(DateTime previousStateTransitionTime)

Set this property is not set if the subtask is in its initial running state.

Parameters:

previousStateTransitionTime - the previousStateTransitionTime value to set

Returns:

the SubtaskInformation object itself.

withResult

public SubtaskInformation withResult(TaskExecutionResult result)

Set if the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'.

Parameters:

result - the result value to set

Returns:

the SubtaskInformation object itself.

withStartTime

public SubtaskInformation withStartTime(DateTime startTime)

Set the startTime value.

Parameters:

startTime - the startTime value to set

Returns:

the SubtaskInformation object itself.

withState

public SubtaskInformation withState(SubtaskState state)

Set possible values include: 'preparing', 'running', 'completed'.

Parameters:

state - the state value to set

Returns:

the SubtaskInformation object itself.

withStateTransitionTime

public SubtaskInformation withStateTransitionTime(DateTime stateTransitionTime)

Set the stateTransitionTime value.

Parameters:

stateTransitionTime - the stateTransitionTime value to set

Returns:

the SubtaskInformation object itself.