Class: Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily

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

Overview

The column family of the Bigtable.

Instance Attribute Summary collapse

Instance Attribute Details

#columns ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumn>

Returns The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.

Returns:



179
180
181
182
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 179

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

#encoding ⇒ ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Encoding

Returns The encoding mode of the values when the type is not STRING. Acceptable encoding values are:

  • TEXT: indicates values are alphanumeric text strings.
  • BINARY: indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in columns and specifying an encoding for it.

Returns:

  • (::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Encoding) —

    The encoding mode of the values when the type is not STRING. Acceptable encoding values are:

    • TEXT: indicates values are alphanumeric text strings.
    • BINARY: indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in columns and specifying an encoding for it.


179
180
181
182
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 179

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

#field_name ⇒ ::String

Returns The field name to use for this column family in the document. The name has to match the pattern [a-zA-Z0-9][a-zA-Z0-9-_]*. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.

Returns:

  • (::String) —

    The field name to use for this column family in the document. The name has to match the pattern [a-zA-Z0-9][a-zA-Z0-9-_]*. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.



179
180
181
182
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 179

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

#type ⇒ ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Type

Returns The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY.

Returns:



179
180
181
182
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 179

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