Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily (v1.2.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily.

The column family of the Bigtable.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#columns

def columns() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumn>
Returns

#columns=

def columns=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumn>
Parameter
Returns

#encoding

def encoding() -> ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Encoding
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.

#encoding=

def encoding=(value) -> ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Encoding
Parameter
  • value (::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.
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.

#field_name

def field_name() -> ::String
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.

#field_name=

def field_name=(value) -> ::String
Parameter
  • value (::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.
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.

#type

def type() -> ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Type
Returns

#type=

def type=(value) -> ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Type
Parameter
Returns