- NAME
-
- gcloud alpha dataplex entries update-aspects - add or update aspects for a Dataplex Entry
- SYNOPSIS
-
-
gcloud alpha dataplex entries update-aspects
(ENTRY
:--entry-group
=ENTRY_GROUP
--location
=LOCATION
)--aspects
=YAML_OR_JSON_FILE
[GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
Add or update aspects for a Dataplex Entry. - EXAMPLES
-
To add or update aspects for the Dataplex entry
entry1
within the entry groupentry-group1
in locationus-central1
from the YAML/JSON file, run:gcloud alpha dataplex entries update-aspects entry1 --project=test-project --location=us-central1 --entry-group entry-group1 --aspects=path-to-a-file-with-aspects.json
- POSITIONAL ARGUMENTS
-
-
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
project
attribute:-
provide the argument
entry
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
This must be specified.
ENTRY
-
ID of the entry or fully qualified identifier for the entry.
To set the
entry
attribute:-
provide the argument
entry
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--entry-group
=ENTRY_GROUP
-
Entry group containing Dataplex Entries.
To set the
entry-group
attribute:-
provide the argument
entry
on the command line with a fully specified name; -
provide the argument
--entry-group
on the command line.
-
provide the argument
--location
=LOCATION
-
Location of the Dataplex resource.
To set the
location
attribute:-
provide the argument
entry
on the command line with a fully specified name; -
provide the argument
--location
on the command line; -
set the property
dataplex/location
.
-
provide the argument
-
provide the argument
-
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.
- REQUIRED FLAGS
-
--aspects
=YAML_OR_JSON_FILE
-
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
, or justASPECT_TYPE@PATH
, if the Aspect is attached to an entry itself rather than to a specific column defined in the schema.ASPECT_TYPE
Values in the map represent Aspect's content, which must conform to a template defined for a given
. 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.ASPECT_TYPE
is expected to be in a formatASPECT_TYPE
.PROJECT_ID.LOCATION.ASPECT_TYPE_ID
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:PATH
Schema.some_column
.Example YAML format:
project-id1.us-central1.my-aspect-type1: data: aspectField1: someValue aspectField2: someOtherValue project-id2.us-central1.my-aspect-type2@Schema.column1: data: aspectField3: someValue3
Example JSON format:
{ "project-id1.us-central1.my-aspect-type1": { "data": { "aspectField1": "someValue", "aspectField2": "someOtherValue" } }, "project-id2.us-central1.my-aspect-type2@Schema.column1": { "data": { "aspectField3": "someValue3" } } }
- 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
$ gcloud help
for details. - 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:
gcloud dataplex entries update-aspects
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-30 UTC.