Share via

DatasetActionRun Class

  • Reference

Manage the execution of Dataset actions.

DatasetActionRun provides methods for monitoring the status of long running actions on datasets. It also provides a method to get the result of an action after completion.

Initialize a DatasetActionRun.

Inheritance
builtins.object
DatasetActionRun

Constructor

DatasetActionRun(workspace=None, dataset_id=None, action_id=None, action_request_dto=None)

Parameters

Name Description
workspace
Required
Workspace

The workspace the Dataset is in.
dataset_id
Required
str

The Dataset ID.
action_id
Required
str

The Dataset action ID
action_request_dto
Required
<xref:azureml._restclient.models.action_result_dto>

The action request dto.

Methods

get_result

Get the result of completed Dataset action run.
wait_for_completion

Wait for the completion of Dataset action run.

get_result

Get the result of completed Dataset action run.

get_result()

Returns

Type Description
Union[<xref:azureml.dataprep.DataProfile>, None]

The Dataset action result.

wait_for_completion

Wait for the completion of Dataset action run.

wait_for_completion(show_output=True, status_update_frequency=10)

Parameters

Name Description
show_output
bool

Indicates whether to print the output.

Default value: True
status_update_frequency
int

The action run status update frequency in seconds.

Default value: 10

Remarks

This is a synchronous method. Call this if you have triggered a long running action on a dataset and you want to wait for the action to complete before proceeding. This method writes the status of the action run in the logs periodically, with the interval between updates determined by the status_update_frequency parameter.

The action returns when the action has completed. To inspect the result of the action, use get_result.