gcloud dataplex datascans update data-documentation Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud dataplex datascans update data-documentation - update a Dataplex data documentation scan job
- SYNOPSIS
gcloud dataplex datascans update data-documentation(DATASCAN:--location=LOCATION)[--description=DESCRIPTION][--display-name=DISPLAY_NAME][--labels=[KEY=VALUE,…]][--async|--validate-only][--on-demand=ON_DEMAND|--schedule=SCHEDULE][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Update a Dataplex data documentation scan job.
- EXAMPLES
- To update a data documentation scan
data-documentation-datascaninprojecttest-projectlocated inus-central1with a newdescription, run:gclouddataplexdatascansupdatedata-documentationdata-documentation-datascan--project=test-project--location=us-central1--description="new description" - POSITIONAL ARGUMENTS
- Datascan resource - Arguments and flags that define the Dataplex datascan youwant to update a data documentation scan for. The arguments in this group can beused to specify the attributes of this resource. (NOTE) Some attributes are notgiven arguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
datascanon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
DATASCAN- ID of the datascan or fully qualified identifier for the datascan.
To set the
dataScansattribute:- provide the argument
datascanon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- The location of the Dataplex resource.
To set the
locationattribute:- provide the argument
datascanon the command line with a fullyspecified name; - provide the argument
--locationon the command line; - set the property
dataplex/location.
- provide the argument
- provide the argument
- Datascan resource - Arguments and flags that define the Dataplex datascan youwant to update a data documentation scan for. The arguments in this group can beused to specify the attributes of this resource. (NOTE) Some attributes are notgiven arguments in this group but can be set in other ways.
- FLAGS
--description=DESCRIPTION- Description of the data documentation scan.
--display-name=DISPLAY_NAME- Display name of the data documentation 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 documentation scan execution settings.
- Data documentation 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 documentation scan creation.
--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.
- Data documentation scan scheduling and trigger settings.
- 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 helpfor details. - NOTES
- This variant is also available:
gcloudalphadataplexdatascansupdatedata-documentation
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-11-18 UTC.