Show / Hide Table of Contents

Class GoogleCloudDatacatalogV1Entry

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.

Inheritance
System.Object
GoogleCloudDatacatalogV1Entry
Implements
IDirectResponseSchema
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.DataCatalog.v1.Data
Assembly: Google.Apis.DataCatalog.v1.dll
Syntax
public class GoogleCloudDatacatalogV1Entry : IDirectResponseSchema

Properties

BigqueryDateShardedSpec

Output only. Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern. For more information, see Introduction to partitioned tables.

Declaration
[JsonProperty("bigqueryDateShardedSpec")]
public virtual GoogleCloudDatacatalogV1BigQueryDateShardedSpec BigqueryDateShardedSpec { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1BigQueryDateShardedSpec

BigqueryTableSpec

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

Declaration
[JsonProperty("bigqueryTableSpec")]
public virtual GoogleCloudDatacatalogV1BigQueryTableSpec BigqueryTableSpec { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1BigQueryTableSpec

BusinessContext

Business Context of the entry. Not supported for BigQuery datasets

Declaration
[JsonProperty("businessContext")]
public virtual GoogleCloudDatacatalogV1BusinessContext BusinessContext { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1BusinessContext

DatabaseTableSpec

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

Declaration
[JsonProperty("databaseTableSpec")]
public virtual GoogleCloudDatacatalogV1DatabaseTableSpec DatabaseTableSpec { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1DatabaseTableSpec

DataSource

Output only. Physical location of the entry.

Declaration
[JsonProperty("dataSource")]
public virtual GoogleCloudDatacatalogV1DataSource DataSource { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1DataSource

DataSourceConnectionSpec

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

Declaration
[JsonProperty("dataSourceConnectionSpec")]
public virtual GoogleCloudDatacatalogV1DataSourceConnectionSpec DataSourceConnectionSpec { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1DataSourceConnectionSpec

Description

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.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
System.String

DisplayName

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

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
System.String

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
System.String

FilesetSpec

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

Declaration
[JsonProperty("filesetSpec")]
public virtual GoogleCloudDatacatalogV1FilesetSpec FilesetSpec { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1FilesetSpec

FullyQualifiedName

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}

Declaration
[JsonProperty("fullyQualifiedName")]
public virtual string FullyQualifiedName { get; set; }
Property Value
Type Description
System.String

GcsFilesetSpec

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

Declaration
[JsonProperty("gcsFilesetSpec")]
public virtual GoogleCloudDatacatalogV1GcsFilesetSpec GcsFilesetSpec { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1GcsFilesetSpec

IntegratedSystem

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

Declaration
[JsonProperty("integratedSystem")]
public virtual string IntegratedSystem { get; set; }
Property Value
Type Description
System.String

Labels

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.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.String>

LinkedResource

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.

Declaration
[JsonProperty("linkedResource")]
public virtual string LinkedResource { get; set; }
Property Value
Type Description
System.String

LookerSystemSpec

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

Declaration
[JsonProperty("lookerSystemSpec")]
public virtual GoogleCloudDatacatalogV1LookerSystemSpec LookerSystemSpec { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1LookerSystemSpec

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
System.String

PersonalDetails

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

Declaration
[JsonProperty("personalDetails")]
public virtual GoogleCloudDatacatalogV1PersonalDetails PersonalDetails { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1PersonalDetails

RoutineSpec

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

Declaration
[JsonProperty("routineSpec")]
public virtual GoogleCloudDatacatalogV1RoutineSpec RoutineSpec { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1RoutineSpec

Schema

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

Declaration
[JsonProperty("schema")]
public virtual GoogleCloudDatacatalogV1Schema Schema { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1Schema

SourceSystemTimestamps

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.

Declaration
[JsonProperty("sourceSystemTimestamps")]
public virtual GoogleCloudDatacatalogV1SystemTimestamps SourceSystemTimestamps { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1SystemTimestamps

SqlDatabaseSystemSpec

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

Declaration
[JsonProperty("sqlDatabaseSystemSpec")]
public virtual GoogleCloudDatacatalogV1SqlDatabaseSystemSpec SqlDatabaseSystemSpec { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1SqlDatabaseSystemSpec

Type

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.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
System.String

UsageSignal

Resource usage statistics.

Declaration
[JsonProperty("usageSignal")]
public virtual GoogleCloudDatacatalogV1UsageSignal UsageSignal { get; set; }
Property Value
Type Description
GoogleCloudDatacatalogV1UsageSignal

UserSpecifiedSystem

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.

Declaration
[JsonProperty("userSpecifiedSystem")]
public virtual string UserSpecifiedSystem { get; set; }
Property Value
Type Description
System.String

UserSpecifiedType

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.

Declaration
[JsonProperty("userSpecifiedType")]
public virtual string UserSpecifiedType { get; set; }
Property Value
Type Description
System.String

Implements

IDirectResponseSchema
In This Article
Back to top Generated by DocFX