1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-19 07:15:23 +00:00

gcloud: Wed May 14 10:45:02 UTC 2025

This commit is contained in:
Automated 2025-05-14 10:45:02 +00:00
parent dfebca5b6c
commit 82f3a66664
423 changed files with 11160 additions and 1149 deletions

View file

@ -0,0 +1,87 @@
NAME
gcloud dataplex glossaries add-iam-policy-binding - add IAM policy binding
to a Dataplex Glossary
SYNOPSIS
gcloud dataplex glossaries add-iam-policy-binding
(GLOSSARY : --location=LOCATION) --member=PRINCIPAL --role=ROLE
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Add IAM policy binding to a Dataplex Glossary.
EXAMPLES
To add an IAM policy binding for the role of roles/dataplex.viewer for the
user test-user@gmail.com to Glossary test-glossary in location us-central,
run: $ gcloud dataplex glossaries add-iam-policy-binding test-glossary \
--project=test-project --location=us-central1 \
--role=roles/dataplex.viewer --member=user:test-user@gmail.com \
See https://cloud.google.com/dataplex/docs/iam-roles for \
details of policy role and member types.
POSITIONAL ARGUMENTS
Glossary resource - Arguments and flags that define the Dataplex Glossary
you want to add IAM policy binding to. 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 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
ID of the glossary or fully qualified identifier for the glossary.
To set the glossary attribute:
▸ provide the argument glossary on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location of the Dataplex resource.
To set the location attribute:
▸ provide the argument glossary on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
REQUIRED FLAGS
--member=PRINCIPAL
The principal to add the binding for. Should be of the form
user|group|serviceAccount:email or domain:domain.
Examples: user:test-user@gmail.com, group:admins@example.com,
serviceAccount:test123@example.domain.com, or
domain:example.domain.com.
Some resources also accept the following special values:
◆ allUsers - Special identifier that represents anyone who is on the
internet, with or without a Google account.
◆ allAuthenticatedUsers - Special identifier that represents anyone
who is authenticated with a Google account or a service account.
--role=ROLE
Role name to assign to the principal. The role name is the complete
path of a predefined role, such as roles/logging.viewer, or the role ID
for a custom role, such as
organizations/{ORGANIZATION_ID}/roles/logging.viewer.
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.
NOTES
This variant is also available:
$ gcloud alpha dataplex glossaries add-iam-policy-binding

View file

@ -0,0 +1,100 @@
NAME
gcloud dataplex glossaries categories create - creates a glossary category
SYNOPSIS
gcloud dataplex glossaries categories create
(GLOSSARY_CATEGORY : --glossary=GLOSSARY --location=LOCATION)
--parent=PARENT [--description=DESCRIPTION]
[--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
A glossary category represents a collection of glossary categories and
glossary terms within a glossary that are related to each other.
EXAMPLES
To create a glossary category test-category in glossary test-glossary in
project test-project in location us-central1, with description test
description, displayName displayName and parent
projects/test-project/locations/us-central1/glossaries/test-glossary , run:
$ gcloud dataplex glossaries categories create test-category \
--glossary=test-glossary --location=us-central1 \
--project=test-project \
--parent='projects/test-project/locations/us-central1/glossaries\
/test-glossary' --description='test description' \
--display-name='displayName'
POSITIONAL ARGUMENTS
Glossary category resource - Arguments and flags that define the Dataplex
Glossary Category you want to create. 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_category 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_CATEGORY
ID of the glossary category or fully qualified identifier for the
glossary category.
To set the glossary_category attribute:
▸ provide the argument glossary_category on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--glossary=GLOSSARY
The name of glossary category to use.
To set the glossary attribute:
▸ provide the argument glossary_category on the command line with a
fully specified name;
▸ provide the argument --glossary on the command line.
--location=LOCATION
The location of the Dataplex resource.
To set the location attribute:
▸ provide the argument glossary_category on the command line with a
fully specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
REQUIRED FLAGS
--parent=PARENT
Immediate parent of the created glossary category.
OPTIONAL FLAGS
--description=DESCRIPTION
Description of the glossary category.
--display-name=DISPLAY_NAME
Display name of the glossary category.
--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, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
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.
NOTES
This variant is also available:
$ gcloud alpha dataplex glossaries categories create

View file

@ -0,0 +1,75 @@
NAME
gcloud dataplex glossaries categories delete - deletes a glossary category
SYNOPSIS
gcloud dataplex glossaries categories delete
(GLOSSARY_CATEGORY : --glossary=GLOSSARY --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Deletes a glossary category.
EXAMPLES
To delete glossary category test-category in glossary test-glossary in
project test-project in location us-central1, run: $ gcloud dataplex glossaries categories delete test-category \
--glossary=test-glossary --location=us-central1 \
--project=test-project
POSITIONAL ARGUMENTS
Glossary category resource - Arguments and flags that define the glossary
category you want to delete. 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_category 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_CATEGORY
ID of the glossary category or fully qualified identifier for the
glossary category.
To set the glossary_category attribute:
▸ provide the argument glossary_category on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--glossary=GLOSSARY
Identifier of the Dataplex Glossary resource.
To set the glossary attribute:
▸ provide the argument glossary_category on the command line with a
fully specified name;
▸ provide the argument --glossary on the command line.
--location=LOCATION
Location of the Dataplex resource.
To set the location attribute:
▸ provide the argument glossary_category on the command line with a
fully specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
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 glossaries categories delete

View file

@ -0,0 +1,76 @@
NAME
gcloud dataplex glossaries categories describe - describes a glossary
category
SYNOPSIS
gcloud dataplex glossaries categories describe
(GLOSSARY_CATEGORY : --glossary=GLOSSARY --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describes a glossary category.
EXAMPLES
To describe a glossary category test-category in glossary test-glossary in
project test-project in loaction us-central1, run: $ gcloud dataplex glossaries categories describe test-category \
--glossary=test-glossary --location=us-central1 \
--project=test-project
POSITIONAL ARGUMENTS
Glossary category resource - Arguments and flags that define the glossary
category 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_category 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_CATEGORY
ID of the glossary category or fully qualified identifier for the
glossary category.
To set the glossary_category attribute:
▸ provide the argument glossary_category on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--glossary=GLOSSARY
Identifier of the Dataplex Glossary resource.
To set the glossary attribute:
▸ provide the argument glossary_category on the command line with a
fully specified name;
▸ provide the argument --glossary on the command line.
--location=LOCATION
Location of the Dataplex resource.
To set the location attribute:
▸ provide the argument glossary_category on the command line with a
fully specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
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 glossaries categories describe

View file

@ -0,0 +1,38 @@
NAME
gcloud dataplex glossaries categories - manage Dataplex glossary categories
SYNOPSIS
gcloud dataplex glossaries categories COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
A glossary category represents a collection of glossary categories and
glossary terms within a glossary that are related to each other.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Creates a glossary category.
delete
Deletes a glossary category.
describe
Describes a glossary category.
list
List glossary categories.
update
Updates a glossary category.
NOTES
This variant is also available:
$ gcloud alpha dataplex glossaries categories

View file

@ -0,0 +1,101 @@
NAME
gcloud dataplex glossaries categories list - list glossary categories
SYNOPSIS
gcloud dataplex glossaries categories list
(--glossary=GLOSSARY : --location=LOCATION) [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List glossary categories.
EXAMPLES
To list glossary categories in glossary test-glossary in location
us-central1 in project test-project, run :
$ gcloud dataplex glossaries categories list \
--glossary=test-glossary --location=us-central1 \
--project=test-project
REQUIRED FLAGS
Glossary resource - Arguments and flags that define the glossary in which
to list glossary categories. 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 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=GLOSSARY
ID of the glossary or fully qualified identifier for the glossary.
To set the glossary attribute:
▸ provide the argument --glossary on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
Location of the Dataplex resource.
To set the location attribute:
▸ provide the argument --glossary on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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 glossaries categories list

View file

@ -0,0 +1,104 @@
NAME
gcloud dataplex glossaries categories update - updates a glossary category
SYNOPSIS
gcloud dataplex glossaries categories update
(GLOSSARY_CATEGORY : --glossary=GLOSSARY --location=LOCATION)
[--description=DESCRIPTION] [--display-name=DISPLAY_NAME]
[--labels=[KEY=VALUE,...]] [--parent=PARENT] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Updates a glossary category.
EXAMPLES
To update display name, desciption and labels of glossary category
test-category in glossary test-glossary in project test-project in location
us-central1, run:
$ gcloud dataplex glossaries categories update test-category \
--location=us-central1 --project=test-project \
--glossary=test-glossary --description='updated description' \
--display-name='updated displayName' \
--labels=key1=value1,key2=value2
To update parent of glossary category test-category in glossary
test-glossary in project test-project in location us-central1, run:
$ gcloud dataplex glossaries categories update test-category \
--location=us-central1 --project=test-project \
--glossary=test-glossary \
--parent='projects/test-project/locations/us-central1/glossaries\
/updated-glossary'
POSITIONAL ARGUMENTS
Glossary category resource - Arguments and flags that define the Dataplex
Glossary Category you want to update. 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_category 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_CATEGORY
ID of the glossary category or fully qualified identifier for the
glossary category.
To set the glossary_category attribute:
▸ provide the argument glossary_category on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--glossary=GLOSSARY
The name of glossary category to use.
To set the glossary attribute:
▸ provide the argument glossary_category on the command line with a
fully specified name;
▸ provide the argument --glossary on the command line.
--location=LOCATION
The location of the Dataplex resource.
To set the location attribute:
▸ provide the argument glossary_category on the command line with a
fully specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
FLAGS
--description=DESCRIPTION
Description of the glossary category.
--display-name=DISPLAY_NAME
Display Name of the glossary category.
--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, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
--parent=PARENT
Immediate parent of the created glossary category.
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.
NOTES
This variant is also available:
$ gcloud alpha dataplex glossaries categories update

View file

@ -0,0 +1,90 @@
NAME
gcloud dataplex glossaries create - create a Dataplex Glossary resource
SYNOPSIS
gcloud dataplex glossaries create (GLOSSARY : --location=LOCATION)
[--description=DESCRIPTION] [--display-name=DISPLAY_NAME]
[--labels=[KEY=VALUE,...]] [--async | --validate-only]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
A Glossary represents a collection of Categories and Terms.
EXAMPLES
To create a Glossary test-glossary in project test-dataplex at location
us-central1, with description test description and displayName displayName
, run:
$ gcloud dataplex glossaries create test-glossary \
--location=us-central1 --project=test-dataplex \
--description='test description' --display-name='displayName'
POSITIONAL ARGUMENTS
Glossary resource - Arguments and flags that define the Dataplex Glossary
you want to create. 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 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
ID of the glossary or fully qualified identifier for the glossary.
To set the glossary attribute:
▸ provide the argument glossary on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location of the Dataplex resource.
To set the location attribute:
▸ provide the argument glossary on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
FLAGS
--description=DESCRIPTION
Description of the Glossary.
--display-name=DISPLAY_NAME
Display Name of the Glossary.
--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, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
At most one of these can be specified:
--async
Return immediately, without waiting for the operation in progress to
complete.
--validate-only
Validate the create action, but don't actually perform it.
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.
NOTES
This variant is also available:
$ gcloud alpha dataplex glossaries create

View file

@ -0,0 +1,72 @@
NAME
gcloud dataplex glossaries delete - delete a Dataplex Glossary
SYNOPSIS
gcloud dataplex glossaries delete (GLOSSARY : --location=LOCATION)
[--async] [--etag=ETAG] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete a Dataplex Glossary.
EXAMPLES
To Delete Glossary test-glossary in project test-dataplex at location
us-central1, run: $ gcloud dataplex glossaries delete test-glossary \
--location=us-central1 --project=test-dataplex
POSITIONAL ARGUMENTS
Glossary resource - Arguments and flags that define the Dataplex Glossary
you want to delete. 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 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
ID of the glossary or fully qualified identifier for the glossary.
To set the glossary attribute:
▸ provide the argument glossary on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Location of the Dataplex resource.
To set the location attribute:
▸ provide the argument glossary on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--etag=ETAG
etag value for particular Glossary.
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 glossaries delete

View file

@ -0,0 +1,67 @@
NAME
gcloud dataplex glossaries describe - describe a Glossary
SYNOPSIS
gcloud dataplex glossaries describe (GLOSSARY : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe a Glossary. Displays all details of a Glossary given a valid
Glossary ID.
EXAMPLES
To describe a Dataplex Glossary test-glossary within location us-central1
and in project test-project
$ gcloud dataplex glossaries describe test-glossary \
--location=us-central1 --project=test-project
POSITIONAL ARGUMENTS
Glossary resource - Glossary 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 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
ID of the glossary or fully qualified identifier for the glossary.
To set the glossary attribute:
▸ provide the argument glossary on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Location of the Dataplex resource.
To set the location attribute:
▸ provide the argument glossary on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
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 glossaries describe

View file

@ -0,0 +1,95 @@
NAME
gcloud dataplex glossaries get-iam-policy - retrieve a Dataplex Glossary
IAM policy
SYNOPSIS
gcloud dataplex glossaries get-iam-policy (GLOSSARY : --location=LOCATION)
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Displays the IAM policy associated with a Dataplex Glossary resource. If
formatted as JSON, the output can be edited and used as a policy file for
set-iam-policy. The output includes an "etag" field identifying the version
emitted and allowing detection of concurrent policy updates.
EXAMPLES
To get the IAM policy of a Dataplex Glossary test-glossary in project
test-project under location us-central1 $ gcloud dataplex glossaries get-iam-policy test-glossary \
--project=test-project --location=us-central1
POSITIONAL ARGUMENTS
Glossary resource - Arguments and flags that define the Dataplex Glossary
IAM policy you want to retrieve. 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 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
ID of the glossary or fully qualified identifier for the glossary.
To set the glossary attribute:
▸ provide the argument glossary on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Location of the Dataplex resource.
To set the location attribute:
▸ provide the argument glossary on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
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 glossaries get-iam-policy

View file

@ -0,0 +1,59 @@
NAME
gcloud dataplex glossaries - manage Dataplex glossaries
SYNOPSIS
gcloud dataplex glossaries GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
A Glossary represents a collection of Categories and Terms.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
categories
Manage Dataplex glossary categories.
terms
Manage Dataplex glossary terms.
COMMANDS
COMMAND is one of the following:
add-iam-policy-binding
Add IAM policy binding to a Dataplex Glossary.
create
Create a Dataplex Glossary resource.
delete
Delete a Dataplex Glossary.
describe
Describe a Glossary.
get-iam-policy
Retrieve a Dataplex Glossary IAM policy.
list
List Glossaries.
remove-iam-policy-binding
Removes IAM policy binding from a Dataplex Glossary.
set-iam-policy
Set an IAM policy binding for a Dataplex Glossary as defined in a JSON
or YAML file.
update
Updates a Dataplex Glossary.
NOTES
This variant is also available:
$ gcloud alpha dataplex glossaries

View file

@ -0,0 +1,85 @@
NAME
gcloud dataplex glossaries list - list Glossaries
SYNOPSIS
gcloud dataplex glossaries list [--location=LOCATION] [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List Glossaries.
EXAMPLES
To List Glossaries in project test-dataplex at location us-central1
$ gcloud dataplex glossaries list --location=us-central1 \
--project=test-dataplex
FLAGS
Location resource - Location in which to list Glossaries. This represents
a Cloud 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 --location on the command line with a fully
specified name;
◆ set the property dataplex/location with a fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
--location=LOCATION
ID of the location or fully qualified identifier for the location.
To set the location attribute:
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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 glossaries list

View file

@ -0,0 +1,88 @@
NAME
gcloud dataplex glossaries remove-iam-policy-binding - removes IAM policy
binding from a Dataplex Glossary
SYNOPSIS
gcloud dataplex glossaries remove-iam-policy-binding
(GLOSSARY : --location=LOCATION) --member=PRINCIPAL --role=ROLE
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Removes IAM policy binding from a Dataplex Glossary.
EXAMPLES
To remove an IAM policy binding for the role roles/dataplex.viewer for the
user test-user@gmail.com from a glossary test-glossary within projet
test-project in location us-central1, run: $ gcloud dataplex glossaries remove-iam-policy-binding \
test-glossary --project=test-project --location=us-central1 \
--role=roles/dataplex.viewer --member=user:test-user@gmail.com \
See https://cloud.google.com/dataplex/docs/iam-roles for \
details of policy role and member types.
POSITIONAL ARGUMENTS
Glossary resource - Arguments and flags that define the Dataplex Glossary
you want to remove IAM policy binding from 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 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
ID of the glossary or fully qualified identifier for the glossary.
To set the glossary attribute:
▸ provide the argument glossary on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location of the Dataplex resource.
To set the location attribute:
▸ provide the argument glossary on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
REQUIRED FLAGS
--member=PRINCIPAL
The principal to remove the binding for. Should be of the form
user|group|serviceAccount:email or domain:domain.
Examples: user:test-user@gmail.com, group:admins@example.com,
serviceAccount:test123@example.domain.com, or
domain:example.domain.com.
Deleted principals have an additional deleted: prefix and a ?uid=UID
suffix, where UID is a unique identifier for the principal. Example:
deleted:user:test-user@gmail.com?uid=123456789012345678901.
Some resources also accept the following special values:
◆ allUsers - Special identifier that represents anyone who is on the
internet, with or without a Google account.
◆ allAuthenticatedUsers - Special identifier that represents anyone
who is authenticated with a Google account or a service account.
--role=ROLE
The role to remove the principal from.
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.
NOTES
This variant is also available:
$ gcloud alpha dataplex glossaries remove-iam-policy-binding

View file

@ -0,0 +1,71 @@
NAME
gcloud dataplex glossaries set-iam-policy - set an IAM policy binding for a
Dataplex Glossary as defined in a JSON or YAML file
SYNOPSIS
gcloud dataplex glossaries set-iam-policy (GLOSSARY : --location=LOCATION)
POLICY_FILE [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
See https://cloud.google.com/iam/docs/managing-policies for details of the
policy file format and contents.
EXAMPLES
The following command will read an IAM policy defined in a JSON file
policy.json and set it for the Dataplex Glossary test-glossary within
project test-project in location us-central1: $ gcloud dataplex glossaries set-iam-policy test-glossary \
--project=test-project --location=us-central1 policy.json \
where policy.json is the relative path to the json file.
POSITIONAL ARGUMENTS
Glossary resource - Arguments and flags that define the Dataplex Glossary
you want to set IAM policy to. 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 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
ID of the glossary or fully qualified identifier for the glossary.
To set the glossary attribute:
▸ provide the argument glossary on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location of the Dataplex resource.
To set the location attribute:
▸ provide the argument glossary on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
POLICY_FILE
Path to a local JSON or YAML formatted file containing a valid policy.
The output of the get-iam-policy command is a valid file, as is any
JSON or YAML file conforming to the structure of a Policy
(https://cloud.google.com/iam/reference/rest/v1/Policy).
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.
NOTES
This variant is also available:
$ gcloud alpha dataplex glossaries set-iam-policy

View file

@ -0,0 +1,101 @@
NAME
gcloud dataplex glossaries terms create - creates a glossary term
SYNOPSIS
gcloud dataplex glossaries terms create
(GLOSSARY_TERM : --glossary=GLOSSARY --location=LOCATION)
--parent=PARENT [--description=DESCRIPTION]
[--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
A glossary term holds a rich text description that can be attached to
entries or specific columns to enrich them.
EXAMPLES
To create a glossary term test-term in glossary test-glossary in project
test-project in location us-central1, with description test description,
displayName displayName and parent
projects/test-project/locations/us-central1/glossaries/test-glossary/categories/test-category
, run:
$ gcloud dataplex glossaries terms create test-term \
--glossary=test-glossary --location=us-central1 \
--project=test-project \
--parent='projects/test-project/locations/us-central1/glossaries\
/test-glossary/categories/test-category' \
--description='test description' --display-name='displayName'
POSITIONAL ARGUMENTS
Glossary term resource - Arguments and flags that define the Dataplex
Glossary Term you want to create. 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.
--glossary=GLOSSARY
The name of glossary term to use.
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.
--location=LOCATION
The 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.
REQUIRED FLAGS
--parent=PARENT
Immediate parent of the created glossary term.
OPTIONAL FLAGS
--description=DESCRIPTION
Description of the glossary term.
--display-name=DISPLAY_NAME
Display name of the glossary term.
--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, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
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.
NOTES
This variant is also available:
$ gcloud alpha dataplex glossaries terms create

View file

@ -0,0 +1,77 @@
NAME
gcloud dataplex glossaries terms delete - deletes a glossary term
SYNOPSIS
gcloud dataplex glossaries terms delete
(GLOSSARY_TERM : --glossary=GLOSSARY --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Deletes a glossary term.
EXAMPLES
To delete the glossary term test-term in glossary test-glossary in project
test-project in location us-central1, run:
$ gcloud dataplex glossaries terms delete 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 delete. 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.
--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.
--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.
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 glossaries terms delete

View file

@ -0,0 +1,77 @@
NAME
gcloud dataplex glossaries terms describe - describes a glossary term
SYNOPSIS
gcloud dataplex glossaries terms describe
(GLOSSARY_TERM : --glossary=GLOSSARY --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describes a glossary term.
EXAMPLES
To describe the glossary term test-term in glossary test-glossary in
project test-project in loaction us-central1, run:
$ gcloud 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.
--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.
--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.
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 glossaries terms describe

View file

@ -0,0 +1,39 @@
NAME
gcloud dataplex glossaries terms - manage Dataplex glossary terms
SYNOPSIS
gcloud dataplex glossaries terms COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Glossary terms are the core of a Dataplex glossary. A glossary term holds a
rich text description that can be attached to entries or specific columns
to enrich them.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Creates a glossary term.
delete
Deletes a glossary term.
describe
Describes a glossary term.
list
List glossary terms.
update
Updates a glossary term.
NOTES
This variant is also available:
$ gcloud alpha dataplex glossaries terms

View file

@ -0,0 +1,100 @@
NAME
gcloud dataplex glossaries terms list - list glossary terms
SYNOPSIS
gcloud dataplex glossaries terms list
(--glossary=GLOSSARY : --location=LOCATION) [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List glossary terms.
EXAMPLES
To list glossary terms in glossary test-glossary in project test-project in
location us-central1, run :
$ gcloud dataplex glossaries terms list --glossary=test-glossary \
--location=us-central1 --project=test-project
REQUIRED FLAGS
Glossary resource - Arguments and flags that define the glossary in which
to list glossary terms. 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 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=GLOSSARY
ID of the glossary or fully qualified identifier for the glossary.
To set the glossary attribute:
▸ provide the argument --glossary on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
Location of the Dataplex resource.
To set the location attribute:
▸ provide the argument --glossary on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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 glossaries terms list

View file

@ -0,0 +1,104 @@
NAME
gcloud dataplex glossaries terms update - updates a glossary term
SYNOPSIS
gcloud dataplex glossaries terms update
(GLOSSARY_TERM : --glossary=GLOSSARY --location=LOCATION)
[--description=DESCRIPTION] [--display-name=DISPLAY_NAME]
[--labels=[KEY=VALUE,...]] [--parent=PARENT] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Updates a glossary term.
EXAMPLES
To update display name, desciption and labels of glossary term test-term in
glossary test-glossary in project test-project in location us-central1,
run:
$ gcloud dataplex glossaries terms update test-term \
--location=us-central1 --project=test-project \
--glossary=test-glossary --description='updated description' \
--display-name='updated displayName' \
--labels=key1=value1,key2=value2
To update parent of glossary term test-term in glossary test-glossary in
project test-project in location us-central1, run:
$ gcloud dataplex glossaries terms update test-term \
--location=us-central1 --project=test-project \
--glossary=test-glossary \
--parent='projects/test-project/locations/us-central1/glossaries\
/updated-glossary'
POSITIONAL ARGUMENTS
Glossary term resource - Arguments and flags that define the Dataplex
Glossary Term you want to update. 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.
--glossary=GLOSSARY
The name of glossary term to use.
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.
--location=LOCATION
The 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.
FLAGS
--description=DESCRIPTION
Description of the glossary term.
--display-name=DISPLAY_NAME
Display name of the glossary term.
--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, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
--parent=PARENT
Immediate parent of the created glossary term.
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.
NOTES
This variant is also available:
$ gcloud alpha dataplex glossaries terms update

View file

@ -0,0 +1,91 @@
NAME
gcloud dataplex glossaries update - updates a Dataplex Glossary
SYNOPSIS
gcloud dataplex glossaries update (GLOSSARY : --location=LOCATION)
[--description=DESCRIPTION] [--display-name=DISPLAY_NAME] [--etag=ETAG]
[--labels=[KEY=VALUE,...]] [--async | --validate-only]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Updates a Dataplex Glossary.
EXAMPLES
To update Glossary test-glossary in project test-dataplex at location
us-central1, with description updated description and displayName
displayName $ gcloud dataplex glossaries update test-glossary \
--location=us-central1 --project test-dataplex \
--description='updated description'
POSITIONAL ARGUMENTS
Glossary resource - Arguments and flags that define the Dataplex Glossary
you want to update. 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 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
ID of the glossary or fully qualified identifier for the glossary.
To set the glossary attribute:
▸ provide the argument glossary on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location of the Dataplex resource.
To set the location attribute:
▸ provide the argument glossary on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
FLAGS
--description=DESCRIPTION
Description of the Glossary.
--display-name=DISPLAY_NAME
Display Name of the Glossary.
--etag=ETAG
etag value for particular Glossary.
--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, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
At most one of these can be specified:
--async
Return immediately, without waiting for the operation in progress to
complete.
--validate-only
Validate the update action, but don't actually perform it.
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.
NOTES
This variant is also available:
$ gcloud alpha dataplex glossaries update