.TH "GCLOUD_DATAPLEX_ZONES_CREATE" 1



.SH "NAME"
.HP
gcloud dataplex zones create \- create a zone



.SH "SYNOPSIS"
.HP
\f5gcloud dataplex zones create\fR (\fIZONE\fR\ :\ \fB\-\-lake\fR=\fILAKE\fR\ \fB\-\-location\fR=\fILOCATION\fR) \fB\-\-resource\-location\-type\fR=\fIRESOURCE_LOCATION_TYPE\fR \fB\-\-type\fR=\fITYPE\fR [\fB\-\-async\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-validate\-only\fR] [\fB\-\-[no\-]discovery\-enabled\fR\ \fB\-\-discovery\-exclude\-patterns\fR=[\fIEXCLUDE_PATTERNS\fR,...]\ \fB\-\-discovery\-include\-patterns\fR=[\fIINCLUDE_PATTERNS\fR,...]\ \fB\-\-discovery\-schedule\fR=\fIDISCOVERY_SCHEDULE\fR\ \fB\-\-csv\-delimiter\fR=\fICSV_DELIMITER\fR\ \fB\-\-[no\-]csv\-disable\-type\-inference\fR\ \fB\-\-csv\-encoding\fR=\fICSV_ENCODING\fR\ \fB\-\-csv\-header\-rows\fR=\fICSV_HEADER_ROWS\fR\ \fB\-\-[no\-]json\-disable\-type\-inference\fR\ \fB\-\-json\-encoding\fR=\fIJSON_ENCODING\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

A zone represents a logical group of related assets within a lake. A zone can be
used to map to organizational structure or represent stages of data readiness
from raw to curated. It provides managing behavior that is shared or inherited
by all contained assets.

The Zone ID is used to generate names such as database and dataset names when
publishing metadata to Hive Metastore and BigQuery.
.RS 2m
.IP "\(bu" 2m
Must contain only lowercase letters, numbers, and hyphens.
.IP "\(bu" 2m
Must start with a letter.
.IP "\(bu" 2m
Must end with a number or a letter.
.IP "\(bu" 2m
Must be between 1\-63 characters.
.IP "\(bu" 2m
Must be unique across all lakes from all locations in a project.
.RE
.sp



.SH "EXAMPLES"

To create a Dataplex zone with name \f5test\-zone\fR within lake
\f5test\-lake\fR in location \f5us\-central1\fR with type \f5RAW\fR, and
resource location type \f5SINGLE_REGION\fR, run:

.RS 2m
$ gcloud dataplex zones create test\-zone \-\-location=us\-central \e
    \-\-lake=test\-lake \-\-resource\-location\-type=SINGLE_REGION \e
    \-\-type=RAW
.RE

To create a Dataplex zone with name \f5test\-zone\fR within lake
\f5test\-lake\fR in location \f5us\-central1\fR with type \f5RAW\fR,resource
location type \f5SINGLE_REGION\fR with discovery\-enabled and discovery schedule
\f50 * * * *\fR, run:

.RS 2m
$ gcloud dataplex zones create test\-zone \-\-location=us\-central \e
    \-\-lake=test\-lake \-\-resource\-location\-type=SINGLE_REGION \e
    \-\-type=RAW \-\-discovery\-enabled \-\-discovery\-schedule="0 * * * *"
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Zones resource \- Arguments and flags that define the Dataplex zone you want to
create. 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 \f5zone\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
\fIZONE\fR

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

To set the \f5zone\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5zone\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\-\-lake\fR=\fILAKE\fR

The identifier of the Dataplex lake resource.

To set the \f5lake\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5zone\fR on the command line with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-lake\fR on the command line.
.RE
.sp

.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 \f5zone\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

Settings for resources attached as assets within a zone.

This must be specified.


.RS 2m
.TP 2m
\fB\-\-resource\-location\-type\fR=\fIRESOURCE_LOCATION_TYPE\fR

Location type of the resources attached to a zone. \fIRESOURCE_LOCATION_TYPE\fR
must be one of:

.RS 2m
.TP 2m
\fBMULTI_REGION\fR
Resources that are associated with a multi\-region location.
.TP 2m
\fBSINGLE_REGION\fR
Resources that are associated with a single region.
.RE
.sp


.RE
.sp
.TP 2m
\fB\-\-type\fR=\fITYPE\fR

Type. \fITYPE\fR must be one of:

.RS 2m
.TP 2m
\fBCURATED\fR
A zone that contains data that is considered to be ready for broader consumption
and analytics workloads. Curated structured data stored in Cloud Storage must
conform to certain file formats (Parquet, Avro, and Orc) and organized in a
hive\-compatible directory layout.
.TP 2m
\fBRAW\fR
A zone that contains data that needs further processing before it is considered
generally ready for consumption and analytics workloads.
.RE
.sp



.RE
.sp

.SH "OPTIONAL FLAGS"

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

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

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

Description of the zone.

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

Display name of the zone.

.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
\fB\-\-validate\-only\fR

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

.TP 2m

Settings to manage the metadata discovery and publishing.


.RS 2m
.TP 2m
\fB\-\-[no\-]discovery\-enabled\fR

Whether discovery is enabled. Use \fB\-\-discovery\-enabled\fR to enable and
\fB\-\-no\-discovery\-enabled\fR to disable.

.TP 2m
\fB\-\-discovery\-exclude\-patterns\fR=[\fIEXCLUDE_PATTERNS\fR,...]

The list of patterns to apply for selecting data to exclude during discovery.
For Cloud Storage bucket assets, these are interpreted as glob patterns used to
match object names. For BigQuery dataset assets, these are interpreted as
patterns to match table names.

.TP 2m
\fB\-\-discovery\-include\-patterns\fR=[\fIINCLUDE_PATTERNS\fR,...]

The list of patterns to apply for selecting data to include during discovery if
only a subset of the data should considered. For Cloud Storage bucket assets,
these are interpreted as glob patterns used to match object names. For BigQuery
dataset assets, these are interpreted as patterns to match table names.

.TP 2m

Determines when discovery jobs are triggered.


.RS 2m
.TP 2m
\fB\-\-discovery\-schedule\fR=\fIDISCOVERY_SCHEDULE\fR

Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery jobs
periodically. Discovery jobs must be scheduled at least 30 minutes apart.

.RE
.sp
.TP 2m

Describe data formats.


.RS 2m
.TP 2m

Describe CSV and similar semi\-structured data formats.


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

The delimiter being used to separate values. This defaults to ','.

.TP 2m
\fB\-\-[no\-]csv\-disable\-type\-inference\fR

Whether to disable the inference of data type for CSV data. If true, all columns
will be registered as strings. Use \fB\-\-csv\-disable\-type\-inference\fR to
enable and \fB\-\-no\-csv\-disable\-type\-inference\fR to disable.

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

The character encoding of the data. The default is UTF\-8.

.TP 2m
\fB\-\-csv\-header\-rows\fR=\fICSV_HEADER_ROWS\fR

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

.RE
.sp
.TP 2m

Describe JSON data format.


.RS 2m
.TP 2m
\fB\-\-[no\-]json\-disable\-type\-inference\fR

Whether to disable the inference of data type for Json data. If true, all
columns will be registered as their primitive types (strings, number or
boolean). Use \fB\-\-json\-disable\-type\-inference\fR to enable and
\fB\-\-no\-json\-disable\-type\-inference\fR to disable.

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

The character encoding of the data. The default is UTF\-8.


.RE
.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 zones create
.RE