Reference documentation and code samples for the Google Cloud Data Catalog V1BETA1 API class Google::Cloud::DataCatalog::V1beta1::ColumnSchema.
Representation of a column within a schema. Columns could be nested inside other columns.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#column
def column() -> ::String
Returns
- (::String) — Required. Name of the column.
#column=
def column=(value) -> ::String
Parameter
- value (::String) — Required. Name of the column.
Returns
- (::String) — Required. Name of the column.
#description
def description() -> ::String
Returns
- (::String) — Optional. Description of the column. Default value is an empty string.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. Description of the column. Default value is an empty string.
Returns
- (::String) — Optional. Description of the column. Default value is an empty string.
#mode
def mode() -> ::String
Returns
-
(::String) — Optional. A column's mode indicates whether the values in this column are
required, nullable, etc. Only
NULLABLE
,REQUIRED
andREPEATED
are supported. Default mode isNULLABLE
.
#mode=
def mode=(value) -> ::String
Parameter
-
value (::String) — Optional. A column's mode indicates whether the values in this column are
required, nullable, etc. Only
NULLABLE
,REQUIRED
andREPEATED
are supported. Default mode isNULLABLE
.
Returns
-
(::String) — Optional. A column's mode indicates whether the values in this column are
required, nullable, etc. Only
NULLABLE
,REQUIRED
andREPEATED
are supported. Default mode isNULLABLE
.
#subcolumns
def subcolumns() -> ::Array<::Google::Cloud::DataCatalog::V1beta1::ColumnSchema>
Returns
- (::Array<::Google::Cloud::DataCatalog::V1beta1::ColumnSchema>) — Optional. Schema of sub-columns. A column can have zero or more sub-columns.
#subcolumns=
def subcolumns=(value) -> ::Array<::Google::Cloud::DataCatalog::V1beta1::ColumnSchema>
Parameter
- value (::Array<::Google::Cloud::DataCatalog::V1beta1::ColumnSchema>) — Optional. Schema of sub-columns. A column can have zero or more sub-columns.
Returns
- (::Array<::Google::Cloud::DataCatalog::V1beta1::ColumnSchema>) — Optional. Schema of sub-columns. A column can have zero or more sub-columns.
#type
def type() -> ::String
Returns
- (::String) — Required. Type of the column.
#type=
def type=(value) -> ::String
Parameter
- value (::String) — Required. Type of the column.
Returns
- (::String) — Required. Type of the column.