ScopeJobProperties Class

Scope job properties used when submitting and retrieving Scope jobs. (Only for use internally with Scope job type.).

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

JobProperties

ScopeJobProperties

Constructor

ScopeJobProperties(*, script: str, runtime_version: Optional[str] = None, notifier: Optional[str] = None, **kwargs)

Parameters

runtime_version

str

Required

The runtime version of the Data Lake Analytics engine to use for the specific type of job being run.

script

str

Required

Required. The script to run. Please note that the maximum script size is 3 MB.

type

str

Required

Required. Constant filled by server.

notifier

str

Required

The list of email addresses, separated by semi-colons, to notify when the job reaches a terminal state.

Variables

resources

list[ScopeJobResource]

The list of resources that are required by the job.

user_algebra_path

str

The algebra file path after the job has completed.

total_compilation_time

<xref:timedelta>

The total time this job spent compiling. This value should not be set by the user and will be ignored if it is.

total_queued_time

<xref:timedelta>

The total time this job spent queued. This value should not be set by the user and will be ignored if it is.

total_running_time

<xref:timedelta>

The total time this job spent executing. This value should not be set by the user and will be ignored if it is.

total_paused_time

<xref:timedelta>

The total time this job spent paused. This value should not be set by the user and will be ignored if it is.

root_process_node_id

str

The ID used to identify the job manager coordinating job execution. This value should not be set by the user and will be ignored if it is.

yarn_application_id

str

The ID used to identify the yarn application executing the job. This value should not be set by the user and will be ignored if it is.