Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1ColumnSchema

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datacatalog_v1beta1/classes.rb,
lib/google/apis/datacatalog_v1beta1/representations.rb,
lib/google/apis/datacatalog_v1beta1/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.



461
462
463
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 461

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_v1beta1/classes.rb', line 409

def column
  @column
end

#default_value ⇒ String

Optional. Default value for the column. Corresponds to the JSON property defaultValue

Returns:

  • (String) 


414
415
416
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 414

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


420
421
422
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 420

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) 


426
427
428
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 426

def gc_rule
  @gc_rule
end

#highest_indexing_type ⇒ String

Optional. Most important inclusion of this column. Corresponds to the JSON property highestIndexingType

Returns:

  • (String) 


431
432
433
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 431

def highest_indexing_type
  @highest_indexing_type
end

#looker_column_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1ColumnSchemaLookerColumnSpec

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

Returns:



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

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) 


443
444
445
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 443

def mode
  @mode
end

#ordinal_position ⇒ Fixnum

Optional. Ordinal position Corresponds to the JSON property ordinalPosition

Returns:

  • (Fixnum) 


448
449
450
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 448

def ordinal_position
  @ordinal_position
end

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

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

Returns:



453
454
455
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 453

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) 


459
460
461
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 459

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 466

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