HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/current/help/man/man1/gcloud_dataplex_entries_update-aspects.1
.TH "GCLOUD_DATAPLEX_ENTRIES_UPDATE\-ASPECTS" 1



.SH "NAME"
.HP
gcloud dataplex entries update\-aspects \- add or update aspects for a Dataplex Entry



.SH "SYNOPSIS"
.HP
\f5gcloud dataplex entries update\-aspects\fR (\fIENTRY\fR\ :\ \fB\-\-entry\-group\fR=\fIENTRY_GROUP\fR\ \fB\-\-location\fR=\fILOCATION\fR) \fB\-\-aspects\fR=\fIYAML_OR_JSON_FILE\fR [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Add or update aspects for a Dataplex Entry.



.SH "EXAMPLES"

To add or update aspects for the Dataplex entry \f5entry1\fR within the entry
group \f5entry\-group1\fR in location \f5us\-central1\fR from the YAML/JSON
file, run:

.RS 2m
$ gcloud dataplex entries update\-aspects entry1 \e
    \-\-project=test\-project \-\-location=us\-central1 \e
    \-\-entry\-group entry\-group1 \e
    \-\-aspects=path\-to\-a\-file\-with\-aspects.json
.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
\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


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