gcloud alpha dataplex datascans update data-quality

NAME
gcloud alpha dataplex datascans update data-quality - update a Dataplex data quality scan job
SYNOPSIS
gcloud alpha dataplex datascans update data-quality(DATASCAN :--location=LOCATION)[--data-quality-spec-file=DATA_QUALITY_SPEC_FILE][--description=DESCRIPTION][--display-name=DISPLAY_NAME][--labels=[KEY=VALUE,…]][--async    |--validate-only][--on-demand=ON_DEMAND    |--schedule=SCHEDULE][GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Represents a user-visible job which provides the insightsfor the related data source and generates queries based on the rules and runsagainst the data to get data quality check results.
EXAMPLES
To update description of a data quality scandata-quality-datascanin projecttest-project located inus-central1, run:
gcloudalphadataplexdatascansupdatedata-qualitydata-quality-datascan--project=test-project--location=us-central1--description="Description is updated."
POSITIONAL ARGUMENTS
Datascan resource - Arguments and flags that define the Dataplex datascan youwant to update a data quality scan for. The arguments in this group can be usedto specify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentdatascan on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

DATASCAN
ID of the datascan or fully qualified identifier for the datascan.

To set thedataScans attribute:

  • provide the argumentdatascan on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--location=LOCATION
The location of the Dataplex resource.

To set thelocation attribute:

  • provide the argumentdatascan on the command line with a fullyspecified name;
  • provide the argument--location on the command line;
  • set the propertydataplex/location.
FLAGS
--data-quality-spec-file=DATA_QUALITY_SPEC_FILE
Path to the JSON/YAML file containing the spec for the data quality scan. TheJSON representation reference:https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualitySpecThe YAML representation reference:https://cloud.google.com/dataplex/docs/use-auto-data-quality#create-scan-using-gcloud
--description=DESCRIPTION
Description of the data quality scan
--display-name=DISPLAY_NAME
Display name of the data quality scan
--labels=[KEY=VALUE,…]
List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens(-), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers.

At most one of --async | --validate-only can be specified.

At most one of these can be specified:

--async
Return immediately, without waiting for the operation in progress to complete.
--validate-only
Validate the update action, but don't actually perform it.
Data quality scan execution settings.
Data quality scan scheduling and trigger settings

At most one of these can be specified:

--on-demand=ON_DEMAND
If set, the scan runs one-time shortly after data quality scan updation.
--schedule=SCHEDULE
Cron schedule (https://en.wikipedia.org/wiki/Cron) for running scansperiodically. To explicitly set a timezone to the cron tab, apply a prefix inthe cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. Forexample,CRON_TZ=America/New_York 1 * * * * orTZ=America/New_York 1 * * * *. This field is required for RECURRINGscans.
GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gclouddataplexdatascansupdatedata-quality

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-08-13 UTC.