JobOperations Class

JobOperations operations.

Inheritance

builtins.object

JobOperations

Constructor

JobOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

api_version

Client Api Version. Constant value: "2017-09-01-preview".

Methods

build	Builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation.
cancel	Cancels the running job specified by the job ID.
create	Submits a job to the specified Data Lake Analytics account.
get	Gets the job information for the specified job ID.
get_debug_data_path	Gets the job debug data information specified by the job ID.
get_statistics	Gets statistics of the specified job.
list	Lists the jobs, if any, associated with the specified Data Lake Analytics account. The response includes a link to the next page of results, if any.
update	Updates the job information for the specified job ID. (Only for use internally with Scope job type.).
yield_method	Pauses the specified job and places it back in the job queue, behind other jobs of equal or higher importance, based on priority. (Only for use internally with Scope job type.).

build

Builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation.

build(account_name, parameters, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account to execute job operations on.

parameters

BuildJobParameters

Required

The parameters to build a job.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

JobInformation or ClientRawResponse if raw=true

Return type

JobInformation,

ClientRawResponse

Exceptions

CloudError

cancel

Cancels the running job specified by the job ID.

cancel(account_name, job_identity, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account to execute job operations on.

job_identity

str

Required

Job identifier. Uniquely identifies the job across all jobs submitted to the service.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

AzureOperationPoller[None],

AzureOperationPoller[ClientRawResponse[None]]

Exceptions

CloudError

create

Submits a job to the specified Data Lake Analytics account.

create(account_name, job_identity, parameters, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account to execute job operations on.

job_identity

str

Required

Job identifier. Uniquely identifies the job across all jobs submitted to the service.

parameters

CreateJobParameters

Required

The parameters to submit a job.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

JobInformation or ClientRawResponse if raw=true

Return type

JobInformation,

ClientRawResponse

Exceptions

CloudError

get

Gets the job information for the specified job ID.

get(account_name, job_identity, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account to execute job operations on.

job_identity

str

Required

JobInfo ID.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

JobInformation or ClientRawResponse if raw=true

Return type

JobInformation,

ClientRawResponse

Exceptions

CloudError

get_debug_data_path

Gets the job debug data information specified by the job ID.

get_debug_data_path(account_name, job_identity, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account to execute job operations on.

job_identity

str

Required

Job identifier. Uniquely identifies the job across all jobs submitted to the service.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

JobDataPath or ClientRawResponse if raw=true

Return type

JobDataPath,

ClientRawResponse

Exceptions

CloudError

get_statistics

Gets statistics of the specified job.

get_statistics(account_name, job_identity, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account to execute job operations on.

job_identity

str

Required

Job Information ID.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

JobStatistics or ClientRawResponse if raw=true

Return type

JobStatistics,

ClientRawResponse

Exceptions

CloudError

list

Lists the jobs, if any, associated with the specified Data Lake Analytics account. The response includes a link to the next page of results, if any.

list(account_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account to execute job operations on.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.

count

bool

default value: None

The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of JobInformationBasic

Return type

JobInformationBasicPaged[JobInformationBasic]

Exceptions

CloudError

update

Updates the job information for the specified job ID. (Only for use internally with Scope job type.).

update(account_name, job_identity, parameters=None, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account to execute job operations on.

job_identity

str

Required

Job identifier. Uniquely identifies the job across all jobs submitted to the service.

parameters

UpdateJobParameters

default value: None

The parameters to update a job.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns JobInformation or ClientRawResponse if raw==True

Return type

AzureOperationPoller[JobInformation],

AzureOperationPoller[ClientRawResponse[JobInformation]]

Exceptions

CloudError

yield_method

Pauses the specified job and places it back in the job queue, behind other jobs of equal or higher importance, based on priority. (Only for use internally with Scope job type.).

yield_method(account_name, job_identity, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account to execute job operations on.

job_identity

str

Required

Job identifier. Uniquely identifies the job across all jobs submitted to the service.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

AzureOperationPoller[None],

AzureOperationPoller[ClientRawResponse[None]]

Exceptions

CloudError

Attributes

models

models = <module 'azure.mgmt.datalake.analytics.job.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\datalake\\analytics\\job\\models\\__init__.py'>