Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Entry
- Inherits:
-
Object
- Object
- Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Entry
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/datacatalog_v1beta1/classes.rb,
generated/google/apis/datacatalog_v1beta1/representations.rb,
generated/google/apis/datacatalog_v1beta1/representations.rb
Overview
Entry Metadata.
A Data Catalog Entry resource represents another resource in Google
Cloud Platform (such as a BigQuery dataset or a Cloud Pub/Sub topic), or
outside of Google Cloud Platform. Clients can use the linked_resource
field
in the Entry resource to refer to the original resource ID of the source
system.
An Entry resource contains resource details, such as its schema. An Entry can
also be used to attach flexible metadata, such as a
Tag.
Instance Attribute Summary collapse
-
#bigquery_date_sharded_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpec
Spec for a group of BigQuery tables with name pattern
[prefix]YYYYMMDD
. -
#bigquery_table_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1BigQueryTableSpec
Describes a BigQuery table.
-
#description ⇒ String
Entry description, which can consist of several sentences or paragraphs that describe entry contents.
-
#display_name ⇒ String
Display information such as title and description.
-
#gcs_fileset_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1GcsFilesetSpec
Describes a Cloud Storage fileset entry.
-
#integrated_system ⇒ String
Output only.
-
#linked_resource ⇒ String
The resource this metadata entry refers to.
-
#name ⇒ String
The Data Catalog resource name of the entry in URL format.
-
#schema ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Schema
Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
-
#source_system_timestamps ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SystemTimestamps
Timestamps about this resource according to a particular system.
-
#type ⇒ String
The type of the entry.
-
#user_specified_system ⇒ String
This field indicates the entry's source system that Data Catalog does not integrate with.
-
#user_specified_type ⇒ String
Entry type if it does not fit any of the input-allowed values listed in
EntryType
enum above.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1Entry
constructor
A new instance of GoogleCloudDatacatalogV1beta1Entry.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1Entry
Returns a new instance of GoogleCloudDatacatalogV1beta1Entry.
463 464 465 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 463 def initialize(**args) update!(**args) end |
Instance Attribute Details
#bigquery_date_sharded_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpec
Spec for a group of BigQuery tables with name pattern [prefix]YYYYMMDD
.
Context:
https://cloud.google.com/bigquery/docs/partitioned-tables#
partitioning_versus_sharding
Corresponds to the JSON property bigqueryDateShardedSpec
370 371 372 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 370 def bigquery_date_sharded_spec @bigquery_date_sharded_spec end |
#bigquery_table_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1BigQueryTableSpec
Describes a BigQuery table.
Corresponds to the JSON property bigqueryTableSpec
375 376 377 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 375 def bigquery_table_spec @bigquery_table_spec end |
#description ⇒ String
Entry description, which can consist of several sentences or paragraphs
that describe entry contents. Default value is an empty string.
Corresponds to the JSON property description
381 382 383 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 381 def description @description end |
#display_name ⇒ String
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.
Corresponds to the JSON property displayName
388 389 390 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 388 def display_name @display_name end |
#gcs_fileset_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1GcsFilesetSpec
Describes a Cloud Storage fileset entry.
Corresponds to the JSON property gcsFilesetSpec
393 394 395 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 393 def gcs_fileset_spec @gcs_fileset_spec end |
#integrated_system ⇒ String
Output only. This field indicates the entry's source system that Data Catalog
integrates with, such as BigQuery or Cloud Pub/Sub.
Corresponds to the JSON property integratedSystem
399 400 401 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 399 def integrated_system @integrated_system end |
#linked_resource ⇒ String
The resource this metadata entry refers to.
For Google Cloud Platform resources, linked_resource
is the full name of
the
resource.
For example, the linked_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.
Corresponds to the JSON property
linkedResource
414 415 416 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 414 def linked_resource @linked_resource end |
#name ⇒ String
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. Corresponds to the JSON propertyname
423 424 425 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 423 def name @name end |
#schema ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Schema
Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
Corresponds to the JSON property schema
428 429 430 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 428 def schema @schema end |
#source_system_timestamps ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SystemTimestamps
Timestamps about this resource according to a particular system.
Corresponds to the JSON property sourceSystemTimestamps
433 434 435 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 433 def @source_system_timestamps end |
#type ⇒ String
The type of the entry.
Only used for Entries with types in the EntryType enum.
Corresponds to the JSON property type
439 440 441 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 439 def type @type end |
#user_specified_system ⇒ String
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.
Corresponds to the JSON property userSpecifiedSystem
448 449 450 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 448 def user_specified_system @user_specified_system end |
#user_specified_type ⇒ String
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 use user_specified_type
.
Corresponds to the JSON property userSpecifiedType
461 462 463 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 461 def user_specified_type @user_specified_type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 468 def update!(**args) @bigquery_date_sharded_spec = args[:bigquery_date_sharded_spec] if args.key?(:bigquery_date_sharded_spec) @bigquery_table_spec = args[:bigquery_table_spec] if args.key?(:bigquery_table_spec) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @gcs_fileset_spec = args[:gcs_fileset_spec] if args.key?(:gcs_fileset_spec) @integrated_system = args[:integrated_system] if args.key?(:integrated_system) @linked_resource = args[:linked_resource] if args.key?(:linked_resource) @name = args[:name] if args.key?(:name) @schema = args[:schema] if args.key?(:schema) @source_system_timestamps = args[:source_system_timestamps] if args.key?(:source_system_timestamps) @type = args[:type] if args.key?(:type) @user_specified_system = args[:user_specified_system] if args.key?(:user_specified_system) @user_specified_type = args[:user_specified_type] if args.key?(:user_specified_type) end |