.TH "GCLOUD_DATAPLEX_ENTRIES_LOOKUP" 1



.SH "NAME"
.HP
gcloud dataplex entries lookup \- lookup a Dataplex entry



.SH "SYNOPSIS"
.HP
\f5gcloud dataplex entries lookup\fR (\fIENTRY\fR\ :\ \fB\-\-entry\-group\fR=\fIENTRY_GROUP\fR\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-aspect\-types\fR=[\fIASPECT_TYPES\fR,...]] [\fB\-\-paths\fR=[\fIPATHS\fR,...]] [\fB\-\-view\fR=\fIVIEW\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Lookup a Dataplex entry.

Displays the details of a Dataplex entry resource given a valid entry ID. Unlike
\f5describe\fR, where the Dataplex permission is required for access, for
\f5lookup\fR the permission from the original source system is required on the
entry instead. For example, if the source is a BigQuery table, you need the
\f5bigquery.tables.get\fR permission to lookup an entry.



.SH "EXAMPLES"

To lookup a Dataplex entry \f5entry1\fR within entry group \f5entry\-group1\fR
in location \f5us\-central1\fR, run:

.RS 2m
$ gcloud dataplex entries lookup entry1 \-\-entry\-group=entry\-group1 \e
    \-\-location=us\-central1 \-\-project=test\-project
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Entry resource \- Arguments and flags that define the Dataplex Entry you want to
lookup. 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\-\-aspect\-types\fR=[\fIASPECT_TYPES\fR,...]

Limits the aspects returned to the provided aspect types. Only works if the
\f5\-\-view=custom\fR is 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 \f5\-\-paths\fR argument.

.TP 2m
\fB\-\-paths\fR=[\fIPATHS\fR,...]

Limits the aspects returned to those associated with the provided paths within
the Entry. Only works if the \f5\-\-view=custom\fR is selected.

For example, if two paths are specified: "\-\-paths=property1,property2" then
only aspects on these paths will be returned.

To return aspects without any path, the empty (root) path can be specified. For
this "." can be used. For example, when "\-\-paths=.,property1" are specified,
then only aspects on the path "property1" and on the entry itself will be
returned.

Can be further constrained by \f5\-\-aspect\-types\fR argument.

.TP 2m
\fB\-\-view\fR=\fIVIEW\fR

Controls which parts of an entry are to be returned. \fIVIEW\fR must be one of:

.RS 2m
.TP 2m
\fBall\fR
Returns all aspects. If the number of aspects would exceed 100, the first 100
will be returned.

.TP 2m
\fBbasic\fR
Returns entry only, without aspects.
.TP 2m
\fBcustom\fR
Returns aspects filtered based on \f5\-\-aspect\-types\fR AND \f5\-\-paths\fR
arguments specified. When used, at least one of \f5\-\-aspect\-types\fR and
\f5\-\-paths\fR arguments must be specified. If the number of aspects would
exceed 100, the first 100 will be returned.

.TP 2m
\fBfull\fR
Default value. Returns all required aspects, as well as the keys of all
non\-required aspects.

.RE
.sp



.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 "API REFERENCE"

This command uses the \fBdataplex/v1\fR API. The full documentation for this API
can be found at: https://cloud.google.com/dataplex/docs



.SH "NOTES"

This variant is also available:

.RS 2m
$ gcloud alpha dataplex entries lookup
.RE