Class: Google::Cloud::DataCatalog::V1::ColumnSchema

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/datacatalog/v1/schema.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#column ⇒ ::String

Returns Required. Name of the column.

Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.

Returns:

  • (::String) —

    Required. Name of the column.

    Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.



65
66
67
68
 
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 65

class ColumnSchema
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

Returns 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.

Returns:

  • (::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.



65
66
67
68
 
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 65

class ColumnSchema
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#mode ⇒ ::String

Returns Optional. A column's mode indicates if values in this column are required, nullable, or repeated.

Only NULLABLE, REQUIRED, and REPEATED values are supported. Default mode is NULLABLE.

Returns:

  • (::String) —

    Optional. A column's mode indicates if values in this column are required, nullable, or repeated.

    Only NULLABLE, REQUIRED, and REPEATED values are supported. Default mode is NULLABLE.



65
66
67
68
 
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 65

class ColumnSchema
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#subcolumns ⇒ ::Array<::Google::Cloud::DataCatalog::V1::ColumnSchema>

Returns Optional. Schema of sub-columns. A column can have zero or more sub-columns.

Returns:



65
66
67
68
 
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 65

class ColumnSchema
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#type ⇒ ::String

Returns Required. Type of the column.

Must be a UTF-8 string with the maximum size of 128 bytes.

Returns:

  • (::String) —

    Required. Type of the column.

    Must be a UTF-8 string with the maximum size of 128 bytes.



65
66
67
68
 
# File 'proto_docs/google/cloud/datacatalog/v1/schema.rb', line 65

class ColumnSchema
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end