SubtaskInformation Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. SubtaskInformation
- com.
public class SubtaskInformation
Information about an Azure Batch subtask.
Method Summary
Modifier and Type | Method and Description |
---|---|
Task |
containerInfo()
Get this property is set only if the task runs in a container context. |
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. 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. |
Task |
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. |
Compute |
nodeInfo()
Get the nodeInfo value. |
Subtask |
previousState()
Get this property is not set if the subtask is in its initial running state. Possible values include: 'preparing', 'running', 'completed'. |
DateTime |
previousStateTransitionTime()
Get this property is not set if the subtask is in its initial running state. |
Task |
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'. |
DateTime |
startTime()
Get the startTime value. |
Subtask |
state()
Get possible values include: 'preparing', 'running', 'completed'. |
DateTime |
stateTransitionTime()
Get the stateTransitionTime value. |
Subtask |
withContainerInfo(TaskContainerExecutionInformation containerInfo)
Set this property is set only if the task runs in a container context. |
Subtask |
withEndTime(DateTime endTime)
Set this property is set only if the subtask is in the Completed state. |
Subtask |
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. |
Subtask |
withFailureInfo(TaskFailureInformation failureInfo)
Set this property is set only if the task is in the completed state and encountered a failure. |
Subtask |
withId(Integer id)
Set the id value. |
Subtask |
withNodeInfo(ComputeNodeInformation nodeInfo)
Set the nodeInfo value. |
Subtask |
withPreviousState(SubtaskState previousState)
Set this property is not set if the subtask is in its initial running state. Possible values include: 'preparing', 'running', 'completed'. |
Subtask |
withPreviousStateTransitionTime(DateTime previousStateTransitionTime)
Set this property is not set if the subtask is in its initial running state. |
Subtask |
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'. |
Subtask |
withStartTime(DateTime startTime)
Set the startTime value. |
Subtask |
withState(SubtaskState state)
Set possible values include: 'preparing', 'running', 'completed'. |
Subtask |
withStateTransitionTime(DateTime stateTransitionTime)
Set the stateTransitionTime value. |
Method Details
containerInfo
public TaskContainerExecutionInformation containerInfo()
Get this property is set only if the task runs in a container context.
Returns:
endTime
public DateTime endTime()
Get this property is set only if the subtask is in the Completed state.
Returns:
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:
failureInfo
public TaskFailureInformation failureInfo()
Get this property is set only if the task is in the completed state and encountered a failure.
Returns:
id
public Integer id()
Get the id value.
Returns:
nodeInfo
public ComputeNodeInformation nodeInfo()
Get the nodeInfo value.
Returns:
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:
previousStateTransitionTime
public DateTime previousStateTransitionTime()
Get this property is not set if the subtask is in its initial running state.
Returns:
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:
startTime
public DateTime startTime()
Get the startTime value.
Returns:
state
public SubtaskState state()
Get possible values include: 'preparing', 'running', 'completed'.
Returns:
stateTransitionTime
public DateTime stateTransitionTime()
Get the stateTransitionTime value.
Returns:
withContainerInfo
public SubtaskInformation withContainerInfo(TaskContainerExecutionInformation containerInfo)
Set this property is set only if the task runs in a container context.
Parameters:
Returns:
withEndTime
public SubtaskInformation withEndTime(DateTime endTime)
Set this property is set only if the subtask is in the Completed state.
Parameters:
Returns:
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:
Returns:
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:
Returns:
withId
public SubtaskInformation withId(Integer id)
Set the id value.
Parameters:
Returns:
withNodeInfo
public SubtaskInformation withNodeInfo(ComputeNodeInformation nodeInfo)
Set the nodeInfo value.
Parameters:
Returns:
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:
Returns:
withPreviousStateTransitionTime
public SubtaskInformation withPreviousStateTransitionTime(DateTime previousStateTransitionTime)
Set this property is not set if the subtask is in its initial running state.
Parameters:
Returns:
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:
Returns:
withStartTime
public SubtaskInformation withStartTime(DateTime startTime)
Set the startTime value.
Parameters:
Returns:
withState
public SubtaskInformation withState(SubtaskState state)
Set possible values include: 'preparing', 'running', 'completed'.
Parameters:
Returns:
withStateTransitionTime
public SubtaskInformation withStateTransitionTime(DateTime stateTransitionTime)
Set the stateTransitionTime value.
Parameters:
Returns:
Applies to
Azure SDK for Java