Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class BigtableColumnFamily.
The column family of the Bigtable.
Generated from protobuf message google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnFamily
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ BigtableOptions
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ field_name
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.
↳ encoding
int
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.
↳ type
int
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.
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.
getFieldName
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
Type
Description
string
setFieldName
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEncoding
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
Type
Description
int
setEncoding
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getType
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
Type
Description
int
setType
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getColumns
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.
[[["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,["# Google Cloud Discovery Engine V1 Client - Class BigtableColumnFamily (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.BigtableOptions.BigtableColumnFamily)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.BigtableOptions.BigtableColumnFamily)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.BigtableOptions.BigtableColumnFamily)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.BigtableOptions.BigtableColumnFamily)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.BigtableOptions.BigtableColumnFamily)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.BigtableOptions.BigtableColumnFamily)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.BigtableOptions.BigtableColumnFamily)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.BigtableOptions.BigtableColumnFamily)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.BigtableOptions.BigtableColumnFamily)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.BigtableOptions.BigtableColumnFamily)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.BigtableOptions.BigtableColumnFamily)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.BigtableOptions.BigtableColumnFamily)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.BigtableOptions.BigtableColumnFamily)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.BigtableOptions.BigtableColumnFamily)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.BigtableOptions.BigtableColumnFamily)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.BigtableOptions.BigtableColumnFamily)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.BigtableOptions.BigtableColumnFamily) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class BigtableColumnFamily.\n\nThe column family of the Bigtable.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnFamily`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1 \\\\ BigtableOptions\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFieldName\n\nThe field name to use for this column family in the document. The\nname has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. If not set,\nit is parsed from the family name with best effort. However, due to\ndifferent naming patterns, field name collisions could happen, where\nparsing behavior is undefined.\n\n### setFieldName\n\nThe field name to use for this column family in the document. The\nname has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. If not set,\nit is parsed from the family name with best effort. However, due to\ndifferent naming patterns, field name collisions could happen, where\nparsing behavior is undefined.\n\n### getEncoding\n\nThe encoding mode of the values when the type is not STRING.\n\nAcceptable encoding values are:\n\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### setEncoding\n\nThe encoding mode of the values when the type is not STRING.\n\nAcceptable encoding values are:\n\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### getType\n\nThe type of values in this column family.\n\nThe values are expected to be encoded using `HBase Bytes.toBytes`\nfunction when the encoding value is set to `BINARY`.\n\n### setType\n\nThe type of values in this column family.\n\nThe values are expected to be encoded using `HBase Bytes.toBytes`\nfunction when the encoding value is set to `BINARY`.\n\n### getColumns\n\nThe list of objects that contains column level information for each\ncolumn. If a column is not present in this list it will be ignored.\n\n### setColumns\n\nThe list of objects that contains column level information for each\ncolumn. If a column is not present in this list it will be ignored."]]
