Updates an existing entry. Users should enable the Data Catalog API in the project identified by the entry.name
parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
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-beta1 --scope <scope> projects locations-entry-groups-entries-patch ...
Required Scalar Argument
- <name> (string)
- Output only. The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this 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:
GoogleCloudDatacatalogV1beta1Entry:
bigquery-date-sharded-spec:
dataset: string
shard-count: int64
table-prefix: string
bigquery-table-spec:
table-source-type: string
table-spec:
grouped-entry: string
view-spec:
view-query: string
description: string
display-name: string
gcs-fileset-spec:
file-patterns: [string]
integrated-system: string
linked-resource: string
name: string
source-system-timestamps:
create-time: string
expire-time: string
update-time: string
type: string
usage-signal:
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=labore
- 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}
.
- Output only. The Data Catalog resource name of the dataset entry the current table belongs to, for example,
shard-count=-43
- Output only. Total number of shards.
-
table-prefix=duo
- Output only. The table name prefix of the shards. The name of any given shard is
[table_prefix]YYYYMMDD
, for example, for shardMyTable20180101
, thetable_prefix
isMyTable
.
- Output only. The table name prefix of the shards. The name of any given shard is
-
..bigquery-table-spec table-source-type=sed
- Output only. The table source type.
-
table-spec grouped-entry=no
- Output only. If the table is a dated shard, i.e., with name pattern
[prefix]YYYYMMDD
,grouped_entry
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.
- Output only. If the table is a dated shard, i.e., with name pattern
-
..view-spec view-query=stet
- Output only. The query that defines the table view.
-
... description=kasd
- Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.
display-name=et
- Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.
-
gcs-fileset-spec file-patterns=sed
- Required. Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: *
gs://bucket_name/dir/*
: matches all files withinbucket_name/dir
directory. *gs://bucket_name/dir/**
: matches all files inbucket_name/dir
spanning all subdirectories. *gs://bucket_name/file*
: matches files prefixed byfile
inbucket_name
*gs://bucket_name/??.txt
: matches files with two characters followed by.txt
inbucket_name
*gs://bucket_name/[aeiou].txt
: matches files that contain a single vowel character followed by.txt
inbucket_name
*gs://bucket_name/[a-m].txt
: matches files that containa
,b
, ... orm
followed by.txt
inbucket_name
*gs://bucket_name/a/*/b
: matches all files inbucket_name
that matcha/*/b
pattern, such asa/c/b
,a/d/b
*gs://another_bucket/a.txt
: matchesgs://another_bucket/a.txt
You can combine wildcards to provide more powerful matches, for example: *gs://bucket_name/[a-m]??.j*g
- Each invocation of this argument appends the given value to the array.
- Required. Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: *
-
.. integrated-system=et
- Output only. This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
linked-resource=et
- The resource this metadata entry refers to. For Google Cloud Platform resources,
linked_resource
is the full name of the resource. For example, thelinked_resource
for a table resource from BigQuery is: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.
- The resource this metadata entry refers to. For Google Cloud Platform resources,
name=vero
- Output only. The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.
source-system-timestamps create-time=erat
- The creation time of the resource within the given system.
expire-time=sed
- Output only. The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources.
-
update-time=duo
- The last-modified time of the resource within the given system.
-
.. type=dolore
- The type of the entry. Only used for Entries with types in the EntryType enum.
-
usage-signal update-time=et
- The timestamp of the end of the usage statistics duration.
-
.. user-specified-system=voluptua.
- This field indicates the entry's source system that Data Catalog does not integrate with.
user_specified_system
strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.
- This field indicates the entry's source system that Data Catalog does not integrate with.
user-specified-type=amet.
- Entry type if it does not fit any of the input-allowed values listed in
EntryType
enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type".user_specified_type
strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must useuser_specified_type
.
- Entry type if it does not fit any of the input-allowed values listed in
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.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
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. The following fields are modifiable: * For entries with type
DATA_STREAM
: *schema
* For entries with typeFILESET
: *schema
*display_name
*description
*gcs_fileset_spec
*gcs_fileset_spec.file_patterns
* For entries withuser_specified_type
: *schema
*display_name
*description
*user_specified_type
*user_specified_system
*linked_resource
*source_system_timestamps
- 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. The following fields are modifiable: * For entries with type
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").