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.



569
570
571
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 569

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) 


512
513
514
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 512

def column
  @column
end

#default_value ⇒ String

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

Returns:

  • (String) 


517
518
519
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 517

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) 


523
524
525
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 523

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) 


529
530
531
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 529

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) 


534
535
536
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 534

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:



539
540
541
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 539

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) 


546
547
548
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 546

def mode
  @mode
end

#ordinal_position ⇒ Fixnum

Optional. Ordinal position Corresponds to the JSON property ordinalPosition

Returns:

  • (Fixnum) 


551
552
553
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 551

def ordinal_position
  @ordinal_position
end

#range_element_type ⇒ Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1ColumnSchemaFieldElementType

Represents the type of a field element. Corresponds to the JSON property rangeElementType

Returns:



556
557
558
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 556

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



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

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) 


567
568
569
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 567

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 574

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)
  @range_element_type = args[:range_element_type] if args.key?(:range_element_type)
  @subcolumns = args[:subcolumns] if args.key?(:subcolumns)
  @type = args[:type] if args.key?(:type)
end