class Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1Entry
Entry metadata. A Data Catalog entry represents another resource in Google
Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You 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, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag.
Attributes
Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https: //cloud.google.com/bigquery/docs/partitioned-tables# partitioning_versus_sharding). Corresponds to the JSON property `bigqueryDateShardedSpec` @return [Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1BigQueryDateShardedSpec]
Describes a BigQuery table. Corresponds to the JSON property `bigqueryTableSpec` @return [Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1BigQueryTableSpec]
Physical location of an entry. Corresponds to the JSON property `dataSource` @return [Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1DataSource]
Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. Corresponds to the JSON property `dataSourceConnectionSpec` @return [Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1DataSourceConnectionSpec]
Specification that applies to a table resource. Valid only for entries with the `TABLE` type. Corresponds to the JSON property `databaseTableSpec` @return [Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1DatabaseTableSpec]
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. Corresponds to the JSON property `description` @return [String]
Display name of an entry. The name must contain only Unicode letters, numbers ( 0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string. Corresponds to the JSON property `displayName` @return [String]
Fully qualified name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation and read-only afterwards. Can be used for search and lookup of the entries. FQNs take two forms: * For non-regionalized resources: “SYSTEM`:`PROJECT`.` PATH_TO_RESOURCE_SEPARATED_WITH_DOTS“ * For regionalized resources: “SYSTEM`: `PROJECT`.`LOCATION_ID`.`PATH_TO_RESOURCE_SEPARATED_WITH_DOTS“ Example for a DPMS table: `dataproc_metastore:`PROJECT_ID`.`LOCATION_ID`.`INSTANCE_ID`.` DATABASE_ID`.`TABLE_ID“ Corresponds to the JSON property `fullyQualifiedName` @return [String]
Describes a Cloud Storage fileset entry. Corresponds to the JSON property `gcsFilesetSpec` @return [Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1GcsFilesetSpec]
Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. Corresponds to the JSON property `integratedSystem` @return [String]
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. Corresponds to the JSON property `labels` @return [Hash<String,String>]
The resource this metadata entry refers to. For Google
Cloud Platform resources, `linked_resource` is the [Full Resource Name] (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. Corresponds to the JSON property `linkedResource` @return [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. Corresponds to the JSON property `name` @return [String]
Specification that applies to a routine. Valid only for entries with the ` ROUTINE` type. Corresponds to the JSON property `routineSpec` @return [Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1RoutineSpec]
Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. Corresponds to the JSON property `schema` @return [Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1Schema]
Timestamps associated with this resource in a particular system. Corresponds to the JSON property `sourceSystemTimestamps` @return [Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1SystemTimestamps]
The type of the entry. Only used for entries with types listed in the ` EntryType` enum. Currently, only `FILESET` enum value is allowed. All other entries created in Data Catalog must use the `user_specified_type`. Corresponds to the JSON property `type` @return [String]
The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day. Corresponds to the JSON property `usageSignal` @return [Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1UsageSignal]
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. Corresponds to the JSON property `userSpecifiedSystem` @return [String]
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. Corresponds to the JSON property `userSpecifiedType` @return [String]
Public Class Methods
# File lib/google/apis/datacatalog_v1/classes.rb, line 656 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/datacatalog_v1/classes.rb, line 661 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) @data_source = args[:data_source] if args.key?(:data_source) @data_source_connection_spec = args[:data_source_connection_spec] if args.key?(:data_source_connection_spec) @database_table_spec = args[:database_table_spec] if args.key?(:database_table_spec) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @fully_qualified_name = args[:fully_qualified_name] if args.key?(:fully_qualified_name) @gcs_fileset_spec = args[:gcs_fileset_spec] if args.key?(:gcs_fileset_spec) @integrated_system = args[:integrated_system] if args.key?(:integrated_system) @labels = args[:labels] if args.key?(:labels) @linked_resource = args[:linked_resource] if args.key?(:linked_resource) @name = args[:name] if args.key?(:name) @routine_spec = args[:routine_spec] if args.key?(:routine_spec) @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) @usage_signal = args[:usage_signal] if args.key?(:usage_signal) @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