googleapis/google/cloud/dataplex/v1/data_documentation.proto

// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package google.cloud.dataplex.v1;

import "google/api/field_behavior.proto";

option go_package = "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb";
option java_multiple_files = true;
option java_outer_classname = "DataDocumentationProto";
option java_package = "com.google.cloud.dataplex.v1";

// DataDocumentation scan related spec.
message DataDocumentationSpec {
  // The data documentation generation scope. This field contains the possible
  // components of a data documentation scan which can be selectively generated.
  enum GenerationScope {
    // Unspecified generation scope. If no generation scope is specified, all
    // available documentation components will be generated.
    GENERATION_SCOPE_UNSPECIFIED = 0;

    // All the possible results will be generated.
    ALL = 1;

    // Table and column descriptions will be generated.
    TABLE_AND_COLUMN_DESCRIPTIONS = 2;

    // SQL queries will be generated.
    SQL_QUERIES = 3;
  }

  // Optional. Whether to publish result to Dataplex Catalog.
  bool catalog_publishing_enabled = 2 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Specifies which components of the data documentation to generate.
  // Any component that is required to generate the specified components will
  // also be generated. If no generation scope is specified, all available
  // documentation components will be generated.
  repeated GenerationScope generation_scopes = 3
      [(google.api.field_behavior) = OPTIONAL];
}

// The output of a DataDocumentation scan.
message DataDocumentationResult {
  // Generated metadata about the table.
  message TableResult {
    // Output only. The service-qualified full resource name of the cloud
    // resource. Ex:
    // //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
    string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

    // Output only. Generated description of the table.
    string overview = 2 [(google.api.field_behavior) = OUTPUT_ONLY];

    // Output only. Schema of the table with generated metadata of the columns
    // in the schema.
    Schema schema = 3 [(google.api.field_behavior) = OUTPUT_ONLY];

    // Output only. Sample SQL queries for the table.
    repeated Query queries = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
  }

  // A sample SQL query in data documentation.
  message Query {
    // Output only. The SQL query string which can be executed.
    string sql = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

    // Output only. The description for the query.
    string description = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  }

  // Schema of the table with generated metadata of columns.
  message Schema {
    // Output only. The list of columns.
    repeated Field fields = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  }

  // Column of a table with generated metadata and nested fields.
  message Field {
    // Output only. The name of the column.
    string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

    // Output only. Generated description for columns and fields.
    string description = 2 [(google.api.field_behavior) = OUTPUT_ONLY];

    // Output only. Nested fields.
    repeated Field fields = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
  }

  // The result of the data documentation scan.
  oneof result {
    // Output only. Table result for insights.
    TableResult table_result = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
  }
}