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.



441
442
443
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 441

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) 


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

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) 


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

def description
  @description
end

#gc_rule ⇒ String

Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable. Corresponds to the JSON property gcRule

Returns:

  • (String) 


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

def gc_rule
  @gc_rule
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) 


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

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:



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

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) 


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

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



446
447
448
449
450
451
452
453
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 446

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