gcloud dataplex datascans update data-documentation

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-datascan in project test-project located in us-central1 with a new description, run: 
gcloud dataplex datascans update data-documentation data-documentation-datascan --project=test-project --location=us-central1 --description="new description"
POSITIONAL ARGUMENTS
Datascan resource - Arguments and flags that define the Dataplex datascan you want to update a data documentation scan for. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.

To set the project attribute:

  • provide the argument datascan on the command line with a fully specified name;
  • provide the argument --project on 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 dataScans attribute:

  • provide the argument datascan on the command line.

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

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

To set the location attribute:

  • provide the argument datascan on the command line with a fully specified name;
  • provide the argument --location on the command line;
  • set the property dataplex/location.
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, and numbers. 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 scans periodically. To explicitly set a timezone to the cron tab, apply a prefix in the 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. For example, CRON_TZ=America/New_York 1 * * * * or TZ=America/New_York 1 * * * *. This field is required for RECURRING scans.
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 variant is also available: 
gcloud alpha dataplex datascans update data-documentation