.TH "GCLOUD_DATAPLEX_ENTRIES_CREATE" 1



.SH "NAME"
.HP
gcloud dataplex entries create \- create a Dataplex Entry resource



.SH "SYNOPSIS"
.HP
\f5gcloud dataplex entries create\fR (\fIENTRY\fR\ :\ \fB\-\-entry\-group\fR=\fIENTRY_GROUP\fR\ \fB\-\-location\fR=\fILOCATION\fR) (\fB\-\-entry\-type\fR=\fIENTRY_TYPE\fR\ :\ \fB\-\-entry\-type\-location\fR=\fIENTRY_TYPE_LOCATION\fR\ \fB\-\-entry\-type\-project\fR=\fIENTRY_TYPE_PROJECT\fR) [\fB\-\-aspects\fR=\fIYAML_OR_JSON_FILE\fR] [\fB\-\-fully\-qualified\-name\fR=\fIFULLY_QUALIFIED_NAME\fR] [\fB\-\-parent\-entry\fR=\fIPARENT_ENTRY\fR] [\fB\-\-entry\-source\-ancestors\fR=[\fIANCESTORS\fR,...]\ \fB\-\-entry\-source\-create\-time\fR=\fIDATE_TIME\fR\ \fB\-\-entry\-source\-description\fR=\fIDESCRIPTION\fR\ \fB\-\-entry\-source\-display\-name\fR=\fIDISPLAY_NAME\fR\ \fB\-\-entry\-source\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-entry\-source\-platform\fR=\fIPLATFORM_NAME\fR\ \fB\-\-entry\-source\-resource\fR=\fIRESOURCE\fR\ \fB\-\-entry\-source\-system\fR=\fISYSTEM_NAME\fR\ \fB\-\-entry\-source\-update\-time\fR=\fIDATE_TIME\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Create a Dataplex Entry resource.



.SH "EXAMPLES"

To create a Dataplex entry with name \f5my\-dataplex\-entry\fR in location
\f5us\-central1\fR in entry group \f5my\-entry\-group\fR and with entry type
projects/my\-project/locations/us\-central1/entryTypes/my\-type, run:

.RS 2m
$ gcloud dataplex entries create my\-dataplex\-entry \e
    \-\-location=us\-central1 \-\-entry_group=my\-entry\-group \e
    \-\-entry\-type \e
    projects/my\-project/locations/us\-central1/entryTypes/my\-type
.RE

To create a Dataplex Entry with name \f5my\-child\-entry\fR and set its parent
to an existing entry \f5my\-parent\-entry\fR, run:

.RS 2m
$ gcloud dataplex entries create my\-child\-entry \e
    \-\-location=us\-central1 \-\-entry_group=my\-entry\-group \e
    \-\-entry\-type \e
    projects/my\-project/locations/us\-central1/entryTypes/my\-type \e
    \-\-parent\-entry \e
    projects/my\-project/locations/us\-central1/entryGroups/\e
my\-entry\-group/entries/my\-parent\-entry
.RE

To create a Dataplex Entry with its description, display name, ancestors, labels
and timestamps populated in its EntrySource, run:

.RS 2m
$ gcloud dataplex entries create my\-entry \-\-location=us\-central1 \e
    \-\-entry_group=my\-entry\-group \e
    \-\-entry\-type \e
    projects/my\-project/locations/us\-central1/entryTypes/my\-type \e
    \-\-entry\-source\-description \e
    'This is a description of the Entry.' \e
    \-\-entry\-source\-display\-name 'display name' \e
    \-\-entry\-source\-ancestors \e
    '{"type":"projects/my\-project/locations/us\-central1/entryTypes/s\e
ome\-type",
 "name":"projects/my\-project/locations/us\-central1/entryGroups/my\-en\e
try\-group/entries/ancestor\-entry"},
 {"type":"projects/my\-project/locations/us\-central1/entryTypes/anoth\e
er\-type",
 "name":"projects/my\-project/locations/us\-central1/entryGroups/my\-en\e
try\-group/entries/another\-ancestor\-entry"}' \e
    \-\-entry\-source\-labels key1=value1,key2=value2 \e
    \-\-entry\-source\-create\-time 2024\-01\-01T09:39:25.160173Z \e
    \-\-entry\-source\-update\-time 2024\-01\-01T09:39:25.160173Z
.RE

To create a Dataplex Entry reading its aspects from a YAML file, run:

.RS 2m
$ gcloud dataplex entries create my\-entry \-\-location=us\-central1 \e
    \-\-entry_group=my\-entry\-group \e
    \-\-entry\-type \e
    projects/my\-project/locations/us\-central1/entryTypes/my\-type \e
    \-\-aspects aspects.yaml
.RE

The file containing the aspects has the following format:

.RS 2m
my\-project.us\-central1.my\-aspect\-type:
  aspectType: my\-project.us\-central1.my\-aspect\-type
  createTime: "2024\-01\-01T09:39:25.160173Z"
  updateTime: "2024\-01\-01T09:39:25.160173Z"
  data:
    {}
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Entry resource \- Arguments and flags that define the Dataplex Entry you want to
reference. 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 \f5entry\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
\fIENTRY\fR

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

To set the \f5entry\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5entry\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\-\-entry\-group\fR=\fIENTRY_GROUP\fR

Entry group containing Dataplex Entries.


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

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

Location of the Dataplex resource.


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

Entry type resource \- Arguments and flags that define the Dataplex EntryType
you want to reference. The arguments in this group can be used to specify the
attributes of this resource.

This must be specified.


.RS 2m
.TP 2m
\fB\-\-entry\-type\fR=\fIENTRY_TYPE\fR

ID of the entry type or fully qualified identifier for the entry type.

To set the \f5entry_type\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-entry\-type\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-entry\-type\-location\fR=\fIENTRY_TYPE_LOCATION\fR

The location of the EntryType resource.

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

.TP 2m
\fB\-\-entry\-type\-project\fR=\fIENTRY_TYPE_PROJECT\fR

The project of the EntryType resource.

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


.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-aspects\fR=\fIYAML_OR_JSON_FILE\fR

Path to a YAML or JSON file containing Aspects to add or update.

When this flag is specified, only Aspects referenced in the file are going to be
added or updated. Specifying this flag does not remove any Aspects from the
entry. In other words, specifying this flag will not lead to a full replacement
of Aspects with a contents of the provided file.

Content of the file contains a map, where keys are in the format
\f5\fIASPECT_TYPE@PATH\fR\fR, or just \f5\fIASPECT_TYPE\fR\fR, if the Aspect is
attached to an entry itself rather than to a specific column defined in the
schema.

Values in the map represent Aspect's content, which must conform to a template
defined for a given \f5\fIASPECT_TYPE\fR\fR. Each Aspect will be replaced fully
by the provided content. That means data in the Aspect will be replaced and not
merged with existing contents of that Aspect in the Entry.

\f5\fIASPECT_TYPE\fR\fR is expected to be in a format
\f5\fIPROJECT_ID.LOCATION.ASPECT_TYPE_ID\fR\fR.

\f5\fIPATH\fR\fR can be either empty (which means a 'root' path, such that
Aspect is attached to the entry itself) or point to a specific column defined in
the schema. For example: \f5Schema.some_column\fR.

Example YAML format:

.RS 2m
  project\-id1.us\-central1.my\-aspect\-type1:
    data:
      aspectField1: someValue
      aspectField2: someOtherValue
  project\-id2.us\-central1.my\-aspect\-type2@Schema.column1:
    data:
      aspectField3: someValue3
.RE

Example JSON format:

.RS 2m
  {
    "project\-id1.us\-central1.my\-aspect\-type1": {
      "data": {
        "aspectField1": "someValue",
        "aspectField2": "someOtherValue"
      }
    },
    "project\-id2.us\-central1.my\-aspect\-type2@Schema.column1": {
      "data": {
        "aspectField3": "someValue3"
      }
    }
  }
.RE

.TP 2m
\fB\-\-fully\-qualified\-name\fR=\fIFULLY_QUALIFIED_NAME\fR

A name for the entry that can reference it in an external system. The maximum
size of the field is 4000 characters.

.TP 2m

Entry resource \- Arguments and flags that define the parent Entry you want to
reference. This represents a Cloud 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 \f5\-\-parent\-entry\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

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

To set the \f5entry_group\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-parent\-entry\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-entry_group\fR on the command line.
.RE
.sp


.RS 2m
.TP 2m
\fB\-\-parent\-entry\fR=\fIPARENT_ENTRY\fR

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

To set the \f5entry\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-parent\-entry\fR on the command line.
.RE
.sp

.RE
.sp
.TP 2m

Source system related information for an entry. If any of the entry source
fields are specified, then ``\-\-entry\-source\-update\-time\f5 must be
specified as well.


.RS 2m
.TP 2m
\fB\-\-entry\-source\-ancestors\fR=[\fIANCESTORS\fR,...]

Information about individual items in the hierarchy of an Entry.

.TP 2m
\fB\-\-entry\-source\-create\-time\fR=\fIDATE_TIME\fR

The creation date and time of the resource in the source system.

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

Description of the Entry.

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

User friendly display name.

.TP 2m
\fB\-\-entry\-source\-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 (\fR\-\f5),
underscores (\fR_\f5), lowercase characters, and numbers. Values must contain
only hyphens (\fR\-\f5), underscores (\fR_\f5), lowercase characters, and
numbers.

.TP 2m
\fB\-\-entry\-source\-platform\fR=\fIPLATFORM_NAME\fR

The platform containing the source system.

.TP 2m
\fB\-\-entry\-source\-resource\fR=\fIRESOURCE\fR

The name of the resource in the source system.

.TP 2m
\fB\-\-entry\-source\-system\fR=\fISYSTEM_NAME\fR

The name of the source system.

.TP 2m
\fB\-\-entry\-source\-update\-time\fR=\fIDATE_TIME\fR

The update date and time of the resource in the source system.


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