Data Catalog v1 API - Class Entry (2.11.0)

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

Reference documentation and code samples for the Data Catalog v1 API class Entry.

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

Implements

IMessage Entry, IEquatable Entry, IDeepCloneable Entry, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

Entry()

public Entry()

Entry(Entry)

public Entry(Entry other)

Parameter
Name	Description
`other`	`Entry`

Properties

BigqueryDateShardedSpec

public BigQueryDateShardedSpec BigqueryDateShardedSpec { get; set; }

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

For more information, see Introduction to partitioned tables.

Property Value
Type	Description
`BigQueryDateShardedSpec`

BigqueryTableSpec

public BigQueryTableSpec BigqueryTableSpec { get; set; }

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

Property Value
Type	Description
`BigQueryTableSpec`

BusinessContext

public BusinessContext BusinessContext { get; set; }

Business Context of the entry. Not supported for BigQuery datasets

Property Value
Type	Description
`BusinessContext`

CloudBigtableSystemSpec

public CloudBigtableSystemSpec CloudBigtableSystemSpec { get; set; }

Specification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE

Property Value
Type	Description
`CloudBigtableSystemSpec`

DataSource

public DataSource DataSource { get; set; }

Output only. Physical location of the entry.

Property Value
Type	Description
`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
Type	Description
`DataSourceConnectionSpec`

DatabaseTableSpec

public DatabaseTableSpec DatabaseTableSpec { get; set; }

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

Property Value
Type	Description
`DatabaseTableSpec`

DatasetSpec

public DatasetSpec DatasetSpec { get; set; }

Specification that applies to a dataset.

Property Value
Type	Description
`DatasetSpec`

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
Type	Description
`string`

DisplayName

public string DisplayName { get; set; }

Display name of an entry.

The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.

Property Value
Type	Description
`string`

EntryName

public EntryName EntryName { get; set; }

EntryName-typed view over the Name resource name property.

Property Value
Type	Description
`EntryName`

EntryTypeCase

public Entry.EntryTypeOneofCase EntryTypeCase { get; }

Property Value
Type	Description
`EntryEntryTypeOneofCase`

FilesetSpec

public FilesetSpec FilesetSpec { get; set; }

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

Property Value
Type	Description
`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 later. Can be used for search and lookup of the entries.

Property Value
Type	Description
`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
Type	Description
`GcsFilesetSpec`

HasIntegratedSystem

public bool HasIntegratedSystem { get; }

Gets whether the "integrated_system" field is set

Property Value
Type	Description
`bool`

HasType

public bool HasType { get; }

Gets whether the "type" field is set

Property Value
Type	Description
`bool`

HasUserSpecifiedSystem

public bool HasUserSpecifiedSystem { get; }

Gets whether the "user_specified_system" field is set

Property Value
Type	Description
`bool`

HasUserSpecifiedType

public bool HasUserSpecifiedType { get; }

Gets whether the "user_specified_type" field is set

Property Value
Type	Description
`bool`

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
Type	Description
`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
Type	Description
`MapFieldstringstring`

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
Type	Description
`string`

LookerSystemSpec

public LookerSystemSpec LookerSystemSpec { get; set; }

Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER

Property Value
Type	Description
`LookerSystemSpec`

ModelSpec

public ModelSpec ModelSpec { get; set; }

Model specification.

Property Value
Type	Description
`ModelSpec`

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
Type	Description
`string`

PersonalDetails

public PersonalDetails PersonalDetails { get; set; }

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

Property Value
Type	Description
`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
Type	Description
`RoutineSpec`

Schema

public Schema Schema { get; set; }

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

Property Value
Type	Description
`Schema`

ServiceSpec

public ServiceSpec ServiceSpec { get; set; }

Specification that applies to a Service resource.

Property Value
Type	Description
`ServiceSpec`

SourceSystemTimestamps

public SystemTimestamps SourceSystemTimestamps { get; set; }

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.

Property Value
Type	Description
`SystemTimestamps`

SpecCase

public Entry.SpecOneofCase SpecCase { get; }

Property Value
Type	Description
`EntrySpecOneofCase`

SqlDatabaseSystemSpec

public SqlDatabaseSystemSpec SqlDatabaseSystemSpec { get; set; }

Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE

Property Value
Type	Description
`SqlDatabaseSystemSpec`

SystemCase

public Entry.SystemOneofCase SystemCase { get; }

Property Value
Type	Description
`EntrySystemOneofCase`

SystemSpecCase

public Entry.SystemSpecOneofCase SystemSpecCase { get; }

Property Value
Type	Description
`EntrySystemSpecOneofCase`

Type

public EntryType Type { get; set; }

The type of the entry.

For details, see EntryType.

Property Value
Type	Description
`EntryType`

TypeSpecCase

public Entry.TypeSpecOneofCase TypeSpecCase { get; }

Property Value
Type	Description
`EntryTypeSpecOneofCase`

UsageSignal

public UsageSignal UsageSignal { get; set; }

Resource usage statistics.

Property Value
Type	Description
`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
Type	Description
`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
Type	Description
`string`