gcloud dataplex entries update - update a Dataplex Entry

gcloud dataplex entries update(ENTRY :--entry-group=ENTRY_GROUP--location=LOCATION)[--remove-aspects=[ASPECT_TYPE@PATH,…]][--update-aspects=YAML_OR_JSON_FILE][--clear-fully-qualified-name    |--fully-qualified-name=FULLY_QUALIFIED_NAME][--entry-source-update-time=DATE_TIME :--clear-entry-source-create-time    |--entry-source-create-time=DATE_TIME--clear-entry-source-description    |--entry-source-description=DESCRIPTION--clear-entry-source-display-name    |--entry-source-display-name=DISPLAY_NAME--clear-entry-source-labels    |--entry-source-labels=[KEY=VALUE,…]--clear-entry-source-platform    |--entry-source-platform=PLATFORM_NAME--clear-entry-source-resource    |--entry-source-resource=RESOURCE--clear-entry-source-system    |--entry-source-system=SYSTEM_NAME][GCLOUD_WIDE_FLAG …]

gclouddataplexentriesupdateentry1--project=test-project--location=us-central1--entry-groupentry-group1--fully-qualified-name='custom:a.b.c'

To update description of an entry, run:

gclouddataplexentriesupdateentry1--project=test-project--location=us-central1--entry-groupentry-group1--entry-source-description='Updated description'--entry-source-update-time='1998-09-04T12:00:00-0700'

To clear the description of an entry, run:

gclouddataplexentriesupdateentry1--project=test-project--location=us-central1--entry-groupentry-group1--clear-entry-source-description--entry-source-update-time='1998-09-04T12:00:00-0700'

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

gclouddataplexentriesupdateentry1--project=test-project--location=us-central1--entry-groupentry-group1--update-aspects=path-to-a-file-with-aspects.json

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

gclouddataplexentriesupdateentry1--project=test-project--location=us-central1--entry-groupentry-group1--remove-aspects='test-project.us-central1.some-aspect-type@*'

To remove all aspects on pathSchema.column1 from the entry, run:

gclouddataplexentriesupdateentry1--project=test-project--location=us-central1--entry-groupentry-group1--remove-aspects='*@Schema.column1'

To remove exact aspectstest-project.us-central1.some-aspect-type@Schema.column1 andtest-project.us-central1.some-aspect-type2@Schema.column2 from theentry, run:

gclouddataplexentriesupdateentry1--project=test-project--location=us-central1--entry-groupentry-group1--remove-aspects=test-project.us-central1.some-aspect-type@Schema.column1,test-project.us-central2.some-aspect-type@Schema.column2

Entry resource - Arguments and flags that define the Dataplex Entry you want toreference. The arguments in this group can be used to specify the attributes ofthis resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.

To set theproject attribute:

• provide the argumententry on the command line with a fullyspecified name;
• provide the argument--project on the command line;
• set the propertycore/project.

This must be specified.

ENTRY

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

To set theentry attribute:

• provide the argumententry on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--entry-group=ENTRY_GROUP

Entry group containing Dataplex Entries.To set theentry-group attribute:

• provide the argumententry on the command line with a fullyspecified name;
• provide the argument--entry-group on the command line.

--location=LOCATION

Location of the Dataplex resource.To set thelocation attribute:

• provide the argumententry on the command line with a fullyspecified name;
• provide the argument--location on the command line;
• set the propertydataplex/location.

--remove-aspects=[ASPECT_TYPE@PATH,…]

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

Keys are in the formatASPECT_TYPE@PATH, orjustASPECT_TYPE, if the Aspect is attachedto an entry itself rather than to a specific column defined in the schema.

ASPECT_TYPE is expected to be in a formatPROJECT_ID.LOCATION.ASPECT_TYPE_ID or awildcard*, which targets all aspect types.

PATH can be either empty (which means a'root' path, such that Aspect is attached to the entry itself), point to aspecific column defined in the schema (for example:Schema.some_column) or a wildcard* (target allpaths).

ASPECT_TYPE andPATH cannot be both specified as wildcards*.

If both--update-aspects and--remove-aspects flagsare specified, and the same aspect key is used in both flags, then--update-aspects takes precedence, and such an aspect will beupdated and not removed.

--update-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 beadded or updated. Specifying this flag does not remove any Aspects from theentry. In other words, specifying this flag will not lead to a full replacementof Aspects with a contents of the provided file.

Content of the file contains a map, where keys are in the formatASPECT_TYPE@PATH, or justASPECT_TYPE, if the Aspect is attached toan 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 templatedefined for a givenASPECT_TYPE. EachAspect will be replaced fully by the provided content. That means data in theAspect will be replaced and not merged with existing contents of that Aspect inthe Entry.

ASPECT_TYPE is expected to be in a formatPROJECT_ID.LOCATION.ASPECT_TYPE_ID.

PATH can be either empty (which means a'root' path, such that Aspect is attached to the entry itself) or point to aspecific column defined in the schema. For example:Schema.some_column.

Example YAML format:

project-id1.us-central1.my-aspect-type1:data:aspectField1:someValueaspectField2:someOtherValueproject-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"}}}

If both--update-aspects and--remove-aspects flagsare specified, and the same aspect key is used in both flags, then--update-aspects takes precedence, and such an aspect will beupdated and not removed.

At most one of these can be specified:

--clear-fully-qualified-name

Clear the FQN for the Entry.

--fully-qualified-name=FULLY_QUALIFIED_NAME

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

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

--entry-source-update-time=DATE_TIME

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

At most one of these can be specified:

--clear-entry-source-create-time

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

--entry-source-create-time=DATE_TIME

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

At most one of these can be specified:

--clear-entry-source-description

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

--entry-source-description=DESCRIPTION

Description of the Entry.

At most one of these can be specified:

--clear-entry-source-display-name

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

--entry-source-display-name=DISPLAY_NAME

User friendly display name.

At most one of these can be specified:

--clear-entry-source-labels

Clear the labels for the Entry Source.

--entry-source-labels=[KEY=VALUE,…]

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens(-), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers.

At most one of these can be specified:

--clear-entry-source-platform

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

--entry-source-platform=PLATFORM_NAME

The platform containing the source system.

At most one of these can be specified:

--clear-entry-source-resource

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

--entry-source-resource=RESOURCE

The name of the resource in the source system.

At most one of these can be specified:

--clear-entry-source-system

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

--entry-source-system=SYSTEM_NAME

The name of the source system.

Run$gcloud help for details.