DatasetActionRun class

Definition

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.

DatasetActionRun(workspace=None, dataset_id=None, action_id=None, action_request_dto=None)
Inheritance
builtins.object
DatasetActionRun

Methods

get_result()

Get the result of completed Dataset action run.

wait_for_completion(show_output=True, status_update_frequency=10)

Wait for the completion of Dataset action run.

get_result()

Get the result of completed Dataset action run.

get_result()

Returns

The Dataset action result.

Return type

wait_for_completion(show_output=True, status_update_frequency=10)

Wait for the completion of Dataset action run.

wait_for_completion(show_output=True, status_update_frequency=10)

Parameters

show_output
bool or optional

Indicates whether to print the output.

default value: True
status_update_frequency
int or optional

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().