Class Entry (2.1.0)

public sealed class Entry : IMessage<Entry>, IEquatable<Entry>, IDeepCloneable<Entry>, IBufferMessage, IMessage

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][google.cloud.datacatalog.v1.Tag].

Inheritance

Object > Entry

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

Entry()

public Entry()

Entry(Entry)

public Entry(Entry other)
Parameter
NameDescription
otherEntry

Properties

BigqueryDateShardedSpec

public BigQueryDateShardedSpec BigqueryDateShardedSpec { get; set; }

Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern.

For more information, see Introduction to partitioned tables.

Property Value
TypeDescription
BigQueryDateShardedSpec

BigqueryTableSpec

public BigQueryTableSpec BigqueryTableSpec { get; set; }

Specification that applies to a BigQuery table. Valid only for entries with the TABLE type.

Property Value
TypeDescription
BigQueryTableSpec

BusinessContext

public BusinessContext BusinessContext { get; set; }

Business Context of the entry. Not supported for BigQuery datasets

Property Value
TypeDescription
BusinessContext

DatabaseTableSpec

public DatabaseTableSpec DatabaseTableSpec { get; set; }

Specification that applies to a table resource. Valid only for entries with the TABLE type.

Property Value
TypeDescription
DatabaseTableSpec

DataSource

public DataSource DataSource { get; set; }

Output only. Physical location of the entry.

Property Value
TypeDescription
DataSource

DataSourceConnectionSpec

public DataSourceConnectionSpec DataSourceConnectionSpec { get; set; }

Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

Property Value
TypeDescription
DataSourceConnectionSpec

Description

public string Description { get; set; }

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.

Property Value
TypeDescription
String

DisplayName

public string DisplayName { get; set; }

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.

Property Value
TypeDescription
String

EntryName

public EntryName EntryName { get; set; }

EntryName-typed view over the Name resource name property.

Property Value
TypeDescription
EntryName

EntryTypeCase

public Entry.EntryTypeOneofCase EntryTypeCase { get; }
Property Value
TypeDescription
Entry.EntryTypeOneofCase

FilesetSpec

public FilesetSpec FilesetSpec { get; set; }

Specification that applies to a fileset resource. Valid only for entries with the FILESET type.

Property Value
TypeDescription
FilesetSpec

FullyQualifiedName

public string FullyQualifiedName { get; set; }

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}

Property Value
TypeDescription
String

GcsFilesetSpec

public GcsFilesetSpec GcsFilesetSpec { get; set; }

Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

Property Value
TypeDescription
GcsFilesetSpec

IntegratedSystem

public IntegratedSystem IntegratedSystem { get; set; }

Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.

Property Value
TypeDescription
IntegratedSystem

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
TypeDescription
MapField<String, String>

LinkedResource

public string LinkedResource { get; set; }

The resource this metadata entry refers to.

For Google Cloud Platform resources, linked_resource is the 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.

Property Value
TypeDescription
String

Name

public string Name { get; set; }

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.

Property Value
TypeDescription
String

PersonalDetails

public PersonalDetails PersonalDetails { get; set; }

Output only. Additional information related to the entry. Private to the current user.

Property Value
TypeDescription
PersonalDetails

RoutineSpec

public RoutineSpec RoutineSpec { get; set; }

Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

Property Value
TypeDescription
RoutineSpec

Schema

public Schema Schema { get; set; }

Schema of the entry. An entry might not have any schema attached to it.

Property Value
TypeDescription
Schema

SourceSystemTimestamps

public SystemTimestamps SourceSystemTimestamps { get; set; }

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.

Property Value
TypeDescription
SystemTimestamps

SpecCase

public Entry.SpecOneofCase SpecCase { get; }
Property Value
TypeDescription
Entry.SpecOneofCase

SystemCase

public Entry.SystemOneofCase SystemCase { get; }
Property Value
TypeDescription
Entry.SystemOneofCase

Type

public EntryType Type { get; set; }

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.

Property Value
TypeDescription
EntryType

TypeSpecCase

public Entry.TypeSpecOneofCase TypeSpecCase { get; }
Property Value
TypeDescription
Entry.TypeSpecOneofCase

UsageSignal

public UsageSignal UsageSignal { get; set; }

Output only. Resource usage statistics.

Property Value
TypeDescription
UsageSignal

UserSpecifiedSystem

public string UserSpecifiedSystem { get; set; }

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.
Property Value
TypeDescription
String

UserSpecifiedType

public string UserSpecifiedType { get; set; }

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.
Property Value
TypeDescription
String