JobStatus Struct
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The status of a job.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobStatusTypeConverter))]
public struct JobStatus : IEquatable<Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobStatus>, System.Management.Automation.IArgumentCompleter[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobStatusTypeConverter))>]
type JobStatus = struct
interface IArgumentCompleterPublic Structure JobStatus
Implements IArgumentCompleter, IEquatable(Of JobStatus)- Inheritance
-
JobStatus
- Attributes
- Implements
Fields
| Canceled |
Following cancellation request, the job is now successfully canceled. |
| CancelRequested |
Cancellation has been requested for the job. |
| Completed |
Job completed successfully. This reflects that both the job itself and output collection states completed successfully |
| Failed |
Job failed. |
| Finalizing |
Job is completed in the target. It is in output collection state now. |
| NotResponding |
When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run goes to NotResponding state. NotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of the previous states. |
| NotStarted |
Run hasn't started yet. |
| Paused |
The job is paused by users. Some adjustment to labeling jobs can be made only in paused state. |
| Preparing |
The run environment is being prepared. |
| Provisioning |
(Not used currently) It will be used if ES is creating the compute target. |
| Queued |
The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting for all required nodes to be ready. |
| Running |
The job started to run in the compute target. |
| Starting |
Run has started. The user has a run ID. |
| Unknown |
Default job status if not mapped to all other statuses |
Methods
| CompleteArgument(String, String, String, CommandAst, IDictionary) |
Implementations of this function are called by PowerShell to complete arguments. |
| Equals(JobStatus) |
Compares values of enum type JobStatus |
| Equals(Object) |
Compares values of enum type JobStatus (override for Object) |
| GetHashCode() |
Returns hashCode for enum JobStatus |
| ToString() |
Returns string representation for JobStatus |
Operators
| Equality(JobStatus, JobStatus) |
Overriding == operator for enum JobStatus |
| Implicit(JobStatus to String) |
Implicit operator to convert JobStatus to string |
| Implicit(String to JobStatus) |
Implicit operator to convert string to JobStatus |
| Inequality(JobStatus, JobStatus) |
Overriding != operator for enum JobStatus |