--- title: "POST /v1/{+parent}/entries" method: POST path: "/v1/{+parent}/entries" tags: ["projects"] --- # POST /v1/{+parent}/entries `POST /v1/{+parent}/entries` Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). An entry group can have a maximum of 100,000 entries. ## Path parameters - `parent` string, required ## Query parameters - `entryId` string ## Request body - 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. - `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, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#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. - `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. - `type` 'ENTRY_TYPE_UNSPECIFIED' | 'TABLE' | 'MODEL' | 'DATA_STREAM' | 'FILESET' | 'CLUSTER' | 'DATABASE' | 'DATA_SOURCE_CONNECTION' | 'ROUTINE' | 'LAKE' | 'ZONE' | 'SERVICE' | 'DATABASE_SCHEMA' | 'DASHBOARD' | 'EXPLORE' | 'LOOK' | 'FEATURE_ONLINE_STORE' | 'FEATURE_VIEW' | 'FEATURE_GROUP' | 'GRAPH' — The type of the entry. For details, see [`EntryType`](#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 `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. - `integratedSystem` 'INTEGRATED_SYSTEM_UNSPECIFIED' | 'BIGQUERY' | 'CLOUD_PUBSUB' | 'DATAPROC_METASTORE' | 'DATAPLEX' | 'CLOUD_SPANNER' | 'CLOUD_BIGTABLE' | 'CLOUD_SQL' | 'LOOKER' | 'VERTEX_AI' — 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 `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. - `sqlDatabaseSystemSpec` GoogleCloudDatacatalogV1SqlDatabaseSystemSpec — Specification that applies to entries that are part `SQL_DATABASE` system (user_specified_type) - `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` GoogleCloudDatacatalogV1LookerSystemSpec — Specification that applies to entries that are part `LOOKER` system (user_specified_type) - `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` GoogleCloudDatacatalogV1CloudBigtableSystemSpec — Specification that applies to all entries that are part of `CLOUD_BIGTABLE` system (user_specified_type) - `instanceDisplayName` string — Display name of the Instance. This is user specified and different from the resource name. - `gcsFilesetSpec` GoogleCloudDatacatalogV1GcsFilesetSpec — Describes a Cloud Storage fileset entry. - `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 `file_patterns`: * `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` GoogleCloudDatacatalogV1GcsFileSpec[] — Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here. - `filePath` string — Required. Full file path. Example: `gs://bucket_name/a/b.txt`. - `gcsTimestamps` GoogleCloudDatacatalogV1SystemTimestamps — Timestamps associated with this resource in a particular system. - `createTime` string, google-datetime — Creation timestamp of the resource within the given system. - `updateTime` string, google-datetime — Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes. - `expireTime` string, google-datetime — Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. - `sizeBytes` string, int64 — Output only. File size in bytes. - `bigqueryTableSpec` GoogleCloudDatacatalogV1BigQueryTableSpec — Describes a BigQuery table. - `tableSourceType` 'TABLE_SOURCE_TYPE_UNSPECIFIED' | 'BIGQUERY_VIEW' | 'BIGQUERY_TABLE' | 'BIGQUERY_MATERIALIZED_VIEW' — Output only. The table source type. - `viewSpec` GoogleCloudDatacatalogV1ViewSpec — Table view specification. - `viewQuery` string — Output only. The query that defines the table view. - `tableSpec` GoogleCloudDatacatalogV1TableSpec — Normal BigQuery table specification. - `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, `grouped_entry` is empty. - `bigqueryDateShardedSpec` GoogleCloudDatacatalogV1BigQueryDateShardedSpec — 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). - `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 `[table_prefix]YYYYMMDD`. For example, for the `MyTable20180101` shard, the `table_prefix` is `MyTable`. - `shardCount` string, int64 — Output only. Total number of shards. - `latestShardResource` string — Output only. BigQuery resource name of the latest shard. - `databaseTableSpec` GoogleCloudDatacatalogV1DatabaseTableSpec — Specification that applies to a table resource. Valid only for entries with the `TABLE` type. - `type` 'TABLE_TYPE_UNSPECIFIED' | 'NATIVE' | 'EXTERNAL' — Type of this table. - `dataplexTable` GoogleCloudDatacatalogV1DataplexTableSpec — Entry specification for a Dataplex Universal Catalog table. - `externalTables` GoogleCloudDatacatalogV1DataplexExternalTable[] — 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. - `system` 'INTEGRATED_SYSTEM_UNSPECIFIED' | 'BIGQUERY' | 'CLOUD_PUBSUB' | 'DATAPROC_METASTORE' | 'DATAPLEX' | 'CLOUD_SPANNER' | 'CLOUD_BIGTABLE' | 'CLOUD_SQL' | 'LOOKER' | 'VERTEX_AI' — 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` GoogleCloudDatacatalogV1DataplexSpec — Common Dataplex Universal Catalog 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` GoogleCloudDatacatalogV1PhysicalSchema — Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. - `avro` GoogleCloudDatacatalogV1PhysicalSchemaAvroSchema — Schema in Avro JSON format. - `text` string — JSON source of the Avro schema. - `thrift` GoogleCloudDatacatalogV1PhysicalSchemaThriftSchema — Schema in Thrift format. - `text` string — Thrift IDL source of the schema. - `protobuf` GoogleCloudDatacatalogV1PhysicalSchemaProtobufSchema — Schema in protocol buffer format. - `text` string — Protocol buffer source of the schema. - `parquet` GoogleCloudDatacatalogV1PhysicalSchemaParquetSchema — Marks a Parquet-encoded data source. - `orc` GoogleCloudDatacatalogV1PhysicalSchemaOrcSchema — Marks an ORC-encoded data source. - `csv` GoogleCloudDatacatalogV1PhysicalSchemaCsvSchema — Marks a CSV-encoded data source. - `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. - `userManaged` boolean — Indicates if the table schema is managed by the user or not. - `databaseViewSpec` GoogleCloudDatacatalogV1DatabaseTableSpecDatabaseViewSpec — Specification that applies to database view. - `viewType` 'VIEW_TYPE_UNSPECIFIED' | 'STANDARD_VIEW' | 'MATERIALIZED_VIEW' — Type of this view. - `baseTable` string — Name of a singular table this view reflects one to one. - `sqlQuery` string — SQL query used to generate this view. - `dataSourceConnectionSpec` GoogleCloudDatacatalogV1DataSourceConnectionSpec — 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. - `bigqueryConnectionSpec` GoogleCloudDatacatalogV1BigQueryConnectionSpec — Specification for the BigQuery connection. - `connectionType` 'CONNECTION_TYPE_UNSPECIFIED' | 'CLOUD_SQL' — The type of the BigQuery connection. - `cloudSql` GoogleCloudDatacatalogV1CloudSqlBigQueryConnectionSpec — Specification for the BigQuery connection to a Cloud SQL instance. - `instanceId` string — Cloud SQL instance ID in the format of `project:location:instance`. - `database` string — Database name. - `type` 'DATABASE_TYPE_UNSPECIFIED' | 'POSTGRES' | 'MYSQL' — Type of the Cloud SQL database. - `hasCredential` boolean — True if there are credentials attached to the BigQuery connection; false otherwise. - `routineSpec` GoogleCloudDatacatalogV1RoutineSpec — Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. - `routineType` 'ROUTINE_TYPE_UNSPECIFIED' | 'SCALAR_FUNCTION' | 'PROCEDURE' — 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` GoogleCloudDatacatalogV1RoutineSpecArgument[] — Arguments of the routine. - `name` string — The name of the argument. A return argument of a function might not have a name. - `mode` 'MODE_UNSPECIFIED' | 'IN' | 'OUT' | 'INOUT' — 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. - `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. - `bigqueryRoutineSpec` GoogleCloudDatacatalogV1BigQueryRoutineSpec — Fields specific for BigQuery routines. - `importedLibraries` string[] — Paths of the imported libraries. - `datasetSpec` GoogleCloudDatacatalogV1DatasetSpec — Specification that applies to a dataset. Valid only for entries with the `DATASET` type. - `vertexDatasetSpec` GoogleCloudDatacatalogV1VertexDatasetSpec — Specification for vertex dataset resources. - `dataItemCount` string, int64 — The number of DataItems in this Dataset. Only apply for non-structured Dataset. - `dataType` 'DATA_TYPE_UNSPECIFIED' | 'TABLE' | 'IMAGE' | 'TEXT' | 'VIDEO' | 'CONVERSATION' | 'TIME_SERIES' | 'DOCUMENT' | 'TEXT_TO_SPEECH' | 'TRANSLATION' | 'STORE_VISION' | 'ENTERPRISE_KNOWLEDGE_GRAPH' | 'TEXT_PROMPT' — Type of the dataset. - `filesetSpec` GoogleCloudDatacatalogV1FilesetSpec — Specification that applies to a fileset. Valid only for entries with the 'FILESET' type. - `dataplexFileset` GoogleCloudDatacatalogV1DataplexFilesetSpec — Entry specification for a Dataplex Universal Catalog fileset. - `dataplexSpec` GoogleCloudDatacatalogV1DataplexSpec — Common Dataplex Universal Catalog 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` GoogleCloudDatacatalogV1PhysicalSchema — Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. - `avro` GoogleCloudDatacatalogV1PhysicalSchemaAvroSchema — Schema in Avro JSON format. - `text` string — JSON source of the Avro schema. - `thrift` GoogleCloudDatacatalogV1PhysicalSchemaThriftSchema — Schema in Thrift format. - `text` string — Thrift IDL source of the schema. - `protobuf` GoogleCloudDatacatalogV1PhysicalSchemaProtobufSchema — Schema in protocol buffer format. - `text` string — Protocol buffer source of the schema. - `parquet` GoogleCloudDatacatalogV1PhysicalSchemaParquetSchema — Marks a Parquet-encoded data source. - `orc` GoogleCloudDatacatalogV1PhysicalSchemaOrcSchema — Marks an ORC-encoded data source. - `csv` GoogleCloudDatacatalogV1PhysicalSchemaCsvSchema — Marks a CSV-encoded data source. - `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. - `serviceSpec` GoogleCloudDatacatalogV1ServiceSpec — Specification that applies to a Service resource. Valid only for entries with the `SERVICE` type. - `cloudBigtableInstanceSpec` GoogleCloudDatacatalogV1CloudBigtableInstanceSpec — Specification that applies to Instance entries that are part of `CLOUD_BIGTABLE` system. (user_specified_type) - `cloudBigtableClusterSpecs` GoogleCloudDatacatalogV1CloudBigtableInstanceSpecCloudBigtableClusterSpec[] — The list of clusters for the Instance. - `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` GoogleCloudDatacatalogV1ModelSpec — Specification that applies to a model. Valid only for entries with the `MODEL` type. - `vertexModelSpec` GoogleCloudDatacatalogV1VertexModelSpec — Specification for vertex model resources. - `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` GoogleCloudDatacatalogV1VertexModelSourceInfo — Detail description of the source information of a Vertex model. - `sourceType` 'MODEL_SOURCE_TYPE_UNSPECIFIED' | 'AUTOML' | 'CUSTOM' | 'BQML' | 'MODEL_GARDEN' | 'GENIE' | 'CUSTOM_TEXT_EMBEDDING' | 'MARKETPLACE' — Type of the model source. - `copy` boolean — If this Model is copy of another Model. If true then source_type pertains to the original. - `containerImageUri` string — URI of the Docker image to be used as the custom container for serving predictions. - `featureOnlineStoreSpec` GoogleCloudDatacatalogV1FeatureOnlineStoreSpec — Detail description of the source information of a Vertex Feature Online Store. - `storageType` 'STORAGE_TYPE_UNSPECIFIED' | 'BIGTABLE' | 'OPTIMIZED' — Output only. Type of underlying storage for the FeatureOnlineStore. - `graphSpec` GoogleCloudDatacatalogV1GraphSpec — Specification that applies to a graph. - `name` string — Output only. Fully qualified graph name. e.g. `named_catalog.MyGraph` - `nodeTables` GoogleCloudDatacatalogV1GraphSpecGraphElementTable[] — Required. Node tables of the graph. - `dataSource` string — Required. The name of the data source. This is either a table name or a view name that is used for graph element input source. E.g. `Person` table or `PersonView` view. - `alias` string — Required. The alias name of the graph element. - `kind` 'KIND_UNSPECIFIED' | 'NODE' | 'EDGE' — Required. The kind of the graph element. - `inputSource` 'INPUT_SOURCE_UNSPECIFIED' | 'TABLE' | 'VIEW' — Required. The input source of the graph element. - `elementKeys` string[] — Required. The name of the keys of the elements in the table. - `labelAndProperties` GoogleCloudDatacatalogV1GraphSpecGraphElementTableLabelAndProperties[] — Required. The labels and their properties for the graph element. - `label` string — Required. The name of the label. - `properties` GoogleCloudDatacatalogV1GraphSpecGraphElementTableProperty[] — Optional. The properties associated with the label. - `name` string — Required. Property name. - `type` string — Required. Property data type. - `dynamicLabelColumn` string — Optional. If set, this is the input column for dynamic label in schemaless data model. - `dynamicPropertiesColumn` string — Optional. If set, this is the input column for dynamic properties in schemaless data model. - `sourceNodeReference` GoogleCloudDatacatalogV1GraphSpecGraphElementTableGraphNodeReference — A reference to a source or destination node in a graph edge. - `nodeAlias` string — Required. The reference to the source/destination node of the edge. This name must be a valid `alias` of a node element in the same graph. Example, `Person` node can be a source node name of an edge element `Person_to_Address`. - `edgeTableColumns` string[] — Required. The referencing columns in the edge table. The size of `edge_table_columns` must be equal to the size of `node_table_columns`. - `nodeTableColumns` string[] — Required. The referenced columns of the source node table. - `destinationNodeReference` GoogleCloudDatacatalogV1GraphSpecGraphElementTableGraphNodeReference — A reference to a source or destination node in a graph edge. - `nodeAlias` string — Required. The reference to the source/destination node of the edge. This name must be a valid `alias` of a node element in the same graph. Example, `Person` node can be a source node name of an edge element `Person_to_Address`. - `edgeTableColumns` string[] — Required. The referencing columns in the edge table. The size of `edge_table_columns` must be equal to the size of `node_table_columns`. - `nodeTableColumns` string[] — Required. The referenced columns of the source node table. - `edgeTables` GoogleCloudDatacatalogV1GraphSpecGraphElementTable[] — Optional. Edge tables of the graph. - `dataSource` string — Required. The name of the data source. This is either a table name or a view name that is used for graph element input source. E.g. `Person` table or `PersonView` view. - `alias` string — Required. The alias name of the graph element. - `kind` 'KIND_UNSPECIFIED' | 'NODE' | 'EDGE' — Required. The kind of the graph element. - `inputSource` 'INPUT_SOURCE_UNSPECIFIED' | 'TABLE' | 'VIEW' — Required. The input source of the graph element. - `elementKeys` string[] — Required. The name of the keys of the elements in the table. - `labelAndProperties` GoogleCloudDatacatalogV1GraphSpecGraphElementTableLabelAndProperties[] — Required. The labels and their properties for the graph element. - `label` string — Required. The name of the label. - `properties` GoogleCloudDatacatalogV1GraphSpecGraphElementTableProperty[] — Optional. The properties associated with the label. - `name` string — Required. Property name. - `type` string — Required. Property data type. - `dynamicLabelColumn` string — Optional. If set, this is the input column for dynamic label in schemaless data model. - `dynamicPropertiesColumn` string — Optional. If set, this is the input column for dynamic properties in schemaless data model. - `sourceNodeReference` GoogleCloudDatacatalogV1GraphSpecGraphElementTableGraphNodeReference — A reference to a source or destination node in a graph edge. - `nodeAlias` string — Required. The reference to the source/destination node of the edge. This name must be a valid `alias` of a node element in the same graph. Example, `Person` node can be a source node name of an edge element `Person_to_Address`. - `edgeTableColumns` string[] — Required. The referencing columns in the edge table. The size of `edge_table_columns` must be equal to the size of `node_table_columns`. - `nodeTableColumns` string[] — Required. The referenced columns of the source node table. - `destinationNodeReference` GoogleCloudDatacatalogV1GraphSpecGraphElementTableGraphNodeReference — A reference to a source or destination node in a graph edge. - `nodeAlias` string — Required. The reference to the source/destination node of the edge. This name must be a valid `alias` of a node element in the same graph. Example, `Person` node can be a source node name of an edge element `Person_to_Address`. - `edgeTableColumns` string[] — Required. The referencing columns in the edge table. The size of `edge_table_columns` must be equal to the size of `node_table_columns`. - `nodeTableColumns` string[] — Required. The referenced columns of the source node table. - `spannerTableSpec` GoogleCloudDatacatalogV1SpannerTableSpec — Specification of a Spanner table. - `primaryKey` GoogleCloudDatacatalogV1SpannerTableSpecSpannerPrimaryKey — Specification of a Spanner primary key. - `columns` string[] — Output only. Column names of the primary key. - `foreignKeys` GoogleCloudDatacatalogV1SpannerTableSpecSpannerForeignKey[] — Output only. The foreign keys of the table. - `name` string — Output only. The constraint_name of the foreign key, for example, FK_CustomerOrder. - `entry` string — Output only. The table name this foreign key referenced to. Format: `projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}` - `columnMappings` GoogleCloudDatacatalogV1SpannerTableSpecSpannerForeignKeyForeignKeyColumnMapping[] — Output only. The ordered list of column mappings for this foreign key. - `column` string — Output only. The column in the current table that is part of the foreign key. - `referenceColumn` string — Output only. The column in the referenced table that is part of the foreign key. - `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` GoogleCloudDatacatalogV1BusinessContext — Business Context of the entry. - `entryOverview` GoogleCloudDatacatalogV1EntryOverview — Entry overview fields for rich text descriptions of entries. - `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` GoogleCloudDatacatalogV1Contacts — Contact people for the entry. - `people` GoogleCloudDatacatalogV1ContactsPerson[] — The list of contact people for the entry. - `designation` string — Designation of the person, for example, Data Steward. - `email` string — Email of the person in the format of `john.doe@xyz`, ``, or `John Doe`. - `schema` GoogleCloudDatacatalogV1Schema — Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. - `columns` GoogleCloudDatacatalogV1ColumnSchema[] — 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. - `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` 'INDEXING_TYPE_UNSPECIFIED' | 'INDEXING_TYPE_NONE' | 'INDEXING_TYPE_NON_UNIQUE' | 'INDEXING_TYPE_UNIQUE' | 'INDEXING_TYPE_PRIMARY_KEY' — Optional. Most important inclusion of this column. - `subcolumns` GoogleCloudDatacatalogV1ColumnSchema[] — Optional. Schema of sub-columns. A column can have zero or more sub-columns. - `lookerColumnSpec` GoogleCloudDatacatalogV1ColumnSchemaLookerColumnSpec — Column info specific to Looker System. - `type` 'LOOKER_COLUMN_TYPE_UNSPECIFIED' | 'DIMENSION' | 'DIMENSION_GROUP' | 'FILTER' | 'MEASURE' | 'PARAMETER' — Looker specific column type of this column. - `rangeElementType` GoogleCloudDatacatalogV1ColumnSchemaFieldElementType — Represents the type of a field element. - `type` string — Required. The type of a field element. See ColumnSchema.type. - `gcRule` string — Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable. - `sourceSystemTimestamps` GoogleCloudDatacatalogV1SystemTimestamps — Timestamps associated with this resource in a particular system. - `createTime` string, google-datetime — Creation timestamp of the resource within the given system. - `updateTime` string, google-datetime — Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes. - `expireTime` string, google-datetime — Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. - `usageSignal` GoogleCloudDatacatalogV1UsageSignal — 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. - `updateTime` string, google-datetime — The end timestamp of the duration of usage statistics. - `usageWithinTimeRange` object — Output only. BigQuery usage statistics over each of the predefined time ranges. Supported time ranges are `{"24H", "7D", "30D"}`. - `commonUsageWithinTimeRange` object — Common usage statistics over each of the predefined time ranges. Supported time ranges are `{"24H", "7D", "30D", "Lifetime"}`. - `favoriteCount` string, int64 — Favorite count in the source system. - `labels` object — 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` GoogleCloudDatacatalogV1DataSource — Physical location of an entry. - `service` 'SERVICE_UNSPECIFIED' | 'CLOUD_STORAGE' | 'BIGQUERY' — 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. - `storageProperties` GoogleCloudDatacatalogV1StorageProperties — Details the properties of the underlying storage. - `filePattern` string[] — Patterns to identify a set of files for this fileset. Examples of a valid `file_pattern`: * `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` GoogleCloudDatacatalogV1PersonalDetails — Entry metadata relevant only to the user and private to them. - `starred` boolean — True if the entry is starred by the user; false otherwise. - `starTime` string, google-datetime — Set if the entry is starred; unset otherwise. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/datacatalog.md) · [All operations](https://skmtc.net/google/apis/datacatalog/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/datacatalog/revisions/d65a3d49b170/schema)