JobInformation Class

The extended Data Lake Analytics job information properties returned when retrieving a specific job.

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

All required parameters must be populated in order to send to Azure.

Inheritance

JobInformationBasic

JobInformation

Constructor

JobInformation(*, name: str, type, properties, degree_of_parallelism: int = 1, priority: Optional[int] = None, log_file_patterns=None, related=None, tags=None, **kwargs)

Parameters

name

str

Required

Required. The friendly name of the job.

type

str or JobType

Required

Required. The job type of the current job (Hive, USql, or Scope (for internal use only)). Possible values include: 'USql', 'Hive', 'Scope'

degree_of_parallelism

int

Required

The degree of parallelism used for this job. This must be greater than 0, if set to less than 0 it will default to 1. Default value: 1 .

priority

int

Required

The priority value for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0.

log_file_patterns

list[str]

Required

The list of log file name patterns to find in the logFolder. '' is the only matching character allowed. Example format: jobExecution.log or mylog.txt

related

JobRelationshipProperties

Required

The recurring job relationship information properties.

tags

dict[str, str]

Required

The key-value pairs used to add additional metadata to the job information. (Only for use internally with Scope job type.)

properties

JobProperties

Required

Required. The job specific properties.

Variables

job_id

str

The job's unique identifier (a GUID).

submitter

str

The user or account that submitted the job.

submit_time

datetime

The time the job was submitted to the service.

start_time

datetime

The start time of the job.

end_time

datetime

The completion time of the job.

state

str or JobState

The job state. When the job is in the Ended state, refer to Result and ErrorMessage for details. Possible values include: 'Accepted', 'Compiling', 'Ended', 'New', 'Queued', 'Running', 'Scheduling', 'Starting', 'Paused', 'WaitingForCapacity'

result

str or JobResult

The result of job execution or the current result of the running job. Possible values include: 'None', 'Succeeded', 'Cancelled', 'Failed'

log_folder

str

The log folder path to use in the following format: adl://.azuredatalakestore.net/system/jobservice/jobs/Usql/2016/03/13/17/18/5fe51957-93bc-4de0-8ddc-c5a4753b068b/logs/.

error_message

list[JobErrorDetails]

The error message details for the job, if the job failed.

state_audit_records

list[JobStateAuditRecord]

The job state audit records, indicating when various operations have been performed on this job.