ValidationAction

class great_expectations.checkpoint.ValidationAction(*, type: str, notify_on: Literal['all', 'failure', 'success'] = 'all')#

ValidationActions define a set of steps to be run after a validation result is produced.

Through a Checkpoint, one can orchestrate the validation of data and configure notifications, data documentation updates, and other actions to take place after the validation result is produced.

run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

When a ValidationAction is configured in a Checkpoint, this method gets called after the Checkpoint produces an ExpectationSuiteValidationResult.

Parameters:

• validation_result_suite – An instance of the ExpectationSuiteValidationResult class.

• validation_result_suite_identifier – an instance of either the ValidationResultIdentifier class (for open source Great Expectations) or the GXCloudIdentifier (from Great Expectations Cloud).

• expectation_suite_identifier – Optionally, an instance of the ExpectationSuiteIdentifier class.

• checkpoint_identifier – Optionally, an Identifier for the Checkpoint.

• kwargs – named parameters that are specific to a given Action, and need to be assigned a value in the Action’s configuration in a Checkpoint’s action_list.

Returns:

A Dict describing the result of the Action.