- NAME
-
- gcloud alpha dataplex glossaries terms describe - describes a glossary term
- SYNOPSIS
-
-
gcloud alpha dataplex glossaries terms describe
(GLOSSARY_TERM
:--glossary
=GLOSSARY
--location
=LOCATION
) [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
Describes a glossary term. - EXAMPLES
-
To describe the glossary term
test-term
in glossarytest-glossary
in projecttest-project
in loactionus-central1
, run:gcloud alpha dataplex glossaries terms describe test-term --glossary=test-glossary --location=us-central1 --project=test-project
- POSITIONAL ARGUMENTS
-
-
Glossary term resource - Arguments and flags that define the glossary term you
want to describe. 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
glossary_term
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.
GLOSSARY_TERM
-
ID of the glossary term or fully qualified identifier for the glossary term.
To set the
glossary_term
attribute:-
provide the argument
glossary_term
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--glossary
=GLOSSARY
-
Identifier of the Dataplex Glossary resource.
To set the
glossary
attribute:-
provide the argument
glossary_term
on the command line with a fully specified name; -
provide the argument
--glossary
on the command line.
-
provide the argument
--location
=LOCATION
-
Location of the Dataplex resource.
To set the
location
attribute:-
provide the argument
glossary_term
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
-
Glossary term resource - Arguments and flags that define the glossary term you
want to describe. 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.
- 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 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 glossaries terms describe
gcloud alpha dataplex glossaries terms describe
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 2025-05-13 UTC.