.TH "GCLOUD_DATAPLEX_DATASCANS_UPDATE_DATA\-QUALITY" 1



.SH "NAME"
.HP
gcloud dataplex datascans update data\-quality \- update a Dataplex data quality scan job



.SH "SYNOPSIS"
.HP
\f5gcloud dataplex datascans update data\-quality\fR (\fIDATASCAN\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-data\-quality\-spec\-file\fR=\fIDATA_QUALITY_SPEC_FILE\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-async\fR\ |\ \fB\-\-validate\-only\fR] [\fB\-\-on\-demand\fR=\fION_DEMAND\fR\ |\ \fB\-\-schedule\fR=\fISCHEDULE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Represents a user\-visible job which provides the insights for the related data
source and generates queries based on the rules and runs against the data to get
data quality check results.



.SH "EXAMPLES"

To update description of a data quality scan \f5data\-quality\-datascan\fR in
project \f5test\-project\fR located in \f5us\-central1\fR, run:

.RS 2m
$ gcloud dataplex datascans update data\-quality \e
    data\-quality\-datascan \-\-project=test\-project \e
    \-\-location=us\-central1 \-\-description="Description is updated."
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Datascan resource \- Arguments and flags that define the Dataplex datascan you
want to update a data quality 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5datascan\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIDATASCAN\fR

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

To set the \f5dataScans\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5datascan\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

The location of the Dataplex resource.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5datascan\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5dataplex/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-data\-quality\-spec\-file\fR=\fIDATA_QUALITY_SPEC_FILE\fR

Path to the JSON/YAML file containing the spec for the data quality scan. The
JSON representation reference:
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualitySpec The
YAML representation reference:
https://cloud.google.com/dataplex/docs/use\-auto\-data\-quality#create\-scan\-using\-gcloud

.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

Description of the data quality scan

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

Display name of the data quality scan

.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m

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

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-validate\-only\fR

Validate the update action, but don't actually perform it.

.RE
.sp
.TP 2m

Data quality scan execution settings.


.RS 2m
.TP 2m

Data quality scan scheduling and trigger settings

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-on\-demand\fR=\fION_DEMAND\fR

If set, the scan runs one\-time shortly after data quality scan updation.

.TP 2m
\fB\-\-schedule\fR=\fISCHEDULE\fR

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, \f5CRON_TZ=America/New_York 1 * * * *\fR or \f5TZ=America/New_York 1 *
* * *\fR. This field is required for RECURRING scans.


.RE
.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

This variant is also available:

.RS 2m
$ gcloud alpha dataplex datascans update data\-quality
.RE