public sealed class BigtableOptions.Types.BigtableColumnFamily : IMessage<BigtableOptions.Types.BigtableColumnFamily>, IEquatable<BigtableOptions.Types.BigtableColumnFamily>, IDeepCloneable<BigtableOptions.Types.BigtableColumnFamily>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1beta API class BigtableOptions.Types.BigtableColumnFamily.
public BigtableOptions.Types.Encoding Encoding { get; set; }
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 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.
public BigtableOptions.Types.Type Type { get; set; }
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis document provides reference information for the \u003ccode\u003eBigtableColumnFamily\u003c/code\u003e class within the Discovery Engine v1beta API, specifically under the \u003ccode\u003eGoogle.Cloud.DiscoveryEngine.V1Beta\u003c/code\u003e namespace.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eBigtableColumnFamily\u003c/code\u003e represents a column family in Bigtable, used within the Discovery Engine, and it implements multiple interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe class offers properties such as \u003ccode\u003eColumns\u003c/code\u003e, \u003ccode\u003eEncoding\u003c/code\u003e, \u003ccode\u003eFieldName\u003c/code\u003e, and \u003ccode\u003eType\u003c/code\u003e, allowing configuration of column-level information, value encoding, field names, and data types within the column family.\u003c/p\u003e\n"],["\u003cp\u003eThere are two constructors available: a default constructor (\u003ccode\u003eBigtableColumnFamily()\u003c/code\u003e) and a copy constructor (\u003ccode\u003eBigtableColumnFamily(BigtableOptions.Types.BigtableColumnFamily other)\u003c/code\u003e) to clone an existing \u003ccode\u003eBigtableColumnFamily\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eThe acceptable encoding values, when the type is not a string, are \u003ccode\u003eTEXT\u003c/code\u003e, which indicates values are alphanumeric text strings, and \u003ccode\u003eBINARY\u003c/code\u003e, which indicates values are encoded using \u003ccode\u003eHBase Bytes.toBytes\u003c/code\u003e functions.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1beta API - Class BigtableOptions.Types.BigtableColumnFamily (1.0.0-beta19)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta19 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BigtableOptions.Types.BigtableColumnFamily)\n- [1.0.0-beta18](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/1.0.0-beta18/Google.Cloud.DiscoveryEngine.V1Beta.BigtableOptions.Types.BigtableColumnFamily) \n\n public sealed class BigtableOptions.Types.BigtableColumnFamily : IMessage\u003cBigtableOptions.Types.BigtableColumnFamily\u003e, IEquatable\u003cBigtableOptions.Types.BigtableColumnFamily\u003e, IDeepCloneable\u003cBigtableOptions.Types.BigtableColumnFamily\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Discovery Engine v1beta API class BigtableOptions.Types.BigtableColumnFamily.\n\nThe column family of the Bigtable. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e BigtableOptions.Types.BigtableColumnFamily \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[BigtableOptions](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BigtableOptions)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BigtableOptions.Types)[BigtableColumnFamily](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BigtableOptions.Types.BigtableColumnFamily), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[BigtableOptions](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BigtableOptions)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BigtableOptions.Types)[BigtableColumnFamily](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BigtableOptions.Types.BigtableColumnFamily), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[BigtableOptions](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BigtableOptions)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BigtableOptions.Types)[BigtableColumnFamily](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BigtableOptions.Types.BigtableColumnFamily), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.DiscoveryEngine.V1Beta](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1Beta.dll\n\nConstructors\n------------\n\n### BigtableColumnFamily()\n\n public BigtableColumnFamily()\n\n### BigtableColumnFamily(BigtableColumnFamily)\n\n public BigtableColumnFamily(BigtableOptions.Types.BigtableColumnFamily other)\n\nProperties\n----------\n\n### Columns\n\n public RepeatedField\u003cBigtableOptions.Types.BigtableColumn\u003e Columns { get; }\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### Encoding\n\n public BigtableOptions.Types.Encoding Encoding { get; set; }\n\nThe encoding mode of the values when the type is not STRING.\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### FieldName\n\n public string FieldName { get; set; }\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### Type\n\n public BigtableOptions.Types.Type Type { get; set; }\n\nThe type of values in this column family.\nThe values are expected to be encoded using `HBase Bytes.toBytes`\nfunction when the encoding value is set to `BINARY`."]]
