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.



561
562
563
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 561

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) 


509
510
511
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 509

def column
  @column
end

#default_value ⇒ String

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

Returns:

  • (String) 


514
515
516
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 514

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) 


520
521
522
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 520

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) 


526
527
528
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 526

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) 


531
532
533
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 531

def highest_indexing_type
  @highest_indexing_type
end

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

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

Returns:



536
537
538
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 536

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) 


543
544
545
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 543

def mode
  @mode
end

#ordinal_position ⇒ Fixnum

Optional. Ordinal position Corresponds to the JSON property ordinalPosition

Returns:

  • (Fixnum) 


548
549
550
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 548

def ordinal_position
  @ordinal_position
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:



553
554
555
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 553

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) 


559
560
561
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 559

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 566

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