Class: Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1ColumnSchema

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datacatalog_v1/classes.rb,
lib/google/apis/datacatalog_v1/representations.rb,
lib/google/apis/datacatalog_v1/representations.rb

Overview

A column within a schema. Columns can be nested inside other columns.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1ColumnSchema

Returns a new instance of GoogleCloudDatacatalogV1ColumnSchema.



438
439
440
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 438

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#column ⇒ String

Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. Corresponds to the JSON property column

Returns:

  • (String) 


407
408
409
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 407

def column
  @column
end

#description ⇒ 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. Corresponds to the JSON property description

Returns:

  • (String) 


413
414
415
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 413

def description
  @description
end

#looker_column_spec ⇒ Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1ColumnSchemaLookerColumnSpec

Column info specific to Looker System. Corresponds to the JSON property lookerColumnSpec

Returns:



418
419
420
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 418

def looker_column_spec
  @looker_column_spec
end

#mode ⇒ 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. Corresponds to the JSON property mode

Returns:

  • (String) 


425
426
427
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 425

def mode
  @mode
end

#subcolumns ⇒ Array<Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1ColumnSchema>

Optional. Schema of sub-columns. A column can have zero or more sub-columns. Corresponds to the JSON property subcolumns

Returns:



430
431
432
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 430

def subcolumns
  @subcolumns
end

#type ⇒ String

Required. Type of the column. Must be a UTF-8 string with the maximum size of 128 bytes. Corresponds to the JSON property type

Returns:

  • (String) 


436
437
438
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 436

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



443
444
445
446
447
448
449
450
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 443

def update!(**args)
  @column = args[:column] if args.key?(:column)
  @description = args[:description] if args.key?(:description)
  @looker_column_spec = args[:looker_column_spec] if args.key?(:looker_column_spec)
  @mode = args[:mode] if args.key?(:mode)
  @subcolumns = args[:subcolumns] if args.key?(:subcolumns)
  @type = args[:type] if args.key?(:type)
end