.TH "GCLOUD_DATAPLEX_DATASCANS_UPDATE_DATA\-DISCOVERY" 1



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



.SH "SYNOPSIS"
.HP
\f5gcloud dataplex datascans update data\-discovery\fR (\fIDATASCAN\fR\ :\ \fB\-\-location\fR=\fILOCATION\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\-\-bigquery\-publishing\-connection\fR=\fIBIGQUERY_PUBLISHING_CONNECTION\fR\ \fB\-\-bigquery\-publishing\-dataset\-location\fR=\fIBIGQUERY_PUBLISHING_DATASET_LOCATION\fR\ \fB\-\-bigquery\-publishing\-dataset\-project\fR=\fIBIGQUERY_PUBLISHING_DATASET_PROJECT\fR\ \fB\-\-bigquery\-publishing\-table\-type\fR=\fIBIGQUERY_PUBLISHING_TABLE_TYPE\fR\ \fB\-\-storage\-exclude\-patterns\fR=[\fIPATTERN\fR,...]\ \fB\-\-storage\-include\-patterns\fR=[\fIPATTERN\fR,...]\ \fB\-\-csv\-delimiter\fR=\fICSV_DELIMITER\fR\ \fB\-\-csv\-disable\-type\-inference\fR=\fICSV_DISABLE_TYPE_INFERENCE\fR\ \fB\-\-csv\-encoding\fR=\fICSV_ENCODING\fR\ \fB\-\-csv\-header\-row\-count\fR=\fICSV_HEADER_ROW_COUNT\fR\ \fB\-\-csv\-quote\-character\fR=\fICSV_QUOTE_CHARACTER\fR\ \fB\-\-json\-disable\-type\-inference\fR=\fIJSON_DISABLE_TYPE_INFERENCE\fR\ \fB\-\-json\-encoding\fR=\fIJSON_ENCODING\fR] [\fB\-\-on\-demand\fR=\fION_DEMAND\fR\ |\ \fB\-\-schedule\fR=\fISCHEDULE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Allows users to auto discover BigQuery External and BigLake tables from
underlying Cloud Storage buckets.



.SH "EXAMPLES"

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

.RS 2m
$ gcloud dataplex datascans update data\-discovery \e
    data\-discovery\-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 discovery 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\-\-description\fR=\fIDESCRIPTION\fR

Description of the data discovery scan

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

Display name of the data discovery 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 spec for the data discovery scan.


.RS 2m
.TP 2m

BigQuery publishing config arguments for the data discovery scan.


.RS 2m
.TP 2m
\fB\-\-bigquery\-publishing\-connection\fR=\fIBIGQUERY_PUBLISHING_CONNECTION\fR

BigQuery connection to use for auto discovering cloud resource bucket to BigLake
tables. Connection is required for \f5BIGLAKE`BigQuery publishing table type.

.TP 2m
\fB\-\-bigquery\-publishing\-dataset\-location\fR=\fIBIGQUERY_PUBLISHING_DATASET_LOCATION\fR

The location of the BigQuery dataset to publish BigLake external or non\-BigLake
external tables to. If not specified, the dataset location will be set to the
location of the data source resource. Refer to
https://cloud.google.com/bigquery/docs/locations#supportedLocations for
supported locations.

.TP 2m
\fB\-\-bigquery\-publishing\-dataset\-project\fR=\fIBIGQUERY_PUBLISHING_DATASET_PROJECT\fR

The project of the BigQuery dataset to publish BigLake external or non\-BigLake
external tables to. If not specified, the cloud resource bucket project will be
used to create the dataset. The format is "projects/{project_id_or_number}.

.TP 2m
\fB\-\-bigquery\-publishing\-table\-type\fR=\fIBIGQUERY_PUBLISHING_TABLE_TYPE\fR

BigQuery table type to discover the cloud resource bucket. Can be either
\fREXTERNAL\f5 or \fRBIGLAKE\f5. If not specified, the table type will be set to
\fREXTERNAL\f5.

.RE
.sp
.TP 2m

Storage config arguments for the data discovery scan.


.RS 2m
.TP 2m
\fB\-\-storage\-exclude\-patterns\fR=[\fIPATTERN\fR,...]

List of patterns that identify the data to exclude during discovery. These
patterns are interpreted as glob patterns used to match object names in the
Cloud Storage bucket. Exclude patterns will be applied before include patterns.

.TP 2m
\fB\-\-storage\-include\-patterns\fR=[\fIPATTERN\fR,...]

List of patterns that identify the data to include during discovery when only a
subset of the data should be considered. These patterns are interpreted as glob
patterns used to match object names in the Cloud Storage bucket.

.TP 2m

CSV options arguments for the data discovery scan.


.RS 2m
.TP 2m
\fB\-\-csv\-delimiter\fR=\fICSV_DELIMITER\fR

Delimiter used to separate values in the CSV file. If not specified, the
delimiter will be set to comma (",").

.TP 2m
\fB\-\-csv\-disable\-type\-inference\fR=\fICSV_DISABLE_TYPE_INFERENCE\fR

Whether to disable the inference of data types for CSV data. If true, all
columns are registered as strings.

.TP 2m
\fB\-\-csv\-encoding\fR=\fICSV_ENCODING\fR

Character encoding of the CSV file. If not specified, the encoding will be set
to UTF\-8.

.TP 2m
\fB\-\-csv\-header\-row\-count\fR=\fICSV_HEADER_ROW_COUNT\fR

The number of rows to interpret as header rows that should be skipped when
reading data rows. The default value is 1.

.TP 2m
\fB\-\-csv\-quote\-character\fR=\fICSV_QUOTE_CHARACTER\fR

The character used to quote column values. Accepts " (double quotation mark) or
\' (single quotation mark). If unspecified, defaults to " (double quotation
mark).

.RE
.sp
.TP 2m

JSON options arguments for the data discovery scan.


.RS 2m
.TP 2m
\fB\-\-json\-disable\-type\-inference\fR=\fIJSON_DISABLE_TYPE_INFERENCE\fR

Whether to disable the inference of data types for JSON data. If true, all
columns are registered as strings.

.TP 2m
\fB\-\-json\-encoding\fR=\fIJSON_ENCODING\fR

Character encoding of the JSON file. If not specified, the encoding will be set
to UTF\-8.

.RE
.RE
.RE
.sp
.TP 2m

Data discovery scan execution settings.


.RS 2m
.TP 2m

Data discovery 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 discovery 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, \fRCRON_TZ=America/New_York 1 * * * *\f5 or \fRTZ=America/New_York 1 *
* * *\f5. This field is required for RECURRING scans.


\fR
.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\-discovery
.RE