Job Class

A device job.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

Model

Job

Constructor

Job(*, folder: Optional[str] = None, **kwargs)

Parameters

folder

str

Required

If only subfolders need to be refreshed, then the subfolder path inside the share. (The path is empty if there are no subfolders.)

Variables

id

str

The path ID that uniquely identifies the object.

name

str

The name of the object.

type

str

The hierarchical type of the object.

status

str or JobStatus

The current status of the job. Possible values include: 'Invalid', 'Running', 'Succeeded', 'Failed', 'Canceled', 'Paused', 'Scheduled'

start_time

datetime

The UTC date and time at which the job started.

end_time

datetime

The UTC date and time at which the job completed.

percent_complete

int

The percentage of the job that is complete.

error

JobErrorDetails

The error details.

job_type

str or JobType

The type of the job. Possible values include: 'Invalid', 'ScanForUpdates', 'DownloadUpdates', 'InstallUpdates', 'RefreshShare'

current_stage

str or UpdateOperationStage

Current stage of the update operation. Possible values include: 'Unknown', 'Initial', 'ScanStarted', 'ScanComplete', 'ScanFailed', 'DownloadStarted', 'DownloadComplete', 'DownloadFailed', 'InstallStarted', 'InstallComplete', 'InstallFailed', 'RebootInitiated', 'Success', 'Failure', 'RescanStarted', 'RescanComplete', 'RescanFailed'

download_progress

UpdateDownloadProgress

The download progress.

install_progress

UpdateInstallProgress

The install progress.

total_refresh_errors

int

Total number of errors encountered during the refresh process.

error_manifest_file

str

Local share/remote container relative path to the error manifest file of the refresh.

share_id

str

ARM ID of the share that was refreshed.