Parameter of
Properties
Name | Type | Description |
---|---|---|
Actions | JobAction [ ] | This value represents an action recently reported by a job. |
CanCreateImageRecovery | Boolean | This value is true if the job can be used to create an image recovery; otherwise, it is false. |
CanDelete | Boolean | This value is true if you can delete the job; otherwise, it is false. |
CanEdit | Boolean | This value is true if the job can be edited; otherwise, it is false. |
CanFailback | Boolean | This value is true if the job can be failed back; otherwise, it is false. |
CanFailover | Boolean | This value is true if the job can be failed over; otherwise, it is false. |
CanPause | Boolean | This value is true if the job can be can be paused; otherwise, it is false. |
CanRestore | Boolean | This value is true if the job can be restored; otherwise, it is false. |
CanReverse | Boolean | This value is true if the job can be reversed; otherwise, it is false. |
CanStart | Boolean | This value is true if the job can be started; otherwise, it is false. |
CanStop | Boolean | This value is true if the job can be stopped; otherwise, it is false. |
CanUndoFailover | Boolean | This value is true if the failover of the job can be undone; otherwise, it is false. |
EngineControlStatuses | EngineControlStatus | This value represents the status of the replication engine. |
ExtendedLowLevelState | ExtendedLowLevelStates | This value represents additional information about the low level job state. |
Health | Health | This value represents the high level health of the job. |
HighLevelState | HighLevelState | This value represents high level job states. High level states typically map to phases of the job's overall lifecycle, like mirroring or failing over. Jobs will pass through various high level states during their lifetime, and the types of high level states are usually shared between jobs, regardless of job type. |
IsInError | Boolean | This value is true if the job is in an error state; otherwise, it is false. |
LowLevelState | String | This value is a low level job state. Low level states typically map to individual steps the job is performing at any given time, like attaching virtual disks or updating DNS. Low level states provide detailed information about a job's current state or action and will vary between different job types. |
PermillageComplete | Int32 |
This value is the percentage of the current activity for that job that is complete. To display a percentage string for an arbitrary activity, jobs can provide a value for this property, and that value will be formatted and displayed in the client. To remove the display of the percentage, set this property to zero. |
TargetState | String | This value is derived from TargetStates. Information from the connection is distilled into a string key which is sent to the client for display. |