Class Entry (3.9.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

NameDescription
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) 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}``
type_ google.cloud.datacatalog_v1.types.EntryType
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``. 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``.
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
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
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`` 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``.
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``.
display_name str
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.
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 type listed in the ``EntryType`` enum. For entries with ``user_specified_type``, this field is optional and defaults to an empty timestamp.
usage_signal google.cloud.datacatalog_v1.types.UsageSignal
Output only. Resource usage statistics.
labels Mapping[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.

Inheritance

builtins.object > proto.message.Message > Entry

Classes

LabelsEntry

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

The abstract base class for a message.

Parameters
NameDescription
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.