gcloud alpha dataplex entries describe Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha dataplex entries describe - describe a Dataplex entry
- SYNOPSIS
gcloud alpha dataplex entries describe(ENTRY:--entry-group=ENTRY_GROUP--location=LOCATION)[--aspect-types=[ASPECT_TYPES,…]][--paths=[PATHS,…]][--view=VIEW][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Describe a Dataplex entry.Displays the details of a Dataplex entry resource given a valid entry ID.
- EXAMPLES
- To describe a Dataplex entry
entry1within entry groupentry-group1in locationus-central1, run:gcloudalphadataplexentriesdescribeentry1--entry-group=entry-group1--location=us-central1--project=test-project - POSITIONAL ARGUMENTS
- Entry resource - Arguments and flags that define the Dataplex Entry you want todescribe. 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 the
projectattribute:- provide the argument
entryon the command line with a fullyspecified name; - provide the argument
--projecton 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
entryattribute:- provide the argument
entryon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--entry-group=ENTRY_GROUP- Entry group containing Dataplex Entries.To set the
entry-groupattribute:- provide the argument
entryon the command line with a fullyspecified name; - provide the argument
--entry-groupon the command line.
- provide the argument
--location=LOCATION- Location of the Dataplex resource.To set the
locationattribute:- provide the argument
entryon the command line with a fullyspecified name; - provide the argument
--locationon 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 todescribe. 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.
- FLAGS
--aspect-types=[ASPECT_TYPES,…]- Limits the aspects returned to the provided aspect types. Only works if the
--view=customis selected.For example, if two aspect types are specified:"projects/projectA/locations/us-central1/my-aspect-type,projects/projectB/locations/us/my-aspect-type2"then only aspects matching these aspect types will be returned.
Can be further constrained by the
--pathsargument. --paths=[PATHS,…]- Limits the aspects returned to those associated with the provided paths withinthe Entry. Only works if the
--view=customis selected.For example, if two paths are specified: "--paths=property1,property2" then onlyaspects on these paths will be returned.
To return aspects without any path, the empty (root) path can be specified. Forthis "." can be used. For example, when "--paths=.,property1" are specified,then only aspects on the path "property1" and on the entry itself will bereturned.
Can be further constrained by
--aspect-typesargument. --view=VIEW- Controls which parts of an entry are to be returned.
VIEWmust be one of:all- Returns all aspects. If the number of aspects would exceed 100, the first 100will be returned.
basic- Returns entry only, without aspects.
custom- Returns aspects filtered based on
--aspect-typesAND--pathsarguments specified. When used, at least one of--aspect-typesand--pathsarguments must bespecified. If the number of aspects would exceed 100, the first 100 will bereturned. full- Default value. Returns all required aspects, as well as the keys of allnon-required aspects.
- 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 helpfor details. - API REFERENCE
- This command uses the
dataplex/v1API. The full documentation forthis API can be found at:https://cloud.google.com/dataplex/docs - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gclouddataplexentriesdescribe
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.