- NAME
-
- gcloud dataplex entries lookup - lookup a Dataplex entry
- SYNOPSIS
-
-
gcloud dataplex entries lookup
(ENTRY
:--entry-group
=ENTRY_GROUP
--location
=LOCATION
) [--aspect-types
=[ASPECT_TYPES
,…]] [--paths
=[PATHS
,…]] [--view
=VIEW
] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
Lookup a Dataplex entry.
Displays the details of a Dataplex entry resource given a valid entry ID. Unlike
describe
, where the Dataplex permission is required for access, forlookup
the permission from the original source system is required on the entry instead. For example, if the source is a BigQuery table, you need thebigquery.tables.get
permission to lookup an entry. - EXAMPLES
-
To lookup a Dataplex entry
entry1
within entry groupentry-group1
in locationus-central1
, run:gcloud dataplex entries lookup entry1 --entry-group=entry-group1 --location=us-central1 --project=test-project
- POSITIONAL ARGUMENTS
-
-
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
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
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.
- FLAGS
-
--aspect-types
=[ASPECT_TYPES
,…]-
Limits the aspects returned to the provided aspect types. Only works if the
--view=custom
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
--paths
argument. --paths
=[PATHS
,…]-
Limits the aspects returned to those associated with the provided paths within
the Entry. Only works if the
--view=custom
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
--aspect-types
argument. --view
=VIEW
-
Controls which parts of an entry are to be returned.
VIEW
must be one of:all
- Returns all aspects. If the number of aspects would exceed 100, the first 100 will be returned.
basic
- Returns entry only, without aspects.
custom
-
Returns aspects filtered based on
--aspect-types
AND--paths
arguments specified. When used, at least one of--aspect-types
and--paths
arguments must be specified. If the number of aspects would exceed 100, the first 100 will be returned. full
- Default value. Returns all required aspects, as well as the keys of all non-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 help
for details. - API REFERENCE
-
This command uses the
dataplex/v1
API. The full documentation for this API can be found at: https://cloud.google.com/dataplex/docs - NOTES
-
This variant is also available:
gcloud alpha dataplex entries lookup
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.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{
"lastModified": "Last updated 2024-07-30 UTC.",
"confidential": False
}