gcloud-help/gcloud/alpha/data-catalog/entries/update

NAME
    gcloud alpha data-catalog entries update - update a Data Catalog entry

SYNOPSIS
    gcloud alpha data-catalog entries update
        [ENTRY : --entry-group=ENTRY_GROUP --location=LOCATION]
        [--description=DESCRIPTION] [--display-name=DISPLAY_NAME]
        [--lookup-entry=RESOURCE]
        [--add-file-patterns=[PATTERN,...] --clear-file-patterns
          | --remove-file-patterns=[PATTERN,...]]
        [--schema=[COLUMN_NAME=COLUMN_TYPE,...]
          | --schema-from-file=SCHEMA_FROM_FILE] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    (ALPHA) Update a Data Catalog entry. The entry to update can either be
    specified directly, or the --lookup-entry flag may be used to update the
    entry corresponding to the lookup of the given resource.

EXAMPLES
    To update the schema of a Cloud Pub/Sub entry inline, run:

        $ gcloud alpha data-catalog entries update entry1 \
            --location=global --entry-group=@pubsub \
            --schema="column1=type1,column2=type2"

    To update the schema of a Cloud Pub/Sub entry from a file, run:

        $ gcloud alpha data-catalog entries update entry1 \
            --location=global --entry-group=@pubsub \
            --schema-from-file="/tmp/schema.json"

    To lookup the entry of a Cloud Pub/Sub topic by its SQL name and update its
    schema in one command, run:

        $ gcloud alpha data-catalog entries update \
            --lookup-entry='pubsub.topic.`my-project1`.topic1' \
            --schema="column1=type1,column2=type2"

POSITIONAL ARGUMENTS
     Entry resource - Entry 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 entry on the command line with a fully specified
        name;
      ◆ set the property core/project;
      ◆ provide the argument --project on the command line.

       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.

       --entry-group=ENTRY_GROUP
          Entry group of the entry.

          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.

       --location=LOCATION
          Location of the entry.

          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.

FLAGS
     --description=DESCRIPTION
        Textual description of the entry.

     --display-name=DISPLAY_NAME
        Human-readable name for the entry.

     --lookup-entry=RESOURCE
        The name of the target resource whose entry to update. This can be
        either the Google Cloud Platform resource name or the SQL name of a
        Google Cloud Platform resource. This flag allows one to update the
        entry corresponding to the lookup of the given resource, without
        needing to specify the entry directly.

     --add-file-patterns=[PATTERN,...]
        A list of file patterns to add to the current list.

     At most one of these can be specified:

       --clear-file-patterns
          If specified, clear the current list of file patterns.

       --remove-file-patterns=[PATTERN,...]
          A list of file patterns to remove from the current list.

     New column schema for the entry. A schema consists of a list of column
     names along with their types, descriptions, modes, and nested subcolumns.
     For example:

         - column: first_name
           description: First name
           mode: REQUIRED
           type: STRING
         - column: last_name
           description: Last name
           mode: REQUIRED
           type: STRING
         - column: addresses
           description: Addresses
           mode: REPEATED
           type: RECORD
           subcolumns:
           - column: city
             description: City
             mode: NULLABLE
             type: STRING
           - column: state
             description: State
             mode: NULLABLE
             type: STRING

    At most one of these can be specified:

         --schema=[COLUMN_NAME=COLUMN_TYPE,...]
            Inline schema for the entry. When specifying a schema via this
            argument, only column names and types should be provided. Column
            modes will default to NULLABLE, and column descriptions and nested
            subcolumns are not supported.

         --schema-from-file=SCHEMA_FROM_FILE
            Path to a JSON or YAML file containing the schema for the entry.
            This can be used to specify schemas with column descriptions,
            column modes other than NULLABLE, and nested subcolumns.

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 entries update

        $ gcloud beta data-catalog entries update