.TH "GCLOUD_DATAPLEX_DATASCANS_CREATE_DATA\-PROFILE" 1



.SH "NAME"
.HP
gcloud dataplex datascans create data\-profile \- create a Dataplex data profile scan job



.SH "SYNOPSIS"
.HP
\f5gcloud dataplex datascans create data\-profile\fR (\fIDATASCAN\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) (\fB\-\-data\-source\-entity\fR=\fIDATA_SOURCE_ENTITY\fR\ |\ \fB\-\-data\-source\-resource\fR=\fIDATA_SOURCE_RESOURCE\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\-\-data\-profile\-spec\-file\fR=\fIDATA_PROFILE_SPEC_FILE\fR\ |\ \fB\-\-exclude\-field\-names\fR=\fIEXCLUDE_FIELD_NAMES\fR\ \fB\-\-export\-results\-table\fR=\fIEXPORT_RESULTS_TABLE\fR\ \fB\-\-include\-field\-names\fR=\fIINCLUDE_FIELD_NAMES\fR\ \fB\-\-row\-filter\fR=\fIROW_FILTER\fR\ \fB\-\-sampling\-percent\fR=\fISAMPLING_PERCENT\fR] [\fB\-\-incremental\-field\fR=\fIINCREMENTAL_FIELD\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 about the structure, content and relationships (such as null percent,
cardinality, min/max/mean, etc).



.SH "EXAMPLES"

To create a data profile scan \f5data\-profile\-datascan\fR in project
\f5test\-project\fR located in \f5us\-central1\fR on bigquery resource table
\f5test\-table\fR in dataset \f5test\-dataset\fR, run:

.RS 2m
$ gcloud dataplex datascans create data\-profile \e
    data\-profile\-datascan \-\-project=test\-project \e
    \-\-location=us\-central1 \e
    \-\-data\-source\-resource="//bigquery.googleapis.com/projects/test\-\e
project/datasets/test\-dataset/tables/test\-table"
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Datascan resource \- Arguments and flags that define the Dataplex datascan you
want to create a data profile 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 "REQUIRED FLAGS"

.RS 2m
.TP 2m

Data source for the data profile scan.

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-data\-source\-entity\fR=\fIDATA_SOURCE_ENTITY\fR

Dataplex entity that contains the data for the data profile scan, of the form:
\f5projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}\fR.

.TP 2m
\fB\-\-data\-source\-resource\fR=\fIDATA_SOURCE_RESOURCE\fR

Fully\-qualified service resource name of the cloud resource that contains the
data for the data profile scan, of the form:
\f5//bigquery.googleapis.com/projects/{project_number}/datasets/{dataset_id}/tables/{table_id}\fR.


.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

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

Description of the data profile scan.

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

Display name of the data profile 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 create action, but don't actually perform it.

.RE
.sp
.TP 2m

Data spec for the data profile scan.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-data\-profile\-spec\-file\fR=\fIDATA_PROFILE_SPEC_FILE\fR

path to the JSON/YAML file containing the spec for the data profile scan. The
JSON representation reference:
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataProfileSpec

.TP 2m

Command line spec arguments for the data profile scan.


.RS 2m
.TP 2m
\fB\-\-exclude\-field\-names\fR=\fIEXCLUDE_FIELD_NAMES\fR

Names of the fields to exclude from data profile. If specified, the respective
fields will be excluded from data profile, regardless of the fields specified in
the \f5\-\-include\-field\-names\fR flag.

.TP 2m
\fB\-\-export\-results\-table\fR=\fIEXPORT_RESULTS_TABLE\fR

path to the resource table to export data profile scan results, of the form:
\f5//bigquery.googleapis.com/projects/{project_number}/datasets/{dataset_id}/tables/{table_id}\fR.
The table will be created if not present.

.TP 2m
\fB\-\-include\-field\-names\fR=\fIINCLUDE_FIELD_NAMES\fR

Names of the fields to include in data profile. If not specified, all fields at
the time of profile scan job execution are included. The fields listed in the
\f5\-\-exclude\-field\-names\fR flag are excluded.

.TP 2m
\fB\-\-row\-filter\fR=\fIROW_FILTER\fR

A filter applied to all rows in a single data profile scan job.

.TP 2m
\fB\-\-sampling\-percent\fR=\fISAMPLING_PERCENT\fR

The percentage of the records to be selected from the dataset for data profile
scan.

.RE
.RE
.sp
.TP 2m

Data profile scan execution settings.


.RS 2m
.TP 2m
\fB\-\-incremental\-field\fR=\fIINCREMENTAL_FIELD\fR

Field that contains values that monotonically increase over time (e.g.
timestamp).

.TP 2m

Data profile 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 profile scan creation.

.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 create data\-profile
.RE