class Azure::DataBoxEdge::Mgmt::V2019_08_01::Models::Job

A device job.

Attributes

current_stage[RW]

@return [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[RW]

@return [UpdateDownloadProgress] The download progress.

end_time[RW]

@return [DateTime] The UTC date and time at which the job completed.

error[RW]

@return [JobErrorDetails] The error details.

error_manifest_file[RW]

@return [String] Local share/remote container relative path to the error manifest file of the refresh.

folder[RW]

@return [String] If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.)

id[RW]

@return [String] The path ID that uniquely identifies the object.

install_progress[RW]

@return [UpdateInstallProgress] The install progress.

job_type[RW]

@return [JobType] The type of the job. Possible values include: 'Invalid', 'ScanForUpdates', 'DownloadUpdates', 'InstallUpdates', 'RefreshShare', 'RefreshContainer'

name[RW]

@return [String] The name of the object.

percent_complete[RW]

@return [Integer] The percentage of the job that is complete.

refreshed_entity_id[RW]

@return [String] ARM ID of the entity that was refreshed.

start_time[RW]

@return [DateTime] The UTC date and time at which the job started.

status[RW]

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

total_refresh_errors[RW]

@return [Integer] Total number of errors encountered during the refresh process.

type[RW]

@return [String] The hierarchical type of the object.

Private Class Methods

mapper() click to toggle source

Mapper for Job class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb, line 81
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Job',
    type: {
      name: 'Composite',
      class_name: 'Job',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'status',
          type: {
            name: 'String'
          }
        },
        start_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'startTime',
          type: {
            name: 'DateTime'
          }
        },
        end_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'endTime',
          type: {
            name: 'DateTime'
          }
        },
        percent_complete: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'percentComplete',
          type: {
            name: 'Number'
          }
        },
        error: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'error',
          type: {
            name: 'Composite',
            class_name: 'JobErrorDetails'
          }
        },
        job_type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.jobType',
          type: {
            name: 'String'
          }
        },
        current_stage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.currentStage',
          type: {
            name: 'String'
          }
        },
        download_progress: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.downloadProgress',
          type: {
            name: 'Composite',
            class_name: 'UpdateDownloadProgress'
          }
        },
        install_progress: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.installProgress',
          type: {
            name: 'Composite',
            class_name: 'UpdateInstallProgress'
          }
        },
        total_refresh_errors: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.totalRefreshErrors',
          type: {
            name: 'Number'
          }
        },
        error_manifest_file: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.errorManifestFile',
          type: {
            name: 'String'
          }
        },
        refreshed_entity_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.refreshedEntityId',
          type: {
            name: 'String'
          }
        },
        folder: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.folder',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end