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.



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

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

Instance Attribute Details

#columnString

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)


404
405
406
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 404

def column
  @column
end

#descriptionString

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)


410
411
412
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 410

def description
  @description
end

#looker_column_specGoogle::Apis::DatacatalogV1::GoogleCloudDatacatalogV1ColumnSchemaLookerColumnSpec

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



415
416
417
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 415

def looker_column_spec
  @looker_column_spec
end

#modeString

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)


422
423
424
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 422

def mode
  @mode
end

#subcolumnsArray<Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1ColumnSchema>

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



427
428
429
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 427

def subcolumns
  @subcolumns
end

#typeString

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)


433
434
435
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 433

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



440
441
442
443
444
445
446
447
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 440

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