Job interface

The job.

Extends

Properties

backupPointInTime

The time of the backup used for the failover.

backupType

The backup type (CloudSnapshot | LocalSnapshot). Applicable only for backup jobs.

dataStats

The data statistics properties of the job.

deviceId

The device ID in which the job ran.

endTime

The UTC time at which the job completed.

entityLabel

The entity identifier for which the job ran.

entityType

The entity type for which the job ran.

error

The error details, if any, for the job.

isCancellable

Represents whether the job is cancellable or not.

jobStages

The job stages.

jobType

The type of the job.

percentComplete

The percentage of the job that is already complete.

sourceDeviceId

The source device ID of the failover job.

startTime

The UTC time at which the job was started.

status

The current status of the job.

Inherited Properties

id

The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

kind

The Kind of the object. Currently only Series8000 is supported

name

The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

type

The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

backupPointInTime

The time of the backup used for the failover.

backupPointInTime?: Date

Property Value

Date

backupType

The backup type (CloudSnapshot | LocalSnapshot). Applicable only for backup jobs.

backupType?: BackupType

Property Value

dataStats

The data statistics properties of the job.

dataStats?: DataStatistics

Property Value

deviceId

The device ID in which the job ran.

deviceId?: string

Property Value

string

endTime

The UTC time at which the job completed.

endTime?: Date

Property Value

Date

entityLabel

The entity identifier for which the job ran.

entityLabel?: string

Property Value

string

entityType

The entity type for which the job ran.

entityType?: string

Property Value

string

error

The error details, if any, for the job.

error?: JobErrorDetails

Property Value

isCancellable

Represents whether the job is cancellable or not.

isCancellable?: boolean

Property Value

boolean

jobStages

The job stages.

jobStages?: JobStage[]

Property Value

jobType

The type of the job.

jobType?: JobType

Property Value

percentComplete

The percentage of the job that is already complete.

percentComplete: number

Property Value

number

sourceDeviceId

The source device ID of the failover job.

sourceDeviceId?: string

Property Value

string

startTime

The UTC time at which the job was started.

startTime?: Date

Property Value

Date

status

The current status of the job.

status: JobStatus

Property Value

Inherited Property Details

id

The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From BaseModel.id

kind

The Kind of the object. Currently only Series8000 is supported

kind?: "Series8000"

Property Value

"Series8000"

Inherited From BaseModel.kind

name

The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From BaseModel.name

type

The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From BaseModel.type