Class: Google::Cloud::Dataplex::V1::DataDocumentationResult

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/data_documentation.rb

Overview

The output of a DataDocumentation scan.

Defined Under Namespace

Classes: Field, Query, Schema, TableResult

Instance Attribute Summary collapse

Instance Attribute Details

#table_result ⇒ ::Google::Cloud::Dataplex::V1::DataDocumentationResult::TableResult (readonly)

Returns Output only. Table result for insights.

Returns:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/dataplex/v1/data_documentation.rb', line 34

class DataDocumentationResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Generated metadata about the table.
  # @!attribute [r] name
  #   @return [::String]
  #     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
  # @!attribute [r] overview
  #   @return [::String]
  #     Output only. Generated description of the table.
  # @!attribute [r] schema
  #   @return [::Google::Cloud::Dataplex::V1::DataDocumentationResult::Schema]
  #     Output only. Schema of the table with generated metadata of the columns
  #     in the schema.
  # @!attribute [r] queries
  #   @return [::Array<::Google::Cloud::Dataplex::V1::DataDocumentationResult::Query>]
  #     Output only. Sample SQL queries for the table.
  class TableResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A sample SQL query in data documentation.
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. The SQL query string which can be executed.
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. The description for the query.
  class Query
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Schema of the table with generated metadata of columns.
  # @!attribute [r] fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::DataDocumentationResult::Field>]
  #     Output only. The list of columns.
  class Schema
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Column of a table with generated metadata and nested fields.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the column.
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. Generated description for columns and fields.
  # @!attribute [r] fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::DataDocumentationResult::Field>]
  #     Output only. Nested fields.
  class Field
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end