.TH "GCLOUD_ALPHA_DATAPLEX_ENTRIES_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha dataplex entries update \- update a Dataplex Entry



.SH "SYNOPSIS"
.HP
\f5gcloud alpha dataplex entries update\fR (\fIENTRY\fR\ :\ \fB\-\-entry\-group\fR=\fIENTRY_GROUP\fR\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-remove\-aspects\fR=[\fIASPECT_TYPE\fR@\fIPATH\fR,...]] [\fB\-\-update\-aspects\fR=\fIYAML_OR_JSON_FILE\fR] [\fB\-\-clear\-fully\-qualified\-name\fR\ |\ \fB\-\-fully\-qualified\-name\fR=\fIFULLY_QUALIFIED_NAME\fR] [\fB\-\-entry\-source\-update\-time\fR=\fIDATE_TIME\fR\ :\ \fB\-\-clear\-entry\-source\-create\-time\fR\ |\ \fB\-\-entry\-source\-create\-time\fR=\fIDATE_TIME\fR\ \fB\-\-clear\-entry\-source\-description\fR\ |\ \fB\-\-entry\-source\-description\fR=\fIDESCRIPTION\fR\ \fB\-\-clear\-entry\-source\-display\-name\fR\ |\ \fB\-\-entry\-source\-display\-name\fR=\fIDISPLAY_NAME\fR\ \fB\-\-clear\-entry\-source\-labels\fR\ |\ \fB\-\-entry\-source\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-clear\-entry\-source\-platform\fR\ |\ \fB\-\-entry\-source\-platform\fR=\fIPLATFORM_NAME\fR\ \fB\-\-clear\-entry\-source\-resource\fR\ |\ \fB\-\-entry\-source\-resource\fR=\fIRESOURCE\fR\ \fB\-\-clear\-entry\-source\-system\fR\ |\ \fB\-\-entry\-source\-system\fR=\fISYSTEM_NAME\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Update specified fields in a given Dataplex Entry.



.SH "EXAMPLES"

To update fully qualified name (FQN) of an entry, run:

.RS 2m
$ gcloud alpha dataplex entries update entry1 \e
    \-\-project=test\-project \-\-location=us\-central1 \e
    \-\-entry\-group entry\-group1 \-\-fully\-qualified\-name='custom:a.b.c'
.RE

To update description of an entry, run:

.RS 2m
$ gcloud alpha dataplex entries update entry1 \e
    \-\-project=test\-project \-\-location=us\-central1 \e
    \-\-entry\-group entry\-group1 \e
    \-\-entry\-source\-description='Updated description' \e
    \-\-entry\-source\-update\-time='1998\-09\-04T12:00:00\-0700'
.RE

To clear the description of an entry, run:

.RS 2m
$ gcloud alpha dataplex entries update entry1 \e
    \-\-project=test\-project \-\-location=us\-central1 \e
    \-\-entry\-group entry\-group1 \-\-clear\-entry\-source\-description \e
    \-\-entry\-source\-update\-time='1998\-09\-04T12:00:00\-0700'
.RE

To add or update aspects from the YAML/JSON file, run:

.RS 2m
$ gcloud alpha dataplex entries update entry1 \e
    \-\-project=test\-project \-\-location=us\-central1 \e
    \-\-entry\-group entry\-group1 \e
    \-\-update\-aspects=path\-to\-a\-file\-with\-aspects.json
.RE

To remove all aspects of type
\f5test\-project.us\-central1.some\-aspect\-type\fR from the entry, run:

.RS 2m
$ gcloud alpha dataplex entries update entry1 \e
    \-\-project=test\-project \-\-location=us\-central1 \e
    \-\-entry\-group entry\-group1 \e
    \-\-remove\-aspects='test\-project.us\-central1.some\-aspect\-type@*'
.RE

To remove all aspects on path \f5Schema.column1\fR from the entry, run:

.RS 2m
$ gcloud alpha dataplex entries update entry1 \e
    \-\-project=test\-project \-\-location=us\-central1 \e
    \-\-entry\-group entry\-group1 \-\-remove\-aspects='*@Schema.column1'
.RE

To remove exact aspects
\f5test\-project.us\-central1.some\-aspect\-type@Schema.column1\fR and
\f5test\-project.us\-central1.some\-aspect\-type2@Schema.column2\fR from the
entry, run:

.RS 2m
$ gcloud alpha dataplex entries update entry1 \e
    \-\-project=test\-project \-\-location=us\-central1 \e
    \-\-entry\-group entry\-group1 \e
    \-\-remove\-aspects=test\-project.us\-central1.some\-aspect\-type@Schem\e
a.column1,test\-project.us\-central2.some\-aspect\-type@Schema.column2
.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 "FLAGS"

.RS 2m
.TP 2m
\fB\-\-remove\-aspects\fR=[\fIASPECT_TYPE\fR@\fIPATH\fR,...]

List of Aspect keys, identifying Aspects to remove from the entry.

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.

\f5\fIASPECT_TYPE\fR\fR is expected to be in a format
\f5\fIPROJECT_ID.LOCATION.ASPECT_TYPE_ID\fR\fR or a wildcard \f5*\fR, which
targets all aspect types.

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

\f5\fIASPECT_TYPE\fR\fR and \f5\fIPATH\fR\fR cannot be both specified as
wildcards \f5*\fR.

If both \f5\-\-update\-aspects\fR and \f5\-\-remove\-aspects\fR flags are
specified, and the same aspect key is used in both flags, then
\f5\-\-update\-aspects\fR takes precedence, and such an aspect will be updated
and not removed.

.TP 2m
\fB\-\-update\-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


If both \f5\-\-update\-aspects\fR and \f5\-\-remove\-aspects\fR flags are
specified, and the same aspect key is used in both flags, then
\f5\-\-update\-aspects\fR takes precedence, and such an aspect will be updated
and not removed.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-fully\-qualified\-name\fR

Clear the FQN for the Entry.

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

FQN, a name for the entry that can reference it in an external system.

.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\-update\-time\fR=\fIDATE_TIME\fR

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

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

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-entry\-source\-create\-time\fR

Clear the value for the create_time field in the Entry Source.

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

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

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-entry\-source\-description\fR

Clear the value for the description field in the Entry Source.

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

Description of the Entry.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-entry\-source\-display\-name\fR

Clear the value for the display_name field in the Entry Source.

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

User friendly display name.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-entry\-source\-labels\fR

Clear the labels for the Entry Source.

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

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-entry\-source\-platform\fR

Clear the value for the platform field in the Entry Source.

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

The platform containing the source system.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-entry\-source\-resource\fR

Clear the value for the resource field in the Entry Source.

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

The name of the resource in the source system.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-entry\-source\-system\fR

Clear the value for the system field in the Entry Source.

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

The name of the source system.


\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 command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. This variant is also available:

.RS 2m
$ gcloud dataplex entries update
.RE