ValidationAction
- class great_expectations.checkpoint.ValidationAction(data_context: AbstractDataContext)#
Base class for all Actions that act on Validation Results and are aware of a Data Context namespace structure.
- Parameters
data_context – Data Context that is used by the Action.
_run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier=None, checkpoint_identifier=None)#
Private method containing the logic specific to a ValidationAction’s implementation.
The implementation details specific to this ValidationAction must live in this method. Additional context required by the ValidationAction may be specified in the Checkpoint’s action_list under the action key. These arbitrary key/value pairs will be passed into the ValidationAction as keyword arguments.
- 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 GeCloudIdentifier (from Great Expectations Cloud).
data_asset – An instance of the Validator class.
expectation_suite_identifier – Optionally, an instance of the ExpectationSuiteIdentifier class.
checkpoint_identifier – Optionally, an Identifier for the Checkpoints.
- Returns
A Dict describing the result of the Action.
run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, 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).
data_asset – An instance of the Validator class.
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.