.TH "GCLOUD_DATAPLEX_METADATA\-JOBS_CREATE" 1



.SH "NAME"
.HP
gcloud dataplex metadata\-jobs create \- create a Dataplex Metadata Job



.SH "SYNOPSIS"
.HP
\f5gcloud dataplex metadata\-jobs create\fR [[\fIMETADATA_JOB\fR]\ \fB\-\-location\fR=\fILOCATION\fR] \fB\-\-type\fR=\fITYPE\fR (\fB\-\-export\-output\-path\fR=\fIEXPORT_OUTPUT_PATH\fR\ ((\fB\-\-export\-entry\-groups\fR=[\fIEXPORT_ENTRY_GROUPS\fR,...]\ |\ \fB\-\-export\-organization\-level\fR=\fIEXPORT_ORGANIZATION_LEVEL\fR\ |\ \fB\-\-export\-projects\fR=[\fIEXPORT_PROJECTS\fR,...])\ :\ \fB\-\-export\-aspect\-types\fR=[\fIEXPORT_ASPECT_TYPES\fR,...]\ \fB\-\-export\-entry\-types\fR=[\fIEXPORT_ENTRY_TYPES\fR,...])\ |\ [\fB\-\-import\-aspect\-sync\-mode\fR=\fIIMPORT_ASPECT_SYNC_MODE\fR\ \fB\-\-import\-entry\-sync\-mode\fR=\fIIMPORT_ENTRY_SYNC_MODE\fR\ \fB\-\-import\-source\-storage\-uri\fR=\fIIMPORT_SOURCE_STORAGE_URI\fR\ (\fB\-\-import\-aspect\-types\fR=[\fIIMPORT_ASPECT_TYPES\fR,...]\ \fB\-\-import\-entry\-groups\fR=[\fIIMPORT_ENTRY_GROUPS\fR,...]\ \fB\-\-import\-entry\-link\-types\fR=[\fIIMPORT_ENTRY_LINK_TYPES\fR,...]\ \fB\-\-import\-entry\-types\fR=[\fIIMPORT_ENTRY_TYPES\fR,...]\ \fB\-\-import\-glossaries\fR=[\fIIMPORT_GLOSSARIES\fR,...]\ \fB\-\-import\-referenced\-entry\-scopes\fR=[\fIIMPORT_REFERENCED_ENTRY_SCOPES\fR,...])\ :\ \fB\-\-import\-log\-level\fR=\fIIMPORT_LOG_LEVEL\fR\ \fB\-\-import\-source\-create\-time\fR=\fIIMPORT_SOURCE_CREATE_TIME\fR]) [\fB\-\-async\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-validate\-only\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

A metadata job represents a long running job on Dataplex Catalog metadata
entries. Some operations include importing and exporting metadata into entry
groups through the usage of entry types and aspect types.

The Metadata Job ID will be used to identify each configuration run. The
Metadata Job id must follow these rules:
.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 within the customer project / location.
.RE
.sp



.SH "EXAMPLES"

To create a Dataplex Metadata Job with type \f5IMPORT\fR and name
\f5my\-metadata\-job\fR in location \f5us\-central1\fR with additional
parameters, run:

.RS 2m
$ gcloud dataplex metadata\-jobs create my\-metadata\-job \e
    \-\-location=us\-central \-\-project=test\-project \-\-type=import \e
    \-\-import\-source\-storage\-uri=gs://test\-storage/ \e
    \-\-import\-source\-create\-time="2019\-01\-23T12:34:56.123456789Z" \e
    \-\-import\-entry\-sync\-mode=FULL \e
    \-\-import\-aspect\-sync\-mode=INCREMENTAL \e
    \-\-import\-log\-level="debug" \e
    \-\-import\-entry\-groups=projects/test\-project/locations/\e
us\-central1/entryGroups/eg1 \e
    \-\-import\-entry\-types="projects/test\-project/locations/us\-central\e
1/entryTypes/et1", \e
    "projects/test\-project/locations/us\-central1/entryTypes/et2" \e
    \-\-import\-aspect\-types="projects/test\-project/locations/us\-centra\e
l1/aspectTypes/at1", \e
    "projects/test\-project/locations/us\-central1/aspectTypes/at2"
.RE

To create a Dataplex Metadata Job with type \f5EXPORT\fR and name
\f5my\-metadata\-job\fR in location \f5us\-central1\fR with additional
parameters, run:

.RS 2m
$ gcloud dataplex metadata\-jobs create my\-metadata\-job \e
    \-\-location=us\-central \-\-project=test\-project \-\-type=export \e
    \-\-export\-output\-path=gs://test\-storage/ \e
    \-\-export\-entry\-groups=projects/test\-project/locations/\e
us\-central1/entryGroups/eg1 \e
    \-\-export\-entry\-types="projects/test\-project/locations/us\-central\e
1/entryTypes/et1", \e
    "projects/test\-project/locations/us\-central1/entryTypes/et2" \e
    \-\-export\-aspect\-types="projects/test\-project/locations/us\-centra\e
l1/aspectTypes/at1", \e
    "projects/test\-project/locations/us\-central1/aspectTypes/at2"
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Metadata job resource \- Arguments and flags that define the Dataplex metdata
job 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 \f5metadata_job\fR on the command line with a fully
specified name;
.IP "\(em" 2m
job ID is optional and will be generated if not specified 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


.RS 2m
.TP 2m
[\fIMETADATA_JOB\fR]

ID of the metadata job or fully qualified identifier for the metadata job.

To set the \f5metadata_job\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5metadata_job\fR on the command line;
.IP "\(bu" 2m
job ID is optional and will be generated if not specified.
.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 \f5metadata_job\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
job ID is optional and will be generated if not specified 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
\fB\-\-type\fR=\fITYPE\fR

Type. \fITYPE\fR must be one of:

.RS 2m
.TP 2m
\fBEXPORT\fR
A Metadata Export Job will export entries and aspects from the declared Dataplex
scope to the specified Cloud Storage location.
.TP 2m
\fBIMPORT\fR
A Metadata Import Job will ingest, update, or delete entries and aspects into
the declared Dataplex entry group.
.RE
.sp


.TP 2m

Settings for metadata job operation.

Exactly one of these must be specified:


.RS 2m
.TP 2m

Settings for metadata export job operation.


.RS 2m
.TP 2m
\fB\-\-export\-output\-path\fR=\fIEXPORT_OUTPUT_PATH\fR

The Cloud Storage location to export metadata to.

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

.TP 2m

A boundary on the scope of impact that the metadata export job can have.

At least one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-export\-aspect\-types\fR=[\fIEXPORT_ASPECT_TYPES\fR,...]

The list of aspect types to export metadata from.

.TP 2m
\fB\-\-export\-entry\-types\fR=[\fIEXPORT_ENTRY_TYPES\fR,...]

The list of entry types to export metadata from.

.TP 2m

The scope of resources to export metadata from.

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-export\-entry\-groups\fR=[\fIEXPORT_ENTRY_GROUPS\fR,...]

The list of entry groups to export metadata from.

.TP 2m
\fB\-\-export\-organization\-level\fR=\fIEXPORT_ORGANIZATION_LEVEL\fR

Whether to export metadata at the organization level.

.TP 2m
\fB\-\-export\-projects\fR=[\fIEXPORT_PROJECTS\fR,...]

The list of projects to export metadata from.

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

Settings for metadata import job operation.


.RS 2m
.TP 2m
\fB\-\-import\-aspect\-sync\-mode\fR=\fIIMPORT_ASPECT_SYNC_MODE\fR

Type. \fIIMPORT_ASPECT_SYNC_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBFULL\fR
All resources in the job's scope are modified. If a resource exists in Dataplex
but isn't included in the metadata import file, the resource is deleted when you
run the metadata job. Use this mode to perform a full sync of the set of entries
in the job scope.
.TP 2m
\fBINCREMENTAL\fR
Only the entries and aspects that are explicitly included in the metadata import
file are modified. Use this mode to modify a subset of resources while leaving
unreferenced resources unchanged.
.RE
.sp


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

.TP 2m
\fB\-\-import\-entry\-sync\-mode\fR=\fIIMPORT_ENTRY_SYNC_MODE\fR

Type. \fIIMPORT_ENTRY_SYNC_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBFULL\fR
All resources in the job's scope are modified. If a resource exists in Dataplex
but isn't included in the metadata import file, the resource is deleted when you
run the metadata job. Use this mode to perform a full sync of the set of entries
in the job scope.
.TP 2m
\fBINCREMENTAL\fR
Only the entries and aspects that are explicitly included in the metadata import
file are modified. Use this mode to modify a subset of resources while leaving
unreferenced resources unchanged.
.RE
.sp


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

.TP 2m
\fB\-\-import\-source\-storage\-uri\fR=\fIIMPORT_SOURCE_STORAGE_URI\fR

The Dataplex source storage URI to import metadata from.

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

.TP 2m
\fB\-\-import\-log\-level\fR=\fIIMPORT_LOG_LEVEL\fR

Type. \fIIMPORT_LOG_LEVEL\fR must be one of:

.RS 2m
.TP 2m
\fBDEBUG\fR
Debug\-level logging. Captures detailed logs for each import item. Use
debug\-level logging to troubleshoot issues with specific import items. For
example, use debug\-level logging to identify resources that are missing from
the job scope, entries or aspects that don't conform to the associated entry
type or aspect type, or other misconfigurations with the metadata import file..
.TP 2m
\fBINFO\fR
Info\-level logging. Captures logs at the overall job level. Includes aggregate
logs about import items, but doesn't specify which import item has an error..
.RE
.sp


.TP 2m
\fB\-\-import\-source\-create\-time\fR=\fIIMPORT_SOURCE_CREATE_TIME\fR

Time at which the event took place. See \f5$ gcloud topic datetimes\fR for
information on supported time formats.

.TP 2m

A boundary on the scope of impact that the metadata import job can have.

At least one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-import\-aspect\-types\fR=[\fIIMPORT_ASPECT_TYPES\fR,...]

The list of aspect types to import metadata jobs into.

.TP 2m
\fB\-\-import\-entry\-groups\fR=[\fIIMPORT_ENTRY_GROUPS\fR,...]

The list of entry groups to import metadata jobs into.

.TP 2m
\fB\-\-import\-entry\-link\-types\fR=[\fIIMPORT_ENTRY_LINK_TYPES\fR,...]

The list of entry link types to import metadata jobs into.

.TP 2m
\fB\-\-import\-entry\-types\fR=[\fIIMPORT_ENTRY_TYPES\fR,...]

The list of entry types to import metadata jobs into.

.TP 2m
\fB\-\-import\-glossaries\fR=[\fIIMPORT_GLOSSARIES\fR,...]

The list of glossaries to import metadata jobs into.

.TP 2m
\fB\-\-import\-referenced\-entry\-scopes\fR=[\fIIMPORT_REFERENCED_ENTRY_SCOPES\fR,...]

The list of referenced entry scopes to import metadata jobs into.


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


.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 metadata\-jobs create
.RE