Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::ColumnSchema (v0.23.0)

Version latest

• 0.23.0 (latest)
• 0.22.0
• 0.21.2
• 0.20.1
• 0.19.0
• 0.18.1
• 0.17.0
• 0.16.1
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.1
• 0.11.0
• 0.10.0
• 0.9.1

Reference documentation and code samples for the Data Catalog V1 API class Google::Cloud::DataCatalog::V1::ColumnSchema.

A column within a schema. Columns can 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.

  Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.

#column=

def column=(value) -> ::String

Parameter

• value (::String) — Required. Name of the column.

  Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.

Returns

• (::String) — Required. Name of the column.

  Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.

#default_value

def default_value() -> ::String

Returns

• (::String) — Optional. Default value for the column.

#default_value=

def default_value=(value) -> ::String

Parameter

• value (::String) — Optional. Default value for the column.

Returns

• (::String) — Optional. Default value for the column.

#description

def description() -> ::String

Returns

• (::String) — 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.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#gc_rule

def gc_rule() -> ::String

Returns

• (::String) — Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable.

#gc_rule=

def gc_rule=(value) -> ::String

Parameter

• value (::String) — Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable.

Returns

• (::String) — Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable.

#highest_indexing_type

def highest_indexing_type() -> ::Google::Cloud::DataCatalog::V1::ColumnSchema::IndexingType

Returns

• (::Google::Cloud::DataCatalog::V1::ColumnSchema::IndexingType) — Optional. Most important inclusion of this column.

#highest_indexing_type=

def highest_indexing_type=(value) -> ::Google::Cloud::DataCatalog::V1::ColumnSchema::IndexingType

Parameter

• value (::Google::Cloud::DataCatalog::V1::ColumnSchema::IndexingType) — Optional. Most important inclusion of this column.

Returns

• (::Google::Cloud::DataCatalog::V1::ColumnSchema::IndexingType) — Optional. Most important inclusion of this column.

#looker_column_spec

def looker_column_spec() -> ::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec

Returns

• (::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec) — Looker specific column info of this column.

#looker_column_spec=

def looker_column_spec=(value) -> ::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec

Parameter

• value (::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec) — Looker specific column info of this column.

Returns

• (::Google::Cloud::DataCatalog::V1::ColumnSchema::LookerColumnSpec) — Looker specific column info of this column.

#mode

def mode() -> ::String

Returns

• (::String) — 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.

#mode=

def mode=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#ordinal_position

def ordinal_position() -> ::Integer

Returns

• (::Integer) — Optional. Ordinal position

#ordinal_position=

def ordinal_position=(value) -> ::Integer

Parameter

• value (::Integer) — Optional. Ordinal position

Returns

• (::Integer) — Optional. Ordinal position

#range_element_type

def range_element_type() -> ::Google::Cloud::DataCatalog::V1::ColumnSchema::FieldElementType

Returns

• (::Google::Cloud::DataCatalog::V1::ColumnSchema::FieldElementType) —

  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

#range_element_type=

def range_element_type=(value) -> ::Google::Cloud::DataCatalog::V1::ColumnSchema::FieldElementType

Parameter

• value (::Google::Cloud::DataCatalog::V1::ColumnSchema::FieldElementType) —

  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

Returns

• (::Google::Cloud::DataCatalog::V1::ColumnSchema::FieldElementType) —

  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

#subcolumns

def subcolumns() -> ::Array<::Google::Cloud::DataCatalog::V1::ColumnSchema>

Returns

• (::Array<::Google::Cloud::DataCatalog::V1::ColumnSchema>) — Optional. Schema of sub-columns. A column can have zero or more sub-columns.

#subcolumns=

def subcolumns=(value) -> ::Array<::Google::Cloud::DataCatalog::V1::ColumnSchema>

Parameter

• value (::Array<::Google::Cloud::DataCatalog::V1::ColumnSchema>) — Optional. Schema of sub-columns. A column can have zero or more sub-columns.

Returns

• (::Array<::Google::Cloud::DataCatalog::V1::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.

  Must be a UTF-8 string with the maximum size of 128 bytes.

#type=

def type=(value) -> ::String

Parameter

• value (::String) — Required. Type of the column.

  Must be a UTF-8 string with the maximum size of 128 bytes.

Returns

• (::String) — Required. Type of the column.

  Must be a UTF-8 string with the maximum size of 128 bytes.