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

gcloud/alpha/dataplex/glossaries/terms/create

@@ -0,0 +1,104 @@
+NAME
+    gcloud alpha dataplex glossaries terms create - creates a glossary term
+
+SYNOPSIS
+    gcloud alpha 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
+    (ALPHA) 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 alpha 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 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 create
+

gcloud/alpha/dataplex/glossaries/terms/delete

@@ -0,0 +1,80 @@
+NAME
+    gcloud alpha dataplex glossaries terms delete - deletes a glossary term
+
+SYNOPSIS
+    gcloud alpha dataplex glossaries terms delete
+        (GLOSSARY_TERM : --glossary=GLOSSARY --location=LOCATION)
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) 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 alpha 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 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 delete
+

gcloud/alpha/dataplex/glossaries/terms/describe

@@ -0,0 +1,80 @@
+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 glossary test-glossary in
+    project test-project in loaction us-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.
+
+       --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 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/help

@@ -0,0 +1,42 @@
+NAME
+    gcloud alpha dataplex glossaries terms - manage Dataplex glossary terms
+
+SYNOPSIS
+    gcloud alpha dataplex glossaries terms COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) 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
+        (ALPHA) Creates a glossary term.
+
+     delete
+        (ALPHA) Deletes a glossary term.
+
+     describe
+        (ALPHA) Describes a glossary term.
+
+     list
+        (ALPHA) List glossary terms.
+
+     update
+        (ALPHA) Updates a glossary term.
+
+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
+

gcloud/alpha/dataplex/glossaries/terms/list

@@ -0,0 +1,104 @@
+NAME
+    gcloud alpha dataplex glossaries terms list - list glossary terms
+
+SYNOPSIS
+    gcloud alpha dataplex glossaries terms list
+        (--glossary=GLOSSARY : --location=LOCATION) [--filter=EXPRESSION]
+        [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) List glossary terms.
+
+EXAMPLES
+    To list glossary terms in glossary test-glossary in project test-project in
+    location us-central1, run :
+
+        $ gcloud alpha 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 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 list
+

gcloud/alpha/dataplex/glossaries/terms/update

@@ -0,0 +1,107 @@
+NAME
+    gcloud alpha dataplex glossaries terms update - updates a glossary term
+
+SYNOPSIS
+    gcloud alpha 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
+    (ALPHA) 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 alpha 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 alpha 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 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 update
+