Updates an existing entry. You must enable the Data Catalog API in the project identified by the entry.name parameter. For more information, see Data Catalog resource project.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: datacatalog1 --scope <scope> projects locations-entry-groups-entries-patch ...

Required Scalar Argument

• <name> (string)
  • Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudDatacatalogV1Entry:
  bigquery-date-sharded-spec:
    dataset: string
    latest-shard-resource: string
    shard-count: int64
    table-prefix: string
  bigquery-table-spec:
    table-source-type: string
    table-spec:
      grouped-entry: string
    view-spec:
      view-query: string
  business-context:
    entry-overview:
      overview: string
  cloud-bigtable-system-spec:
    instance-display-name: string
  data-source:
    resource: string
    service: string
    source-entry: string
    storage-properties:
      file-pattern: [string]
      file-type: string
  data-source-connection-spec:
    bigquery-connection-spec:
      cloud-sql:
        database: string
        instance-id: string
        type: string
      connection-type: string
      has-credential: boolean
  database-table-spec:
    database-view-spec:
      base-table: string
      sql-query: string
      view-type: string
    dataplex-table:
      dataplex-spec:
        asset: string
        compression-format: string
        data-format:
          avro:
            text: string
          protobuf:
            text: string
          thrift:
            text: string
        project-id: string
      user-managed: boolean
    type: string
  dataset-spec:
    vertex-dataset-spec:
      data-item-count: int64
      data-type: string
  description: string
  display-name: string
  feature-online-store-spec:
    storage-type: string
  fileset-spec:
    dataplex-fileset:
      dataplex-spec:
        asset: string
        compression-format: string
        data-format:
          avro:
            text: string
          protobuf:
            text: string
          thrift:
            text: string
        project-id: string
  fully-qualified-name: string
  gcs-fileset-spec:
    file-patterns: [string]
  integrated-system: string
  labels: { string: string }
  linked-resource: string
  looker-system-spec:
    parent-instance-display-name: string
    parent-instance-id: string
    parent-model-display-name: string
    parent-model-id: string
    parent-view-display-name: string
    parent-view-id: string
  model-spec:
    vertex-model-spec:
      container-image-uri: string
      version-aliases: [string]
      version-description: string
      version-id: string
      vertex-model-source-info:
        copy: boolean
        source-type: string
  name: string
  personal-details:
    star-time: string
    starred: boolean
  routine-spec:
    bigquery-routine-spec:
      imported-libraries: [string]
    definition-body: string
    language: string
    return-type: string
    routine-type: string
  source-system-timestamps:
    create-time: string
    expire-time: string
    update-time: string
  sql-database-system-spec:
    database-version: string
    instance-host: string
    sql-engine: string
  type: string
  usage-signal:
    favorite-count: int64
    update-time: string
  user-specified-system: string
  user-specified-type: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r .bigquery-date-sharded-spec dataset=ipsum
  • Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example: projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}.
• latest-shard-resource=et
  • Output only. BigQuery resource name of the latest shard.
• shard-count=-8
  • Output only. Total number of shards.

• table-prefix=lorem

  • Output only. The table name prefix of the shards. The name of any given shard is [table_prefix]YYYYMMDD. For example, for the MyTable20180101 shard, the table_prefix is MyTable.

• ..bigquery-table-spec table-source-type=est

  • Output only. The table source type.

• table-spec grouped-entry=sed

  • Output only. If the table is date-sharded, that is, it matches the [prefix]YYYYMMDD name pattern, this field is the Data Catalog resource name of the date-sharded grouped entry. For example: projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}. Otherwise, grouped_entry is empty.

• ..view-spec view-query=diam

  • Output only. The query that defines the table view.

• ...business-context.entry-overview overview=dolores

  • Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.

• ...cloud-bigtable-system-spec instance-display-name=dolores

  • Display name of the Instance. This is user specified and different from the resource name.

• ..data-source resource=et

  • Full name of a resource as defined by the service. For example: //bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}
• service=sed
  • Service that physically stores the data.
• source-entry=no
  • Output only. Data Catalog entry name, if applicable.
• storage-properties file-pattern=et
  • Patterns to identify a set of files for this fileset. Examples of a valid file_pattern: * gs://bucket_name/dir/*: matches all files in the bucket_name/dir directory * gs://bucket_name/dir/**: matches all files in the bucket_name/dir and all subdirectories recursively * gs://bucket_name/file*: matches files prefixed by file in bucket_name * gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name * gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name * gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name * gs://bucket_name/a/*/b: matches all files in bucket_name that match the a/*/b pattern, such as a/c/b, a/d/b * gs://another_bucket/a.txt: matches gs://another_bucket/a.txt
  • Each invocation of this argument appends the given value to the array.

• file-type=elitr

  • File type in MIME format, for example, text/plain.

• ...data-source-connection-spec.bigquery-connection-spec.cloud-sql database=sed

  • Database name.
• instance-id=no
  • Cloud SQL instance ID in the format of project:location:instance.

• type=nonumy

  • Type of the Cloud SQL database.

• .. connection-type=at

  • The type of the BigQuery connection.

• has-credential=true

  • True if there are credentials attached to the BigQuery connection; false otherwise.

• ...database-table-spec.database-view-spec base-table=aliquyam

  • Name of a singular table this view reflects one to one.
• sql-query=dolores
  • SQL query used to generate this view.

• view-type=sadipscing

  • Type of this view.

• ..dataplex-table.dataplex-spec asset=erat

  • Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached.
• compression-format=aliquyam
  • Compression format of the data, e.g., zip, gzip etc.

• data-format.avro text=amet

  • JSON source of the Avro schema.

• ..protobuf text=est

  • Protocol buffer source of the schema.

• ..thrift text=et

  • Thrift IDL source of the schema.

• ... project-id=sea

  • Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset.

• .. user-managed=false

  • Indicates if the table schema is managed by the user or not.

• .. type=consetetur

  • Type of this table.

• ..dataset-spec.vertex-dataset-spec data-item-count=-65

  • The number of DataItems in this Dataset. Only apply for non-structured Dataset.

• data-type=est

  • Type of the dataset.

• ... description=aliquyam

  • Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string.
• display-name=elitr
  • Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.

• feature-online-store-spec storage-type=duo

  • Output only. Type of underelaying storage for the FeatureOnlineStore.

• ..fileset-spec.dataplex-fileset.dataplex-spec asset=diam

  • Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached.
• compression-format=est
  • Compression format of the data, e.g., zip, gzip etc.

• data-format.avro text=sit

  • JSON source of the Avro schema.

• ..protobuf text=sed

  • Protocol buffer source of the schema.

• ..thrift text=eos

  • Thrift IDL source of the schema.

• ... project-id=lorem

  • Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset.

• .... fully-qualified-name=ea

  • Fully Qualified Name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries.

• gcs-fileset-spec file-patterns=stet

  • Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note: Currently, bucket wildcards are not supported. Examples of valid file_patterns: * gs://bucket_name/dir/*: matches all files in bucket_name/dir directory * gs://bucket_name/dir/**: matches all files in bucket_name/dir and all subdirectories * gs://bucket_name/file*: matches files prefixed by file in bucket_name * gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name * gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name * gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name * gs://bucket_name/a/*/b: matches all files in bucket_name that match the a/*/b pattern, such as a/c/b, a/d/b * gs://another_bucket/a.txt: matches gs://another_bucket/a.txt You can combine wildcards to match complex sets of files, for example: gs://bucket_name/[a-m]??.j*g
  • Each invocation of this argument appends the given value to the array.

• .. integrated-system=dolores

  • Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
• labels=key=eos
  • Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.
  • the value will be associated with the given key
• linked-resource=et
  • The resource this metadata entry refers to. For Google Cloud Platform resources, linked_resource is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the linked_resource for a table resource from BigQuery is: //bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID} Output only when the entry is one of the types in the EntryType enum. For entries with a user_specified_type, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8.
• looker-system-spec parent-instance-display-name=sea
  • Name of the parent Looker Instance. Empty if it does not exist.
• parent-instance-id=et
  • ID of the parent Looker Instance. Empty if it does not exist. Example value: someinstance.looker.com
• parent-model-display-name=at
  • Name of the parent Model. Empty if it does not exist.
• parent-model-id=dolore
  • ID of the parent Model. Empty if it does not exist.
• parent-view-display-name=eirmod
  • Name of the parent View. Empty if it does not exist.

• parent-view-id=lorem

  • ID of the parent View. Empty if it does not exist.

• ..model-spec.vertex-model-spec container-image-uri=accusam

  • URI of the Docker image to be used as the custom container for serving predictions.
• version-aliases=amet
  • User provided version aliases so that a model version can be referenced via alias
  • Each invocation of this argument appends the given value to the array.
• version-description=erat
  • The description of this version.
• version-id=dolores
  • The version ID of the model.
• vertex-model-source-info copy=false
  • If this Model is copy of another Model. If true then source_type pertains to the original.

• source-type=accusam

  • Type of the model source.

• .... name=sea

  • Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name.
• personal-details star-time=takimata
  • Set if the entry is starred; unset otherwise.

• starred=true

  • True if the entry is starred by the user; false otherwise.

• ..routine-spec.bigquery-routine-spec imported-libraries=et

  • Paths of the imported libraries.
  • Each invocation of this argument appends the given value to the array.

• .. definition-body=at

  • The body of the routine.
• language=dolor
  • The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are: * SQL * JAVASCRIPT
• return-type=et
  • Return type of the argument. The exact value depends on the source system and the language.

• routine-type=sit

  • The type of the routine.

• ..source-system-timestamps create-time=erat

  • Creation timestamp of the resource within the given system.
• expire-time=sea
  • Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.

• update-time=nonumy

  • Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.

• ..sql-database-system-spec database-version=et

  • Version of the database engine.
• instance-host=gubergren
  • Host of the SQL database enum InstanceHost { UNDEFINED = 0; SELF_HOSTED = 1; CLOUD_SQL = 2; AMAZON_RDS = 3; AZURE_SQL = 4; } Host of the enclousing database instance.

• sql-engine=justo

  • SQL Database Engine. enum SqlEngine { UNDEFINED = 0; MY_SQL = 1; POSTGRE_SQL = 2; SQL_SERVER = 3; } Engine of the enclosing database instance.

• .. type=sea

  • The type of the entry. For details, see EntryType.
• usage-signal favorite-count=-96
  • Favorite count in the source system.

• update-time=sit

  • The end timestamp of the duration of usage statistics.

• .. user-specified-system=aliquyam

  • Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The user_specified_system string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long.
• user-specified-type=eos
  • Custom entry type that doesn't match any of the values allowed for input and listed in the EntryType enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, my_special_type. The user_specified_type string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p update-mask=string
  • Names of fields whose values to overwrite on an entry. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. You can modify only the fields listed below. For entries with type DATA_STREAM: * schema For entries with type FILESET: * schema * display_name * description * gcs_fileset_spec * gcs_fileset_spec.file_patterns For entries with user_specified_type: * schema * display_name * description * user_specified_type * user_specified_system * linked_resource * source_system_timestamps

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").