Class Entry (1.2.0)

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

Entry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of Google Cloud Platform. Clients 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, such as its schema. An Entry can also be used to attach flexible metadata, such as 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.MemberwiseClone()

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; }

Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

Property Value
Type	Description
`BigQueryDateShardedSpec`

BigqueryTableSpec

public BigQueryTableSpec BigqueryTableSpec { get; set; }

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

Property Value
Type	Description
`BigQueryTableSpec`

DatabaseTableSpec

public DatabaseTableSpec DatabaseTableSpec { get; set; }

Specification that applies to a table resource. Only valid for entries of TABLE type.

Property Value
Type	Description
`DatabaseTableSpec`

DataSource

public DataSource DataSource { get; set; }

Output only. Physical location of the entry.

Property Value
Type	Description
`DataSource`

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 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
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
`Entry.EntryTypeOneofCase`

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

GcsFilesetSpec

public GcsFilesetSpec GcsFilesetSpec { get; set; }

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.

Property Value
Type	Description
`GcsFilesetSpec`

IntegratedSystem

public IntegratedSystem IntegratedSystem { get; set; }

Output only. This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.

Property Value
Type	Description
`IntegratedSystem`

LinkedResource

public string LinkedResource { get; set; }

The resource this metadata entry refers to.

For Google Cloud Platform resources, linked_resource is the full name of the resource. For example, the linked_resource for a table resource from BigQuery is:

//bigquery.googleapis.com/projects/{projectId}/datasets/{datasetId}/tables/{tableId}

Output only when 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`

Name

public string Name { get; set; }

Output only. The resource name of an entry in URL format. Example:

projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}

Note: The entry itself and its child resources might not be stored in the location specified in its name.

Property Value
Type	Description
`String`

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`

SourceSystemTimestamps

public SystemTimestamps SourceSystemTimestamps { get; set; }

Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, 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
`Entry.SpecOneofCase`

SystemCase

public Entry.SystemOneofCase SystemCase { get; }

Property Value
Type	Description
`Entry.SystemOneofCase`

Type

public EntryType Type { get; set; }

The type of the entry. Only used for Entries with types in the EntryType enum.

Property Value
Type	Description
`EntryType`

TypeSpecCase

public Entry.TypeSpecOneofCase TypeSpecCase { get; }

Property Value
Type	Description
`Entry.TypeSpecOneofCase`

UserSpecifiedSystem

public string UserSpecifiedSystem { get; set; }

This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

Property Value
Type	Description
`String`

UserSpecifiedType

public string UserSpecifiedType { get; set; }

Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.

Property Value
Type	Description
`String`