# REST Resource: projects.locations.entryGroups.entries

- [Resource: Entry](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Entry)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Entry.SCHEMA_REPRESENTATION)
- [EntryType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#EntryType)
- [IntegratedSystem](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#IntegratedSystem)
- [SqlDatabaseSystemSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#SqlDatabaseSystemSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#SqlDatabaseSystemSpec.SCHEMA_REPRESENTATION)
- [LookerSystemSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#LookerSystemSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#LookerSystemSpec.SCHEMA_REPRESENTATION)
- [CloudBigtableSystemSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudBigtableSystemSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudBigtableSystemSpec.SCHEMA_REPRESENTATION)
- [GcsFilesetSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#GcsFilesetSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#GcsFilesetSpec.SCHEMA_REPRESENTATION)
- [GcsFileSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#GcsFileSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#GcsFileSpec.SCHEMA_REPRESENTATION)
- [BigQueryTableSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryTableSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryTableSpec.SCHEMA_REPRESENTATION)
- [TableSourceType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#TableSourceType)
- [ViewSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ViewSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ViewSpec.SCHEMA_REPRESENTATION)
- [TableSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#TableSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#TableSpec.SCHEMA_REPRESENTATION)
- [BigQueryDateShardedSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryDateShardedSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryDateShardedSpec.SCHEMA_REPRESENTATION)
- [DatabaseTableSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatabaseTableSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatabaseTableSpec.SCHEMA_REPRESENTATION)
- [TableType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#TableType)
- [DataplexTableSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexTableSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexTableSpec.SCHEMA_REPRESENTATION)
- [DataplexExternalTable](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexExternalTable)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexExternalTable.SCHEMA_REPRESENTATION)
- [DataplexSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexSpec.SCHEMA_REPRESENTATION)
- [PhysicalSchema](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#PhysicalSchema)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#PhysicalSchema.SCHEMA_REPRESENTATION)
- [AvroSchema](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#AvroSchema)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#AvroSchema.SCHEMA_REPRESENTATION)
- [ThriftSchema](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ThriftSchema)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ThriftSchema.SCHEMA_REPRESENTATION)
- [ProtobufSchema](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ProtobufSchema)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ProtobufSchema.SCHEMA_REPRESENTATION)
- [ParquetSchema](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ParquetSchema)
- [OrcSchema](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#OrcSchema)
- [CsvSchema](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CsvSchema)
- [DatabaseViewSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatabaseViewSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatabaseViewSpec.SCHEMA_REPRESENTATION)
- [ViewType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ViewType)
- [DataSourceConnectionSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataSourceConnectionSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataSourceConnectionSpec.SCHEMA_REPRESENTATION)
- [BigQueryConnectionSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryConnectionSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryConnectionSpec.SCHEMA_REPRESENTATION)
- [ConnectionType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ConnectionType)
- [CloudSqlBigQueryConnectionSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudSqlBigQueryConnectionSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudSqlBigQueryConnectionSpec.SCHEMA_REPRESENTATION)
- [DatabaseType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatabaseType)
- [RoutineSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#RoutineSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#RoutineSpec.SCHEMA_REPRESENTATION)
- [RoutineType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#RoutineType)
- [Argument](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Argument)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Argument.SCHEMA_REPRESENTATION)
- [Mode](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Mode)
- [BigQueryRoutineSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryRoutineSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryRoutineSpec.SCHEMA_REPRESENTATION)
- [DatasetSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatasetSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatasetSpec.SCHEMA_REPRESENTATION)
- [VertexDatasetSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexDatasetSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexDatasetSpec.SCHEMA_REPRESENTATION)
- [DataType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataType)
- [FilesetSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#FilesetSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#FilesetSpec.SCHEMA_REPRESENTATION)
- [DataplexFilesetSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexFilesetSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexFilesetSpec.SCHEMA_REPRESENTATION)
- [ServiceSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ServiceSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ServiceSpec.SCHEMA_REPRESENTATION)
- [CloudBigtableInstanceSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudBigtableInstanceSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudBigtableInstanceSpec.SCHEMA_REPRESENTATION)
- [CloudBigtableClusterSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudBigtableClusterSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudBigtableClusterSpec.SCHEMA_REPRESENTATION)
- [ModelSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ModelSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ModelSpec.SCHEMA_REPRESENTATION)
- [VertexModelSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexModelSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexModelSpec.SCHEMA_REPRESENTATION)
- [VertexModelSourceInfo](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexModelSourceInfo)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexModelSourceInfo.SCHEMA_REPRESENTATION)
- [ModelSourceType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ModelSourceType)
- [FeatureOnlineStoreSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#FeatureOnlineStoreSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#FeatureOnlineStoreSpec.SCHEMA_REPRESENTATION)
- [StorageType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#StorageType)
- [BusinessContext](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BusinessContext)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BusinessContext.SCHEMA_REPRESENTATION)
- [EntryOverview](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#EntryOverview)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#EntryOverview.SCHEMA_REPRESENTATION)
- [Contacts](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Contacts)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Contacts.SCHEMA_REPRESENTATION)
- [Person](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Person)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Person.SCHEMA_REPRESENTATION)
- [Schema](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Schema)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Schema.SCHEMA_REPRESENTATION)
- [ColumnSchema](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ColumnSchema)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ColumnSchema.SCHEMA_REPRESENTATION)
- [IndexingType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#IndexingType)
- [LookerColumnSpec](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#LookerColumnSpec)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#LookerColumnSpec.SCHEMA_REPRESENTATION)
- [LookerColumnType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#LookerColumnType)
- [FieldElementType](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#FieldElementType)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#FieldElementType.SCHEMA_REPRESENTATION)
- [UsageSignal](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#UsageSignal)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#UsageSignal.SCHEMA_REPRESENTATION)
- [UsageStats](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#UsageStats)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#UsageStats.SCHEMA_REPRESENTATION)
- [CommonUsageStats](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CommonUsageStats)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CommonUsageStats.SCHEMA_REPRESENTATION)
- [DataSource](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataSource)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataSource.SCHEMA_REPRESENTATION)
- [Service](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Service)
- [StorageProperties](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#StorageProperties)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#StorageProperties.SCHEMA_REPRESENTATION)
- [PersonalDetails](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#PersonalDetails)
  - [JSON representation](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#PersonalDetails.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#METHODS_SUMMARY)

## Resource: 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 `linkedResource` 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 `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags#Tag`.

| JSON representation |
|---|
| ``` { "name": string, "linkedResource": string, "fullyQualifiedName": string, "displayName": string, "description": string, "businessContext": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BusinessContext`) }, "schema": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Schema`) }, "sourceSystemTimestamps": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/SystemTimestamps`) }, "usageSignal": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#UsageSignal`) }, "labels": { string: string, ... }, "dataSource": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataSource`) }, "personalDetails": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#PersonalDetails`) }, // Union field `entry_type` can be only one of the following: "type": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#EntryType`), "userSpecifiedType": string // End of list of possible types for union field `entry_type`. // Union field `system` can be only one of the following: "integratedSystem": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#IntegratedSystem`), "userSpecifiedSystem": string // End of list of possible types for union field `system`. // Union field `system_spec` can be only one of the following: "sqlDatabaseSystemSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#SqlDatabaseSystemSpec`) }, "lookerSystemSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#LookerSystemSpec`) }, "cloudBigtableSystemSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudBigtableSystemSpec`) } // End of list of possible types for union field `system_spec`. // Union field `type_spec` can be only one of the following: "gcsFilesetSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#GcsFilesetSpec`) }, "bigqueryTableSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryTableSpec`) }, "bigqueryDateShardedSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryDateShardedSpec`) } // End of list of possible types for union field `type_spec`. // Union field `spec` can be only one of the following: "databaseTableSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatabaseTableSpec`) }, "dataSourceConnectionSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataSourceConnectionSpec`) }, "routineSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#RoutineSpec`) }, "datasetSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatasetSpec`) }, "filesetSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#FilesetSpec`) }, "serviceSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ServiceSpec`) }, "modelSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ModelSpec`) }, "featureOnlineStoreSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#FeatureOnlineStoreSpec`) } // End of list of possible types for union field `spec`. } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. Identifier. 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. |
| `linkedResource` | `string` The resource this metadata entry refers to. For Google Cloud Platform resources, `linkedResource` is the [Full Resource Name](https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linkedResource` 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 `userSpecifiedType`, 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. |
| `fullyQualifiedName` | `string` [Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) 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. |
| `displayName` | `string` Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string. |
| `description` | `string` 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. |
| `businessContext` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BusinessContext`)`` Business Context of the entry. Not supported for BigQuery datasets |
| `schema` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Schema`)`` Schema of the entry. An entry might not have any schema attached to it. |
| `sourceSystemTimestamps` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/SystemTimestamps`)`` 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 `userSpecifiedSystem`, this field is optional and defaults to an empty timestamp. |
| `usageSignal` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#UsageSignal`)`` Resource usage statistics. |
| `labels` | `map (key: string, value: string)` 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. |
| `dataSource` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataSource`)`` Output only. Physical location of the entry. |
| `personalDetails` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#PersonalDetails`)`` Output only. Additional information related to the entry. Private to the current user. |
| Union field `entry_type`. Required. Entry type. `entry_type` can be only one of the following: ||
| `type` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#EntryType`)`` The type of the entry. For details, see [`EntryType`](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#entrytype). |
| `userSpecifiedType` | `string` 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 `userSpecifiedType` 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. |
| Union field `system`. The source system of the entry. `system` can be only one of the following: ||
| `integratedSystem` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#IntegratedSystem`)`` Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. |
| `userSpecifiedSystem` | `string` Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `userSpecifiedSystem` 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. |
| Union field `system_spec`. System specification. Can be used as a complement for `spec`, when some metadata is relevant for all entries existing within given system `system_spec` can be only one of the following: ||
| `sqlDatabaseSystemSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#SqlDatabaseSystemSpec`)`` Specification that applies to a relational database system. Only settable when `userSpecifiedSystem` is equal to `SQL_DATABASE` |
| `lookerSystemSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#LookerSystemSpec`)`` Specification that applies to Looker sysstem. Only settable when `userSpecifiedSystem` is equal to `LOOKER` |
| `cloudBigtableSystemSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudBigtableSystemSpec`)`` Specification that applies to Cloud Bigtable system. Only settable when `integratedSystem` is equal to `CLOUD_BIGTABLE` |
| Union field `type_spec`. Type specification. `type_spec` can be only one of the following: ||
| `gcsFilesetSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#GcsFilesetSpec`)`` Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type. |
| `bigqueryTableSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryTableSpec`)`` Output only. Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type. |
| `bigqueryDateShardedSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryDateShardedSpec`)`` Output only. 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). |
| Union field `spec`. Type- and system-specific information. Specifications for types contain fields common to all entries of a given type, and sub-specifications with fields specific to a given source system. When extending the API with new types and systems, use this field instead of the legacy `type_spec`. `spec` can be only one of the following: ||
| `databaseTableSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatabaseTableSpec`)`` Specification that applies to a table resource. Valid only for entries with the `TABLE` or `EXPLORE` type. |
| `dataSourceConnectionSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataSourceConnectionSpec`)`` Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. |
| `routineSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#RoutineSpec`)`` Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. |
| `datasetSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatasetSpec`)`` Specification that applies to a dataset. |
| `filesetSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#FilesetSpec`)`` Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type. |
| `serviceSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ServiceSpec`)`` Specification that applies to a Service resource. |
| `modelSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ModelSpec`)`` Model specification. |
| `featureOnlineStoreSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#FeatureOnlineStoreSpec`)`` FeatureonlineStore spec for Vertex AI Feature Store. |

## EntryType

Metadata automatically ingested from Google Cloud resources like BigQuery tables or Pub/Sub topics always uses enum values from `EntryType` as the type of entry.

Other sources of metadata like Hive or Oracle databases can identify the type by either using one of the enum values from `EntryType` (for example, `FILESET` for a Cloud Storage fileset) or specifying a custom value using the [`Entry`](https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#resource:-entry) field `userSpecifiedType`. For more information, see [Surface files from Cloud Storage with fileset entries](https://docs.cloud.google.com/data-catalog/docs/how-to/filesets) or [Create custom entries for your data sources](https://docs.cloud.google.com/data-catalog/docs/how-to/custom-entries).

| Enums ||
|---|---|
| `ENTRY_TYPE_UNSPECIFIED` | Default unknown type. |
| `TABLE` | The entry type that has a GoogleSQL schema, including logical views. |
| `MODEL` | The type of models. For more information, see [Supported models in BigQuery ML](https://docs.cloud.google.com/bigquery/docs/bqml-introduction#supported_models). |
| `DATA_STREAM` | An entry type for streaming entries. For example, a Pub/Sub topic. |
| `FILESET` | An entry type for a set of files or objects. For example, a Cloud Storage fileset. |
| `CLUSTER` | A group of servers that work together. For example, a Kafka cluster. |
| `DATABASE` | A database. |
| `DATA_SOURCE_CONNECTION` | Connection to a data source. For example, a BigQuery connection. |
| `ROUTINE` | Routine, for example, a BigQuery routine. |
| `LAKE` | A Dataplex Universal Catalog lake. |
| `ZONE` | A Dataplex Universal Catalog zone. |
| `SERVICE` | A service, for example, a Dataproc Metastore service. |
| `DATABASE_SCHEMA` | Schema within a relational database. |
| `DASHBOARD` | A Dashboard, for example from Looker. |
| `EXPLORE` | A Looker Explore. For more information, see [Looker Explore API](https://developers.looker.com/api/explorer/4.0/methods/LookmlModel/lookml_model_explore). |
| `LOOK` | A Looker Look. For more information, see [Looker Look API](https://developers.looker.com/api/explorer/4.0/methods/Look). |
| `FEATURE_ONLINE_STORE` | Feature Online Store resource in Vertex AI Feature Store. |
| `FEATURE_VIEW` | Feature View resource in Vertex AI Feature Store. |
| `FEATURE_GROUP` | Feature Group resource in Vertex AI Feature Store. |

## IntegratedSystem

This enum lists all the systems that Data Catalog integrates with.

| Enums ||
|---|---|
| `INTEGRATED_SYSTEM_UNSPECIFIED` | Default unknown system. |
| `BIGQUERY` | BigQuery. |
| `CLOUD_PUBSUB` | Cloud Pub/Sub. |
| `DATAPROC_METASTORE` | Dataproc Metastore. |
| `DATAPLEX` | Dataplex Universal Catalog. |
| `CLOUD_SPANNER` | Cloud Spanner |
| `CLOUD_BIGTABLE` | Cloud Bigtable |
| `CLOUD_SQL` | Cloud Sql |
| `LOOKER` | Looker |
| `VERTEX_AI` | Vertex AI |

## SqlDatabaseSystemSpec

Specification that applies to entries that are part `SQL_DATABASE` system (userSpecifiedType)

| JSON representation |
|---|
| ``` { "sqlEngine": string, "databaseVersion": string, "instanceHost": string } ``` |

| Fields ||
|---|---|
| `sqlEngine` | `string` SQL Database Engine. enum SqlEngine { UNDEFINED = 0; MY_SQL = 1; POSTGRE_SQL = 2; SQL_SERVER = 3; } Engine of the enclosing database instance. |
| `databaseVersion` | `string` Version of the database engine. |
| `instanceHost` | `string` Host of the SQL database enum InstanceHost { UNDEFINED = 0; SELF_HOSTED = 1; CLOUD_SQL = 2; AMAZON_RDS = 3; AZURE_SQL = 4; } Host of the enclousing database instance. |

## LookerSystemSpec

Specification that applies to entries that are part `LOOKER` system (userSpecifiedType)

| JSON representation |
|---|
| ``` { "parentInstanceId": string, "parentInstanceDisplayName": string, "parentModelId": string, "parentModelDisplayName": string, "parentViewId": string, "parentViewDisplayName": string } ``` |

| Fields ||
|---|---|
| `parentInstanceId` | `string` ID of the parent Looker Instance. Empty if it does not exist. Example value: `someinstance.looker.com` |
| `parentInstanceDisplayName` | `string` Name of the parent Looker Instance. Empty if it does not exist. |
| `parentModelId` | `string` ID of the parent Model. Empty if it does not exist. |
| `parentModelDisplayName` | `string` Name of the parent Model. Empty if it does not exist. |
| `parentViewId` | `string` ID of the parent View. Empty if it does not exist. |
| `parentViewDisplayName` | `string` Name of the parent View. Empty if it does not exist. |

## CloudBigtableSystemSpec

Specification that applies to all entries that are part of `CLOUD_BIGTABLE` system (userSpecifiedType)

| JSON representation |
|---|
| ``` { "instanceDisplayName": string } ``` |

| Fields ||
|---|---|
| `instanceDisplayName` | `string` Display name of the Instance. This is user specified and different from the resource name. |

## GcsFilesetSpec

Describes a Cloud Storage fileset entry.

| JSON representation |
|---|
| ``` { "filePatterns": [ string ], "sampleGcsFileSpecs": [ { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#GcsFileSpec`) } ] } ``` |

| Fields ||
|---|---|
| `filePatterns[]` | `string` Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names](https://cloud.google.com/storage/docs/wildcards). Note: Currently, bucket wildcards are not supported. Examples of valid `filePatterns`: - `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory - `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories - `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` - `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` - `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` - `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` - `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` - `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g` |
| `sampleGcsFileSpecs[]` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#GcsFileSpec`)`` Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here. |

## GcsFileSpec

Specification of a single file in Cloud Storage.

| JSON representation |
|---|
| ``` { "filePath": string, "gcsTimestamps": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/SystemTimestamps`) }, "sizeBytes": string } ``` |

| Fields ||
|---|---|
| `filePath` | `string` Required. Full file path. Example: `gs://bucket_name/a/b.txt`. |
| `gcsTimestamps` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/SystemTimestamps`)`` Output only. Creation, modification, and expiration timestamps of a Cloud Storage file. |
| `sizeBytes` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. File size in bytes. |

## BigQueryTableSpec

Describes a BigQuery table.

| JSON representation |
|---|
| ``` { "tableSourceType": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#TableSourceType`), // Union field `type_spec` can be only one of the following: "viewSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ViewSpec`) }, "tableSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#TableSpec`) } // End of list of possible types for union field `type_spec`. } ``` |

| Fields ||
|---|---|
| `tableSourceType` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#TableSourceType`)`` Output only. The table source type. |
| Union field `type_spec`. Output only. `type_spec` can be only one of the following: ||
| `viewSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ViewSpec`)`` Table view specification. Populated only if the `tableSourceType` is `BIGQUERY_VIEW`. |
| `tableSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#TableSpec`)`` Specification of a BigQuery table. Populated only if the `tableSourceType` is `BIGQUERY_TABLE`. |

## TableSourceType

Table source type.

| Enums ||
|---|---|
| `TABLE_SOURCE_TYPE_UNSPECIFIED` | Default unknown type. |
| `BIGQUERY_VIEW` | Table view. |
| `BIGQUERY_TABLE` | BigQuery native table. |
| `BIGQUERY_MATERIALIZED_VIEW` | BigQuery materialized view. |

## ViewSpec

Table view specification.

| JSON representation |
|---|
| ``` { "viewQuery": string } ``` |

| Fields ||
|---|---|
| `viewQuery` | `string` Output only. The query that defines the table view. |

## TableSpec

Normal BigQuery table specification.

| JSON representation |
|---|
| ``` { "groupedEntry": string } ``` |

| Fields ||
|---|---|
| `groupedEntry` | `string` Output only. If the table is date-sharded, that is, it matches the `[prefix]YYYYMMDD` name pattern, this field is the Data Catalog resource name of the date-sharded grouped entry. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. Otherwise, `groupedEntry` is empty. |

## 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).

| JSON representation |
|---|
| ``` { "dataset": string, "tablePrefix": string, "shardCount": string, "latestShardResource": string } ``` |

| Fields ||
|---|---|
| `dataset` | `string` Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. |
| `tablePrefix` | `string` Output only. The table name prefix of the shards. The name of any given shard is `[tablePrefix]YYYYMMDD`. For example, for the `MyTable20180101` shard, the `tablePrefix` is `MyTable`. |
| `shardCount` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. Total number of shards. |
| `latestShardResource` | `string` Output only. BigQuery resource name of the latest shard. |

## DatabaseTableSpec

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

| JSON representation |
|---|
| ``` { "type": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#TableType`), "dataplexTable": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexTableSpec`) }, "databaseViewSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatabaseViewSpec`) } } ``` |

| Fields ||
|---|---|
| `type` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#TableType`)`` Type of this table. |
| `dataplexTable` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexTableSpec`)`` Output only. Fields specific to a Dataplex Universal Catalog table and present only in the Dataplex Universal Catalog table entries. |
| `databaseViewSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatabaseViewSpec`)`` Spec what applies to tables that are actually views. Not set for "real" tables. |

## TableType

Type of the table.

| Enums ||
|---|---|
| `TABLE_TYPE_UNSPECIFIED` | Default unknown table type. |
| `NATIVE` | Native table. |
| `EXTERNAL` | External table. |

## DataplexTableSpec

Entry specification for a Dataplex Universal Catalog table.

| JSON representation |
|---|
| ``` { "externalTables": [ { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexExternalTable`) } ], "dataplexSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexSpec`) }, "userManaged": boolean } ``` |

| Fields ||
|---|---|
| `externalTables[]` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexExternalTable`)`` List of external tables registered by Dataplex Universal Catalog in other systems based on the same underlying data. External tables allow to query this data in those systems. |
| `dataplexSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexSpec`)`` Common Dataplex Universal Catalog fields. |
| `userManaged` | `boolean` Indicates if the table schema is managed by the user or not. |

## DataplexExternalTable

External table registered by Dataplex Universal Catalog. Dataplex Universal Catalog publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog.

| JSON representation |
|---|
| ``` { "system": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#IntegratedSystem`), "fullyQualifiedName": string, "googleCloudResource": string, "dataCatalogEntry": string } ``` |

| Fields ||
|---|---|
| `system` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#IntegratedSystem`)`` Service in which the external table is registered. |
| `fullyQualifiedName` | `string` Fully qualified name (FQN) of the external table. |
| `googleCloudResource` | `string` Google Cloud resource name of the external table. |
| `dataCatalogEntry` | `string` Name of the Data Catalog entry representing the external table. |

## DataplexSpec

Common Dataplex Universal Catalog fields.

| JSON representation |
|---|
| ``` { "asset": string, "dataFormat": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#PhysicalSchema`) }, "compressionFormat": string, "projectId": string } ``` |

| Fields ||
|---|---|
| `asset` | `string` Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. |
| `dataFormat` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#PhysicalSchema`)`` Format of the data. |
| `compressionFormat` | `string` Compression format of the data, e.g., zip, gzip etc. |
| `projectId` | `string` Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. |

## PhysicalSchema

Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data.

| JSON representation |
|---|
| ``` { // Union field `schema` can be only one of the following: "avro": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#AvroSchema`) }, "thrift": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ThriftSchema`) }, "protobuf": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ProtobufSchema`) }, "parquet": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ParquetSchema`) }, "orc": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#OrcSchema`) }, "csv": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CsvSchema`) } // End of list of possible types for union field `schema`. } ``` |

| Fields ||
|---|---|
| Union field `schema`. `schema` can be only one of the following: ||
| `avro` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#AvroSchema`)`` Schema in Avro JSON format. |
| `thrift` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ThriftSchema`)`` Schema in Thrift format. |
| `protobuf` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ProtobufSchema`)`` Schema in protocol buffer format. |
| `parquet` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ParquetSchema`)`` Marks a Parquet-encoded data source. |
| `orc` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#OrcSchema`)`` Marks an ORC-encoded data source. |
| `csv` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CsvSchema`)`` Marks a CSV-encoded data source. |

## AvroSchema

Schema in Avro JSON format.

| JSON representation |
|---|
| ``` { "text": string } ``` |

| Fields ||
|---|---|
| `text` | `string` JSON source of the Avro schema. |

## ThriftSchema

Schema in Thrift format.

| JSON representation |
|---|
| ``` { "text": string } ``` |

| Fields ||
|---|---|
| `text` | `string` Thrift IDL source of the schema. |

## ProtobufSchema

Schema in protocol buffer format.

| JSON representation |
|---|
| ``` { "text": string } ``` |

| Fields ||
|---|---|
| `text` | `string` Protocol buffer source of the schema. |

## ParquetSchema

This type has no fields.
Marks a Parquet-encoded data source.

## OrcSchema

This type has no fields.
Marks an ORC-encoded data source.

## CsvSchema

This type has no fields.
Marks a CSV-encoded data source.

## DatabaseViewSpec

Specification that applies to database view.

| JSON representation |
|---|
| ``` { "viewType": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ViewType`), // Union field `source_definition` can be only one of the following: "baseTable": string, "sqlQuery": string // End of list of possible types for union field `source_definition`. } ``` |

| Fields ||
|---|---|
| `viewType` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ViewType`)`` Type of this view. |
| Union field `source_definition`. Definition of the view. `source_definition` can be only one of the following: ||
| `baseTable` | `string` Name of a singular table this view reflects one to one. |
| `sqlQuery` | `string` SQL query used to generate this view. |

## ViewType

Concrete type of the view.

| Enums ||
|---|---|
| `VIEW_TYPE_UNSPECIFIED` | Default unknown view type. |
| `STANDARD_VIEW` | Standard view. |
| `MATERIALIZED_VIEW` | Materialized view. |

## DataSourceConnectionSpec

Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. Only one of internal specs can be set at the time, and cannot be changed later.

| JSON representation |
|---|
| ``` { "bigqueryConnectionSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryConnectionSpec`) } } ``` |

| Fields ||
|---|---|
| `bigqueryConnectionSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryConnectionSpec`)`` Output only. Fields specific to BigQuery connections. |

## BigQueryConnectionSpec

Specification for the BigQuery connection.

| JSON representation |
|---|
| ``` { "connectionType": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ConnectionType`), "hasCredential": boolean, // Union field `connection_spec` can be only one of the following: "cloudSql": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudSqlBigQueryConnectionSpec`) } // End of list of possible types for union field `connection_spec`. } ``` |

| Fields ||
|---|---|
| `connectionType` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ConnectionType`)`` The type of the BigQuery connection. |
| `hasCredential` | `boolean` True if there are credentials attached to the BigQuery connection; false otherwise. |
| Union field `connection_spec`. `connection_spec` can be only one of the following: ||
| `cloudSql` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudSqlBigQueryConnectionSpec`)`` Specification for the BigQuery connection to a Cloud SQL instance. |

## ConnectionType

The type of the BigQuery connection.

| Enums ||
|---|---|
| `CONNECTION_TYPE_UNSPECIFIED` | Unspecified type. |
| `CLOUD_SQL` | Cloud SQL connection. |

## CloudSqlBigQueryConnectionSpec

Specification for the BigQuery connection to a Cloud SQL instance.

| JSON representation |
|---|
| ``` { "instanceId": string, "database": string, "type": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatabaseType`) } ``` |

| Fields ||
|---|---|
| `instanceId` | `string` Cloud SQL instance ID in the format of `project:location:instance`. |
| `database` | `string` Database name. |
| `type` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DatabaseType`)`` Type of the Cloud SQL database. |

## DatabaseType

Supported Cloud SQL database types.

| Enums ||
|---|---|
| `DATABASE_TYPE_UNSPECIFIED` | Unspecified database type. |
| `POSTGRES` | Cloud SQL for PostgreSQL. |
| `MYSQL` | Cloud SQL for MySQL. |

## RoutineSpec

Specification that applies to a routine. Valid only for entries with the `ROUTINE` type.

| JSON representation |
|---|
| ``` { "routineType": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#RoutineType`), "language": string, "routineArguments": [ { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Argument`) } ], "returnType": string, "definitionBody": string, // Union field `system_spec` can be only one of the following: "bigqueryRoutineSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryRoutineSpec`) } // End of list of possible types for union field `system_spec`. } ``` |

| Fields ||
|---|---|
| `routineType` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#RoutineType`)`` The type of the routine. |
| `language` | `string` The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are: - `SQL` - `JAVASCRIPT` |
| `routineArguments[]` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Argument`)`` Arguments of the routine. |
| `returnType` | `string` Return type of the argument. The exact value depends on the source system and the language. |
| `definitionBody` | `string` The body of the routine. |
| Union field `system_spec`. Contains fields specific to the source system. `system_spec` can be only one of the following: ||
| `bigqueryRoutineSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#BigQueryRoutineSpec`)`` Fields specific for BigQuery routines. |

## RoutineType

The fine-grained type of the routine.

| Enums ||
|---|---|
| `ROUTINE_TYPE_UNSPECIFIED` | Unspecified type. |
| `SCALAR_FUNCTION` | Non-builtin permanent scalar function. |
| `PROCEDURE` | Stored procedure. |

## Argument

Input or output argument of a function or stored procedure.

| JSON representation |
|---|
| ``` { "name": string, "mode": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Mode`), "type": string } ``` |

| Fields ||
|---|---|
| `name` | `string` The name of the argument. A return argument of a function might not have a name. |
| `mode` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Mode`)`` Specifies whether the argument is input or output. |
| `type` | `string` Type of the argument. The exact value depends on the source system and the language. |

## Mode

The input or output mode of the argument.

| Enums ||
|---|---|
| `MODE_UNSPECIFIED` | Unspecified mode. |
| `IN` | The argument is input-only. |
| `OUT` | The argument is output-only. |
| `INOUT` | The argument is both an input and an output. |

## BigQueryRoutineSpec

Fields specific for BigQuery routines.

| JSON representation |
|---|
| ``` { "importedLibraries": [ string ] } ``` |

| Fields ||
|---|---|
| `importedLibraries[]` | `string` Paths of the imported libraries. |

## DatasetSpec

Specification that applies to a dataset. Valid only for entries with the `DATASET` type.

| JSON representation |
|---|
| ``` { // Union field `system_spec` can be only one of the following: "vertexDatasetSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexDatasetSpec`) } // End of list of possible types for union field `system_spec`. } ``` |

| Fields ||
|---|---|
| Union field `system_spec`. Fields specific to the source system. `system_spec` can be only one of the following: ||
| `vertexDatasetSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexDatasetSpec`)`` Vertex AI Dataset specific fields |

## VertexDatasetSpec

Specification for vertex dataset resources.

| JSON representation |
|---|
| ``` { "dataItemCount": string, "dataType": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataType`) } ``` |

| Fields ||
|---|---|
| `dataItemCount` | `string (https://developers.google.com/discovery/v1/type-format format)` The number of DataItems in this Dataset. Only apply for non-structured Dataset. |
| `dataType` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataType`)`` Type of the dataset. |

## DataType

Type of data stored in the dataset.

| Enums ||
|---|---|
| `DATA_TYPE_UNSPECIFIED` | Should not be used. |
| `TABLE` | Structured data dataset. |
| `IMAGE` | Image dataset which supports ImageClassification, ImageObjectDetection and ImageSegmentation problems. |
| `TEXT` | Document dataset which supports TextClassification, TextExtraction and TextSentiment problems. |
| `VIDEO` | Video dataset which supports VideoClassification, VideoObjectTracking and VideoActionRecognition problems. |
| `CONVERSATION` | Conversation dataset which supports conversation problems. |
| `TIME_SERIES` | TimeSeries dataset. |
| `DOCUMENT` | Document dataset which supports DocumentAnnotation problems. |
| `TEXT_TO_SPEECH` | TextToSpeech dataset which supports TextToSpeech problems. |
| `TRANSLATION` | Translation dataset which supports Translation problems. |
| `STORE_VISION` | Store Vision dataset which is used for HITL integration. |
| `ENTERPRISE_KNOWLEDGE_GRAPH` | Enterprise Knowledge Graph dataset which is used for HITL labeling integration. |
| `TEXT_PROMPT` | Text prompt dataset which supports Large Language Models. |

## FilesetSpec

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

| JSON representation |
|---|
| ``` { "dataplexFileset": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexFilesetSpec`) } } ``` |

| Fields ||
|---|---|
| `dataplexFileset` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexFilesetSpec`)`` Fields specific to a Dataplex Universal Catalog fileset and present only in the Dataplex Universal Catalog fileset entries. |

## DataplexFilesetSpec

Entry specification for a Dataplex Universal Catalog fileset.

| JSON representation |
|---|
| ``` { "dataplexSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexSpec`) } } ``` |

| Fields ||
|---|---|
| `dataplexSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#DataplexSpec`)`` Common Dataplex Universal Catalog fields. |

## ServiceSpec

Specification that applies to a Service resource. Valid only for entries with the `SERVICE` type.

| JSON representation |
|---|
| ``` { // Union field `system_spec` can be only one of the following: "cloudBigtableInstanceSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudBigtableInstanceSpec`) } // End of list of possible types for union field `system_spec`. } ``` |

| Fields ||
|---|---|
| Union field `system_spec`. System spec `system_spec` can be only one of the following: ||
| `cloudBigtableInstanceSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudBigtableInstanceSpec`)`` Specification that applies to Instance entries of `CLOUD_BIGTABLE` system. |

## CloudBigtableInstanceSpec

Specification that applies to Instance entries that are part of `CLOUD_BIGTABLE` system. (userSpecifiedType)

| JSON representation |
|---|
| ``` { "cloudBigtableClusterSpecs": [ { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudBigtableClusterSpec`) } ] } ``` |

| Fields ||
|---|---|
| `cloudBigtableClusterSpecs[]` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CloudBigtableClusterSpec`)`` The list of clusters for the Instance. |

## CloudBigtableClusterSpec

Spec that applies to clusters of an Instance of Cloud Bigtable.

| JSON representation |
|---|
| ``` { "displayName": string, "location": string, "type": string, "linkedResource": string } ``` |

| Fields ||
|---|---|
| `displayName` | `string` Name of the cluster. |
| `location` | `string` Location of the cluster, typically a Cloud zone. |
| `type` | `string` Type of the resource. For a cluster this would be "CLUSTER". |
| `linkedResource` | `string` A link back to the parent resource, in this case Instance. |

## ModelSpec

Specification that applies to a model. Valid only for entries with the `MODEL` type.

| JSON representation |
|---|
| ``` { // Union field `system_spec` can be only one of the following: "vertexModelSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexModelSpec`) } // End of list of possible types for union field `system_spec`. } ``` |

| Fields ||
|---|---|
| Union field `system_spec`. System spec `system_spec` can be only one of the following: ||
| `vertexModelSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexModelSpec`)`` Specification for vertex model resources. |

## VertexModelSpec

Specification for vertex model resources.

| JSON representation |
|---|
| ``` { "versionId": string, "versionAliases": [ string ], "versionDescription": string, "vertexModelSourceInfo": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexModelSourceInfo`) }, "containerImageUri": string } ``` |

| Fields ||
|---|---|
| `versionId` | `string` The version ID of the model. |
| `versionAliases[]` | `string` User provided version aliases so that a model version can be referenced via alias |
| `versionDescription` | `string` The description of this version. |
| `vertexModelSourceInfo` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexModelSourceInfo`)`` Source of a Vertex model. |
| `containerImageUri` | `string` URI of the Docker image to be used as the custom container for serving predictions. |

## VertexModelSourceInfo

Detail description of the source information of a Vertex model.

| JSON representation |
|---|
| ``` { "sourceType": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ModelSourceType`), "copy": boolean } ``` |

| Fields ||
|---|---|
| `sourceType` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ModelSourceType`)`` Type of the model source. |
| `copy` | `boolean` If this Model is copy of another Model. If true then `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#VertexModelSourceInfo.FIELDS.source_type` pertains to the original. |

## ModelSourceType

Source of the model.

| Enums ||
|---|---|
| `MODEL_SOURCE_TYPE_UNSPECIFIED` | Should not be used. |
| `AUTOML` | The Model is uploaded by automl training pipeline. |
| `CUSTOM` | The Model is uploaded by user or custom training pipeline. |
| `BQML` | The Model is registered and sync'ed from BigQuery ML. |
| `MODEL_GARDEN` | The Model is saved or tuned from Model Garden. |
| `GENIE` | The Model is saved or tuned from Genie. |
| `CUSTOM_TEXT_EMBEDDING` | The Model is uploaded by text embedding finetuning pipeline. |
| `MARKETPLACE` | The Model is saved or tuned from Marketplace. |

## FeatureOnlineStoreSpec

Detail description of the source information of a Vertex Feature Online Store.

| JSON representation |
|---|
| ``` { "storageType": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#StorageType`) } ``` |

| Fields ||
|---|---|
| `storageType` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#StorageType`)`` Output only. Type of underlying storage for the FeatureOnlineStore. |

## StorageType

Type of underlying storage type.

| Enums ||
|---|---|
| `STORAGE_TYPE_UNSPECIFIED` | Should not be used. |
| `BIGTABLE` | Underlsying storgae is Bigtable. |
| `OPTIMIZED` | Underlying is optimized online server (Lightning). |

## BusinessContext

Business Context of the entry.

| JSON representation |
|---|
| ``` { "entryOverview": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#EntryOverview`) }, "contacts": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Contacts`) } } ``` |

| Fields ||
|---|---|
| `entryOverview` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#EntryOverview`)`` Entry overview fields for rich text descriptions of entries. |
| `contacts` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Contacts`)`` Contact people for the entry. |

## EntryOverview

Entry overview fields for rich text descriptions of entries.

| JSON representation |
|---|
| ``` { "overview": string } ``` |

| Fields ||
|---|---|
| `overview` | `string` Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB. |

## Contacts

Contact people for the entry.

| JSON representation |
|---|
| ``` { "people": [ { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Person`) } ] } ``` |

| Fields ||
|---|---|
| `people[]` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Person`)`` The list of contact people for the entry. |

## Person

A contact person for the entry.

| JSON representation |
|---|
| ``` { "designation": string, "email": string } ``` |

| Fields ||
|---|---|
| `designation` | `string` Designation of the person, for example, Data Steward. |
| `email` | `string` Email of the person in the format of `john.doe@xyz`, `<john.doe@xyz>`, or `John Doe<john.doe@xyz>`. |

## Schema

Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.

| JSON representation |
|---|
| ``` { "columns": [ { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ColumnSchema`) } ] } ``` |

| Fields ||
|---|---|
| `columns[]` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ColumnSchema`)`` The unified GoogleSQL-like schema of columns. The overall maximum number of columns and nested columns is 10,000. The maximum nested depth is 15 levels. |

## ColumnSchema

A column within a schema. Columns can be nested inside other columns.

| JSON representation |
|---|
| ``` { "column": string, "type": string, "description": string, "mode": string, "defaultValue": string, "ordinalPosition": integer, "highestIndexingType": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#IndexingType`), "subcolumns": [ { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ColumnSchema`) } ], "rangeElementType": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#FieldElementType`) }, "gcRule": string, // Union field `system_spec` can be only one of the following: "lookerColumnSpec": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#LookerColumnSpec`) } // End of list of possible types for union field `system_spec`. } ``` |

| Fields ||
|---|---|
| `column` | `string` Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. |
| `type` | `string` Required. Type of the column. Must be a UTF-8 string with the maximum size of 128 bytes. |
| `description` | `string` Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. |
| `mode` | `string` Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. |
| `defaultValue` | `string` Optional. Default value for the column. |
| `ordinalPosition` | `integer` Optional. Ordinal position |
| `highestIndexingType` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#IndexingType`)`` Optional. Most important inclusion of this column. |
| `subcolumns[]` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ColumnSchema`)`` Optional. Schema of sub-columns. A column can have zero or more sub-columns. |
| `rangeElementType` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#FieldElementType`)`` Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: \* DATE \* DATETIME \* TIMESTAMP |
| `gcRule` | `string` Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable. |
| Union field `system_spec`. Information only applying for columns in Entries from a specific system. `system_spec` can be only one of the following: ||
| `lookerColumnSpec` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#LookerColumnSpec`)`` Looker specific column info of this column. |

## IndexingType

Specifies inclusion of the column in an index

| Enums ||
|---|---|
| `INDEXING_TYPE_UNSPECIFIED` | Unspecified. |
| `INDEXING_TYPE_NONE` | Column not a part of an index. |
| `INDEXING_TYPE_NON_UNIQUE` | Column Part of non unique index. |
| `INDEXING_TYPE_UNIQUE` | Column part of unique index. |
| `INDEXING_TYPE_PRIMARY_KEY` | Column part of the primary key. |

## LookerColumnSpec

Column info specific to Looker System.

| JSON representation |
|---|
| ``` { "type": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#LookerColumnType`) } ``` |

| Fields ||
|---|---|
| `type` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#LookerColumnType`)`` Looker specific column type of this column. |

## LookerColumnType

Column type in Looker.

| Enums ||
|---|---|
| `LOOKER_COLUMN_TYPE_UNSPECIFIED` | Unspecified. |
| `DIMENSION` | Dimension. |
| `DIMENSION_GROUP` | Dimension group - parent for Dimension. |
| `FILTER` | Filter. |
| `MEASURE` | Measure. |
| `PARAMETER` | Parameter. |

## FieldElementType

Represents the type of a field element.

| JSON representation |
|---|
| ``` { "type": string } ``` |

| Fields ||
|---|---|
| `type` | `string` Required. The type of a field element. See `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#ColumnSchema.FIELDS.type`. |

## UsageSignal

The set of all usage signals that Data Catalog stores.

Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day.

| JSON representation |
|---|
| ``` { "updateTime": string, "usageWithinTimeRange": { string: { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#UsageStats`) }, ... }, "commonUsageWithinTimeRange": { string: { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CommonUsageStats`) }, ... }, "favoriteCount": string } ``` |

| Fields ||
|---|---|
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` The end timestamp of the duration of usage statistics. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `usageWithinTimeRange` | ``map (key: string, value: object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#UsageStats`))`` Output only. BigQuery usage statistics over each of the predefined time ranges. Supported time ranges are `{"24H", "7D", "30D"}`. |
| `commonUsageWithinTimeRange` | ``map (key: string, value: object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#CommonUsageStats`))`` Common usage statistics over each of the predefined time ranges. Supported time ranges are `{"24H", "7D", "30D", "Lifetime"}`. |
| `favoriteCount` | `string (https://developers.google.com/discovery/v1/type-format format)` Favorite count in the source system. |

## UsageStats

Detailed statistics on the entry's usage.

Usage statistics have the following limitations:

- Only BigQuery tables have them.
- They only include BigQuery query jobs.
- They might be underestimated because wildcard table references are not yet counted. For more information, see [Querying multiple tables using a wildcard table](https://cloud.google.com/bigquery/docs/querying-wildcard-tables)

| JSON representation |
|---|
| ``` { "totalCompletions": number, "totalFailures": number, "totalCancellations": number, "totalExecutionTimeForCompletionsMillis": number } ``` |

| Fields ||
|---|---|
| `totalCompletions` | `number` The number of successful uses of the underlying entry. |
| `totalFailures` | `number` The number of failed attempts to use the underlying entry. |
| `totalCancellations` | `number` The number of cancelled attempts to use the underlying entry. |
| `totalExecutionTimeForCompletionsMillis` | `number` Total time spent only on successful uses, in milliseconds. |

## CommonUsageStats

Common statistics on the entry's usage.

They can be set on any system.

| JSON representation |
|---|
| ``` { "viewCount": string } ``` |

| Fields ||
|---|---|
| `viewCount` | `string (https://developers.google.com/discovery/v1/type-format format)` View count in source system. |

## DataSource

Physical location of an entry.

| JSON representation |
|---|
| ``` { "service": enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Service`), "resource": string, "sourceEntry": string, // Union field `properties` can be only one of the following: "storageProperties": { object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#StorageProperties`) } // End of list of possible types for union field `properties`. } ``` |

| Fields ||
|---|---|
| `service` | ``enum (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Service`)`` Service that physically stores the data. |
| `resource` | `string` Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}` |
| `sourceEntry` | `string` Output only. Data Catalog entry name, if applicable. |
| Union field `properties`. `properties` can be only one of the following: ||
| `storageProperties` | ``object (`https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#StorageProperties`)`` Detailed properties of the underlying storage. |

## Service

Name of a service that stores the data.

| Enums ||
|---|---|
| `SERVICE_UNSPECIFIED` | Default unknown service. |
| `CLOUD_STORAGE` | Google Cloud Storage service. |
| `BIGQUERY` | BigQuery service. |

## StorageProperties

Details the properties of the underlying storage.

| JSON representation |
|---|
| ``` { "filePattern": [ string ], "fileType": string } ``` |

| Fields ||
|---|---|
| `filePattern[]` | `string` Patterns to identify a set of files for this fileset. Examples of a valid `filePattern`: - `gs://bucket_name/dir/*`: matches all files in the `bucket_name/dir` directory - `gs://bucket_name/dir/**`: matches all files in the `bucket_name/dir` and all subdirectories recursively - `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` - `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` - `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` - `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` - `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` - `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` |
| `fileType` | `string` File type in MIME format, for example, `text/plain`. |

## PersonalDetails

Entry metadata relevant only to the user and private to them.

| JSON representation |
|---|
| ``` { "starred": boolean, "starTime": string } ``` |

| Fields ||
|---|---|
| `starred` | `boolean` True if the entry is starred by the user; false otherwise. |
| `starTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Set if the entry is starred; unset otherwise. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries/create (deprecated)` | Creates an entry. |
| ### `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries/delete (deprecated)` | Deletes an existing entry. |
| ### `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries/get (deprecated)` | Gets an entry. |
| ### `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries/getIamPolicy (deprecated)` | Gets the access control policy for a resource. |
| ### `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries/list (deprecated)` | Lists entries. |
| ### `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries/modifyEntryContacts (deprecated)` | Modifies contacts, part of the business context of an `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Entry`. |
| ### `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries/modifyEntryOverview (deprecated)` | Modifies entry overview, part of the business context of an `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Entry`. |
| ### `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries/patch (deprecated)` | Updates an existing entry. |
| ### `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries/star (deprecated)` | Marks an `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Entry` as starred by the current user. |
| ### `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries/testIamPermissions (deprecated)` | Gets your permissions on a resource. |
| ### `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries/unstar (deprecated)` | Marks an `https://docs.cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#Entry` as NOT starred by the current user. |