Class Entry (3.19.0)

Version latest

• 3.19.0 (latest)
• 3.18.3
• 3.17.2
• 3.16.0
• 3.15.1
• 3.14.0
• 3.13.1
• 3.12.0
• 3.11.1
• 3.10.0
• 3.9.3
• 3.8.1
• 3.7.1
• 3.6.2
• 3.5.0
• 3.4.3
• 3.3.2
• 3.2.1
• 3.1.1
• 3.0.0
• 2.0.2
• 1.0.2
• 0.8.2
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0

Entry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
name	str 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.
linked_resource	str 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.
fully_qualified_name	str `Fully Qualified Name (FQN)
type_	google.cloud.datacatalog_v1.types.EntryType The type of the entry. For details, see ``EntryType <#entrytype>__. This field is a member of oneof_ entry_type.
user_specified_type	str 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. This field is a member of oneof_ entry_type.
integrated_system	google.cloud.datacatalog_v1.types.IntegratedSystem Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. This field is a member of oneof_ system.
user_specified_system	str 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. This field is a member of oneof_ system.
sql_database_system_spec	google.cloud.datacatalog_v1.types.SqlDatabaseSystemSpec Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE This field is a member of oneof_ system_spec.
looker_system_spec	google.cloud.datacatalog_v1.types.LookerSystemSpec Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER This field is a member of oneof_ system_spec.
cloud_bigtable_system_spec	google.cloud.datacatalog_v1.types.CloudBigtableSystemSpec Specification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE This field is a member of oneof_ system_spec.
gcs_fileset_spec	google.cloud.datacatalog_v1.types.GcsFilesetSpec Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type. This field is a member of oneof_ type_spec.
bigquery_table_spec	google.cloud.datacatalog_v1.types.BigQueryTableSpec Output only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE type. This field is a member of oneof_ type_spec.
bigquery_date_sharded_spec	google.cloud.datacatalog_v1.types.BigQueryDateShardedSpec Output only. 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). This field is a member of oneof_ type_spec.
database_table_spec	google.cloud.datacatalog_v1.types.DatabaseTableSpec Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type. This field is a member of oneof_ spec.
data_source_connection_spec	google.cloud.datacatalog_v1.types.DataSourceConnectionSpec Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type. This field is a member of oneof_ spec.
routine_spec	google.cloud.datacatalog_v1.types.RoutineSpec Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type. This field is a member of oneof_ spec.
dataset_spec	google.cloud.datacatalog_v1.types.DatasetSpec Specification that applies to a dataset. This field is a member of oneof_ spec.
fileset_spec	google.cloud.datacatalog_v1.types.FilesetSpec Specification that applies to a fileset resource. Valid only for entries with the FILESET type. This field is a member of oneof_ spec.
service_spec	google.cloud.datacatalog_v1.types.ServiceSpec Specification that applies to a Service resource. This field is a member of oneof_ spec.
model_spec	google.cloud.datacatalog_v1.types.ModelSpec Model specification. This field is a member of oneof_ spec.
display_name	str Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
description	str 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.
business_context	google.cloud.datacatalog_v1.types.BusinessContext Business Context of the entry. Not supported for BigQuery datasets
schema	google.cloud.datacatalog_v1.types.Schema Schema of the entry. An entry might not have any schema attached to it.
source_system_timestamps	google.cloud.datacatalog_v1.types.SystemTimestamps Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a system listed in the IntegratedSystem enum. For entries with user_specified_system, this field is optional and defaults to an empty timestamp.
usage_signal	google.cloud.datacatalog_v1.types.UsageSignal Resource usage statistics.
labels	MutableMapping[str, str] 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.
data_source	google.cloud.datacatalog_v1.types.DataSource Output only. Physical location of the entry.
personal_details	google.cloud.datacatalog_v1.types.PersonalDetails Output only. Additional information related to the entry. Private to the current user.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.