Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::BigtableColumn.
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.
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.
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
deffield_name()->::String
Returns
(::String) — The field name to use for this column 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 qualifier bytes with best effort.
However, due to different naming patterns, field name collisions could
happen, where parsing behavior is undefined.
#field_name=
deffield_name=(value)->::String
Parameter
value (::String) — The field name to use for this column 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 qualifier bytes 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 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 qualifier bytes with best effort.
However, due to different naming patterns, field name collisions could
happen, where parsing behavior is undefined.
#qualifier
defqualifier()->::String
Returns
(::String) — Required. Qualifier of the column. If it cannot be decoded with utf-8,
use a base-64 encoded string instead.
#qualifier=
defqualifier=(value)->::String
Parameter
value (::String) — Required. Qualifier of the column. If it cannot be decoded with utf-8,
use a base-64 encoded string instead.
Returns
(::String) — Required. Qualifier of the column. If it cannot be decoded with utf-8,
use a base-64 encoded string instead.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::BigtableColumn (v0.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.21.0 (latest)](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-BigtableColumn) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::BigtableColumn.\n\nThe column of the Bigtable. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #encoding\n\n def encoding() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::Encoding\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::Encoding](./Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-Encoding)) ---\n\n The encoding mode of the values when the type is not `STRING`.\n Acceptable encoding values are:\n - `TEXT`: indicates values are alphanumeric text strings.\n - `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.\n\n### #encoding=\n\n def encoding=(value) -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::Encoding\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::Encoding](./Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-Encoding)) ---\n\n The encoding mode of the values when the type is not `STRING`.\n Acceptable encoding values are:\n - `TEXT`: indicates values are alphanumeric text strings.\n- `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. \n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::Encoding](./Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-Encoding)) ---\n\n The encoding mode of the values when the type is not `STRING`.\n Acceptable encoding values are:\n - `TEXT`: indicates values are alphanumeric text strings.\n - `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.\n\n### #field_name\n\n def field_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The field name to use for this column 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 qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.\n\n### #field_name=\n\n def field_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The field name to use for this column 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 qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined. \n**Returns**\n\n- (::String) --- The field name to use for this column 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 qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.\n\n### #qualifier\n\n def qualifier() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.\n\n### #qualifier=\n\n def qualifier=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. \n**Returns**\n\n- (::String) --- Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.\n\n### #type\n\n def type() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::Type\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::Type](./Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-Type)) --- 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`.\n\n### #type=\n\n def type=(value) -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::Type\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::Type](./Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-Type)) --- 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`. \n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::BigtableOptions::Type](./Google-Cloud-DiscoveryEngine-V1beta-BigtableOptions-Type)) --- 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`."]]