UpdateDataDocsAction
- class great_expectations.checkpoint.UpdateDataDocsAction(data_context: AbstractDataContext, site_names: list[str] | str | None = None)#
-
Notify the site builders of all data docs sites of a Data Context that a validation result should be added to the data docs.
YAML configuration example:
- name: update_data_docs
action:
class_name: UpdateDataDocsActionYou can also instruct
UpdateDataDocsAction
to build only certain sites by providing asite_names
key with a list of sites to update:- name: update_data_docs
action:
class_name: UpdateDataDocsAction
site_names:
- local_site- Parameters:
-
-
data_context – Data Context that is used by the Action.
-
site_names – Optional. A list of the names of sites to update.
-
- 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.