- NAME
-
- gcloud alpha data-catalog tag-templates fields update - update a Data Catalog tag template field
- SYNOPSIS
-
-
gcloud alpha data-catalog tag-templates fields update
(FIELD
:--location
=LOCATION
--tag-template
=TAG_TEMPLATE
) [--display-name
=DISPLAY_NAME
] [--enum-values
=[ENUM_VALUES
,…]] [--required
] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
(DEPRECATED)
This command is deprecated. Please usegcloud dataplex aspect-types
instead.Update a Data Catalog tag template field.
- EXAMPLES
-
Update the display name of a tag template field:
gcloud alpha data-catalog tag-templates fields update FIELD --display-name=NAME
Set tag template enum field values to be 'A' and 'B':
gcloud alpha data-catalog tag-templates fields update FIELD --enum-values=A,B
Set a tag template field to be optional:
gcloud alpha data-catalog tag-templates fields update FIELD --no-required
- POSITIONAL ARGUMENTS
-
-
Tag template field resource - Tag template field 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
field
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.
FIELD
-
ID of the tag template field or fully qualified identifier for the tag template
field.
To set the
field
attribute:-
provide the argument
field
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location
=LOCATION
-
Location of the tag template field.
To set the
location
attribute:-
provide the argument
field
on the command line with a fully specified name; -
provide the argument
--location
on the command line.
-
provide the argument
--tag-template
=TAG_TEMPLATE
-
Tag template of the tag template field.
To set the
tag-template
attribute:-
provide the argument
field
on the command line with a fully specified name; -
provide the argument
--tag-template
on the command line.
-
provide the argument
-
provide the argument
-
Tag template field resource - Tag template field 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.
- FLAGS
-
--display-name
=DISPLAY_NAME
- Display name of the tag template field.
--enum-values
=[ENUM_VALUES
,…]-
Comma-separated list of enum values. The list of enum values passed with this
flag replaces the existing one in tag template enum field. That means:
- the enum values passed to the flag and not present in tag template enum field get created
- the enum values present in tag template enum field and missing in the list get removed
- the order of the items on the list is preserved
Enum values can only be removed from optional enum fields for now.
--required
- Indicates if the tag template field is required. Updating from FALSE (optional) to TRUE (required) is NOT allowed.
- 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
datacatalog/v1beta1
API. The full documentation for this API can be found at: https://cloud.google.com/data-catalog/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. These variants are also available:
gcloud data-catalog tag-templates fields update
gcloud beta data-catalog tag-templates fields update
gcloud alpha data-catalog tag-templates fields update
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-03-04 UTC.