Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1ColumnSchema

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/datacatalog_v1beta1/classes.rb,
generated/google/apis/datacatalog_v1beta1/representations.rb,
generated/google/apis/datacatalog_v1beta1/representations.rb

Overview

Representation of a column within a schema. Columns could be nested inside other columns.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1ColumnSchema

Returns a new instance of GoogleCloudDatacatalogV1beta1ColumnSchema.



338
339
340
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 338

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

Instance Attribute Details

#columnString

Required. Name of the column. Corresponds to the JSON property column

Returns:

  • (String)


313
314
315
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 313

def column
  @column
end

#descriptionString

Optional. Description of the column. Default value is an empty string. Corresponds to the JSON property description

Returns:

  • (String)


318
319
320
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 318

def description
  @description
end

#modeString

Optional. A column's mode indicates whether the values in this column are required, nullable, etc. Only NULLABLE, REQUIRED and REPEATED are supported. Default mode is NULLABLE. Corresponds to the JSON property mode

Returns:

  • (String)


326
327
328
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 326

def mode
  @mode
end

#subcolumnsArray<Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1ColumnSchema>

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



331
332
333
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 331

def subcolumns
  @subcolumns
end

#typeString

Required. Type of the column. Corresponds to the JSON property type

Returns:

  • (String)


336
337
338
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 336

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



343
344
345
346
347
348
349
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 343

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