Class: Google::Cloud::DataCatalog::V1::ColumnSchema
- Inherits:
-
Object
- Object
- Google::Cloud::DataCatalog::V1::ColumnSchema
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/datacatalog/v1/schema.rb
Overview
A column within a schema. Columns can be nested inside other columns.
Defined Under Namespace
Modules: IndexingType Classes: FieldElementType, LookerColumnSpec
Instance Attribute Summary collapse
-
#column ⇒ ::String
Required.
-
#default_value ⇒ ::String
Optional.
-
#description ⇒ ::String
Optional.
-
#gc_rule ⇒ ::String
Optional.
-
#highest_indexing_type ⇒ ::Google::Cloud::DataCatalog::V1::ColumnSchema::IndexingType
Optional.
-
#looker_column_spec ⇒ ::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec
Looker specific column info of this column.
-
#mode ⇒ ::String
Optional.
-
#ordinal_position ⇒ ::Integer
Optional.
-
#range_element_type ⇒ ::Google::Cloud::DataCatalog::V1::ColumnSchema::FieldElementType
Optional.
-
#subcolumns ⇒ ::Array<::Google::Cloud::DataCatalog::V1::ColumnSchema>
Optional.
-
#type ⇒ ::String
Required.
Instance Attribute Details
#column ⇒ ::String
Returns Required. Name of the column.
Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 90 class ColumnSchema include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column info specific to Looker System. # @!attribute [rw] type # @return [::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec::LookerColumnType] # Looker specific column type of this column. class LookerColumnSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column type in Looker. module LookerColumnType # Unspecified. LOOKER_COLUMN_TYPE_UNSPECIFIED = 0 # Dimension. DIMENSION = 1 # Dimension group - parent for Dimension. DIMENSION_GROUP = 2 # Filter. FILTER = 3 # Measure. MEASURE = 4 # Parameter. PARAMETER = 5 end end # Represents the type of a field element. # @!attribute [rw] type # @return [::String] # Required. The type of a field element. See # {::Google::Cloud::DataCatalog::V1::ColumnSchema#type ColumnSchema.type}. class FieldElementType include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies inclusion of the column in an index module IndexingType # Unspecified. INDEXING_TYPE_UNSPECIFIED = 0 # Column not a part of an index. INDEXING_TYPE_NONE = 1 # Column Part of non unique index. INDEXING_TYPE_NON_UNIQUE = 2 # Column part of unique index. INDEXING_TYPE_UNIQUE = 3 # Column part of the primary key. INDEXING_TYPE_PRIMARY_KEY = 4 end end |
#default_value ⇒ ::String
Returns Optional. Default value for the column.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 90 class ColumnSchema include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column info specific to Looker System. # @!attribute [rw] type # @return [::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec::LookerColumnType] # Looker specific column type of this column. class LookerColumnSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column type in Looker. module LookerColumnType # Unspecified. LOOKER_COLUMN_TYPE_UNSPECIFIED = 0 # Dimension. DIMENSION = 1 # Dimension group - parent for Dimension. DIMENSION_GROUP = 2 # Filter. FILTER = 3 # Measure. MEASURE = 4 # Parameter. PARAMETER = 5 end end # Represents the type of a field element. # @!attribute [rw] type # @return [::String] # Required. The type of a field element. See # {::Google::Cloud::DataCatalog::V1::ColumnSchema#type ColumnSchema.type}. class FieldElementType include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies inclusion of the column in an index module IndexingType # Unspecified. INDEXING_TYPE_UNSPECIFIED = 0 # Column not a part of an index. INDEXING_TYPE_NONE = 1 # Column Part of non unique index. INDEXING_TYPE_NON_UNIQUE = 2 # Column part of unique index. INDEXING_TYPE_UNIQUE = 3 # Column part of the primary key. INDEXING_TYPE_PRIMARY_KEY = 4 end end |
#description ⇒ ::String
Returns 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.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 90 class ColumnSchema include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column info specific to Looker System. # @!attribute [rw] type # @return [::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec::LookerColumnType] # Looker specific column type of this column. class LookerColumnSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column type in Looker. module LookerColumnType # Unspecified. LOOKER_COLUMN_TYPE_UNSPECIFIED = 0 # Dimension. DIMENSION = 1 # Dimension group - parent for Dimension. DIMENSION_GROUP = 2 # Filter. FILTER = 3 # Measure. MEASURE = 4 # Parameter. PARAMETER = 5 end end # Represents the type of a field element. # @!attribute [rw] type # @return [::String] # Required. The type of a field element. See # {::Google::Cloud::DataCatalog::V1::ColumnSchema#type ColumnSchema.type}. class FieldElementType include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies inclusion of the column in an index module IndexingType # Unspecified. INDEXING_TYPE_UNSPECIFIED = 0 # Column not a part of an index. INDEXING_TYPE_NONE = 1 # Column Part of non unique index. INDEXING_TYPE_NON_UNIQUE = 2 # Column part of unique index. INDEXING_TYPE_UNIQUE = 3 # Column part of the primary key. INDEXING_TYPE_PRIMARY_KEY = 4 end end |
#gc_rule ⇒ ::String
Returns Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 90 class ColumnSchema include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column info specific to Looker System. # @!attribute [rw] type # @return [::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec::LookerColumnType] # Looker specific column type of this column. class LookerColumnSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column type in Looker. module LookerColumnType # Unspecified. LOOKER_COLUMN_TYPE_UNSPECIFIED = 0 # Dimension. DIMENSION = 1 # Dimension group - parent for Dimension. DIMENSION_GROUP = 2 # Filter. FILTER = 3 # Measure. MEASURE = 4 # Parameter. PARAMETER = 5 end end # Represents the type of a field element. # @!attribute [rw] type # @return [::String] # Required. The type of a field element. See # {::Google::Cloud::DataCatalog::V1::ColumnSchema#type ColumnSchema.type}. class FieldElementType include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies inclusion of the column in an index module IndexingType # Unspecified. INDEXING_TYPE_UNSPECIFIED = 0 # Column not a part of an index. INDEXING_TYPE_NONE = 1 # Column Part of non unique index. INDEXING_TYPE_NON_UNIQUE = 2 # Column part of unique index. INDEXING_TYPE_UNIQUE = 3 # Column part of the primary key. INDEXING_TYPE_PRIMARY_KEY = 4 end end |
#highest_indexing_type ⇒ ::Google::Cloud::DataCatalog::V1::ColumnSchema::IndexingType
Returns Optional. Most important inclusion of this column.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 90 class ColumnSchema include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column info specific to Looker System. # @!attribute [rw] type # @return [::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec::LookerColumnType] # Looker specific column type of this column. class LookerColumnSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column type in Looker. module LookerColumnType # Unspecified. LOOKER_COLUMN_TYPE_UNSPECIFIED = 0 # Dimension. DIMENSION = 1 # Dimension group - parent for Dimension. DIMENSION_GROUP = 2 # Filter. FILTER = 3 # Measure. MEASURE = 4 # Parameter. PARAMETER = 5 end end # Represents the type of a field element. # @!attribute [rw] type # @return [::String] # Required. The type of a field element. See # {::Google::Cloud::DataCatalog::V1::ColumnSchema#type ColumnSchema.type}. class FieldElementType include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies inclusion of the column in an index module IndexingType # Unspecified. INDEXING_TYPE_UNSPECIFIED = 0 # Column not a part of an index. INDEXING_TYPE_NONE = 1 # Column Part of non unique index. INDEXING_TYPE_NON_UNIQUE = 2 # Column part of unique index. INDEXING_TYPE_UNIQUE = 3 # Column part of the primary key. INDEXING_TYPE_PRIMARY_KEY = 4 end end |
#looker_column_spec ⇒ ::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec
Returns Looker specific column info of this column.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 90 class ColumnSchema include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column info specific to Looker System. # @!attribute [rw] type # @return [::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec::LookerColumnType] # Looker specific column type of this column. class LookerColumnSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column type in Looker. module LookerColumnType # Unspecified. LOOKER_COLUMN_TYPE_UNSPECIFIED = 0 # Dimension. DIMENSION = 1 # Dimension group - parent for Dimension. DIMENSION_GROUP = 2 # Filter. FILTER = 3 # Measure. MEASURE = 4 # Parameter. PARAMETER = 5 end end # Represents the type of a field element. # @!attribute [rw] type # @return [::String] # Required. The type of a field element. See # {::Google::Cloud::DataCatalog::V1::ColumnSchema#type ColumnSchema.type}. class FieldElementType include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies inclusion of the column in an index module IndexingType # Unspecified. INDEXING_TYPE_UNSPECIFIED = 0 # Column not a part of an index. INDEXING_TYPE_NONE = 1 # Column Part of non unique index. INDEXING_TYPE_NON_UNIQUE = 2 # Column part of unique index. INDEXING_TYPE_UNIQUE = 3 # Column part of the primary key. INDEXING_TYPE_PRIMARY_KEY = 4 end end |
#mode ⇒ ::String
Returns 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
.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 90 class ColumnSchema include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column info specific to Looker System. # @!attribute [rw] type # @return [::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec::LookerColumnType] # Looker specific column type of this column. class LookerColumnSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column type in Looker. module LookerColumnType # Unspecified. LOOKER_COLUMN_TYPE_UNSPECIFIED = 0 # Dimension. DIMENSION = 1 # Dimension group - parent for Dimension. DIMENSION_GROUP = 2 # Filter. FILTER = 3 # Measure. MEASURE = 4 # Parameter. PARAMETER = 5 end end # Represents the type of a field element. # @!attribute [rw] type # @return [::String] # Required. The type of a field element. See # {::Google::Cloud::DataCatalog::V1::ColumnSchema#type ColumnSchema.type}. class FieldElementType include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies inclusion of the column in an index module IndexingType # Unspecified. INDEXING_TYPE_UNSPECIFIED = 0 # Column not a part of an index. INDEXING_TYPE_NONE = 1 # Column Part of non unique index. INDEXING_TYPE_NON_UNIQUE = 2 # Column part of unique index. INDEXING_TYPE_UNIQUE = 3 # Column part of the primary key. INDEXING_TYPE_PRIMARY_KEY = 4 end end |
#ordinal_position ⇒ ::Integer
Returns Optional. Ordinal position.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 90 class ColumnSchema include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column info specific to Looker System. # @!attribute [rw] type # @return [::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec::LookerColumnType] # Looker specific column type of this column. class LookerColumnSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column type in Looker. module LookerColumnType # Unspecified. LOOKER_COLUMN_TYPE_UNSPECIFIED = 0 # Dimension. DIMENSION = 1 # Dimension group - parent for Dimension. DIMENSION_GROUP = 2 # Filter. FILTER = 3 # Measure. MEASURE = 4 # Parameter. PARAMETER = 5 end end # Represents the type of a field element. # @!attribute [rw] type # @return [::String] # Required. The type of a field element. See # {::Google::Cloud::DataCatalog::V1::ColumnSchema#type ColumnSchema.type}. class FieldElementType include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies inclusion of the column in an index module IndexingType # Unspecified. INDEXING_TYPE_UNSPECIFIED = 0 # Column not a part of an index. INDEXING_TYPE_NONE = 1 # Column Part of non unique index. INDEXING_TYPE_NON_UNIQUE = 2 # Column part of unique index. INDEXING_TYPE_UNIQUE = 3 # Column part of the primary key. INDEXING_TYPE_PRIMARY_KEY = 4 end end |
#range_element_type ⇒ ::Google::Cloud::DataCatalog::V1::ColumnSchema::FieldElementType
Returns 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.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 90 class ColumnSchema include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column info specific to Looker System. # @!attribute [rw] type # @return [::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec::LookerColumnType] # Looker specific column type of this column. class LookerColumnSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column type in Looker. module LookerColumnType # Unspecified. LOOKER_COLUMN_TYPE_UNSPECIFIED = 0 # Dimension. DIMENSION = 1 # Dimension group - parent for Dimension. DIMENSION_GROUP = 2 # Filter. FILTER = 3 # Measure. MEASURE = 4 # Parameter. PARAMETER = 5 end end # Represents the type of a field element. # @!attribute [rw] type # @return [::String] # Required. The type of a field element. See # {::Google::Cloud::DataCatalog::V1::ColumnSchema#type ColumnSchema.type}. class FieldElementType include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies inclusion of the column in an index module IndexingType # Unspecified. INDEXING_TYPE_UNSPECIFIED = 0 # Column not a part of an index. INDEXING_TYPE_NONE = 1 # Column Part of non unique index. INDEXING_TYPE_NON_UNIQUE = 2 # Column part of unique index. INDEXING_TYPE_UNIQUE = 3 # Column part of the primary key. INDEXING_TYPE_PRIMARY_KEY = 4 end end |
#subcolumns ⇒ ::Array<::Google::Cloud::DataCatalog::V1::ColumnSchema>
Returns Optional. Schema of sub-columns. A column can have zero or more sub-columns.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 90 class ColumnSchema include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column info specific to Looker System. # @!attribute [rw] type # @return [::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec::LookerColumnType] # Looker specific column type of this column. class LookerColumnSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column type in Looker. module LookerColumnType # Unspecified. LOOKER_COLUMN_TYPE_UNSPECIFIED = 0 # Dimension. DIMENSION = 1 # Dimension group - parent for Dimension. DIMENSION_GROUP = 2 # Filter. FILTER = 3 # Measure. MEASURE = 4 # Parameter. PARAMETER = 5 end end # Represents the type of a field element. # @!attribute [rw] type # @return [::String] # Required. The type of a field element. See # {::Google::Cloud::DataCatalog::V1::ColumnSchema#type ColumnSchema.type}. class FieldElementType include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies inclusion of the column in an index module IndexingType # Unspecified. INDEXING_TYPE_UNSPECIFIED = 0 # Column not a part of an index. INDEXING_TYPE_NONE = 1 # Column Part of non unique index. INDEXING_TYPE_NON_UNIQUE = 2 # Column part of unique index. INDEXING_TYPE_UNIQUE = 3 # Column part of the primary key. INDEXING_TYPE_PRIMARY_KEY = 4 end end |
#type ⇒ ::String
Returns Required. Type of the column.
Must be a UTF-8 string with the maximum size of 128 bytes.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 90 class ColumnSchema include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column info specific to Looker System. # @!attribute [rw] type # @return [::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec::LookerColumnType] # Looker specific column type of this column. class LookerColumnSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Column type in Looker. module LookerColumnType # Unspecified. LOOKER_COLUMN_TYPE_UNSPECIFIED = 0 # Dimension. DIMENSION = 1 # Dimension group - parent for Dimension. DIMENSION_GROUP = 2 # Filter. FILTER = 3 # Measure. MEASURE = 4 # Parameter. PARAMETER = 5 end end # Represents the type of a field element. # @!attribute [rw] type # @return [::String] # Required. The type of a field element. See # {::Google::Cloud::DataCatalog::V1::ColumnSchema#type ColumnSchema.type}. class FieldElementType include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies inclusion of the column in an index module IndexingType # Unspecified. INDEXING_TYPE_UNSPECIFIED = 0 # Column not a part of an index. INDEXING_TYPE_NONE = 1 # Column Part of non unique index. INDEXING_TYPE_NON_UNIQUE = 2 # Column part of unique index. INDEXING_TYPE_UNIQUE = 3 # Column part of the primary key. INDEXING_TYPE_PRIMARY_KEY = 4 end end |