State
State
Structure Specification
State
Structure SpecificationState
Parameters
State
ParametersMessage
(string : <optional>)
: A human-readable message giving more context about the current state. Particularly useful for states likeFailed
to provide insight into the nature of any error.
Job State Types
When State
is used for a job, the StateType
can be one of the following:
Pending
: This indicates that the job is submitted but is not yet scheduled for execution.Running
: The job is scheduled and is currently undergoing execution.Completed
: This state signifies that a job has successfully executed its task. Only applicable for batch jobs.Failed
: A state indicating that the job encountered errors and couldn't successfully complete.JobStateTypeStopped
: The job has been intentionally halted by the user before its natural completion.
The inclusion of the Message
field can offer detailed insights, especially in states like Failed
, aiding in error comprehension and debugging.