1// Copyright 2023 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.cloud.datacatalog.v1; 18 19import "google/cloud/datacatalog/v1/common.proto"; 20import "google/cloud/datacatalog/v1/physical_schema.proto"; 21 22option cc_enable_arenas = true; 23option csharp_namespace = "Google.Cloud.DataCatalog.V1"; 24option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb"; 25option java_multiple_files = true; 26option java_outer_classname = "DataplexSpecProto"; 27option java_package = "com.google.cloud.datacatalog.v1"; 28option php_namespace = "Google\\Cloud\\DataCatalog\\V1"; 29option ruby_package = "Google::Cloud::DataCatalog::V1"; 30 31// Common Dataplex fields. 32message DataplexSpec { 33 // Fully qualified resource name of an asset in Dataplex, to which the 34 // underlying data source (Cloud Storage bucket or BigQuery dataset) of the 35 // entity is attached. 36 string asset = 1; 37 38 // Format of the data. 39 PhysicalSchema data_format = 2; 40 41 // Compression format of the data, e.g., zip, gzip etc. 42 string compression_format = 3; 43 44 // Project ID of the underlying Cloud Storage or BigQuery data. Note that 45 // this may not be the same project as the correspondingly Dataplex lake / 46 // zone / asset. 47 string project_id = 4; 48} 49 50// Entry specyfication for a Dataplex fileset. 51message DataplexFilesetSpec { 52 // Common Dataplex fields. 53 DataplexSpec dataplex_spec = 1; 54} 55 56// Entry specification for a Dataplex table. 57message DataplexTableSpec { 58 // List of external tables registered by Dataplex in other systems based on 59 // the same underlying data. 60 // 61 // External tables allow to query this data in those systems. 62 repeated DataplexExternalTable external_tables = 1; 63 64 // Common Dataplex fields. 65 DataplexSpec dataplex_spec = 2; 66 67 // Indicates if the table schema is managed by the user or not. 68 bool user_managed = 3; 69} 70 71// External table registered by Dataplex. 72// Dataplex publishes data discovered from an asset into multiple other systems 73// (BigQuery, DPMS) in form of tables. We call them "external tables". External 74// tables are also synced into the Data Catalog. 75// This message contains pointers to 76// those external tables (fully qualified name, resource name et cetera) within 77// the Data Catalog. 78message DataplexExternalTable { 79 // Service in which the external table is registered. 80 IntegratedSystem system = 1; 81 82 // Fully qualified name (FQN) of the external table. 83 string fully_qualified_name = 28; 84 85 // Google Cloud resource name of the external table. 86 string google_cloud_resource = 3; 87 88 // Name of the Data Catalog entry representing the external table. 89 string data_catalog_entry = 4; 90} 91