Discovery Engine v1 API - Class BigtableOptions.Types.BigtableColumn (1.5.0)

public sealed class BigtableOptions.Types.BigtableColumn : IMessage<BigtableOptions.Types.BigtableColumn>, IEquatable<BigtableOptions.Types.BigtableColumn>, IDeepCloneable<BigtableOptions.Types.BigtableColumn>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class BigtableOptions.Types.BigtableColumn.

The column of the Bigtable.

Inheritance

object > BigtableOptions.Types.BigtableColumn

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

BigtableColumn()

public BigtableColumn()

BigtableColumn(BigtableColumn)

public BigtableColumn(BigtableOptions.Types.BigtableColumn other)
Parameter
Name Description
other BigtableOptionsTypesBigtableColumn

Properties

Encoding

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.
Property Value
Type Description
BigtableOptionsTypesEncoding

FieldName

public string FieldName { get; set; }

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.

Property Value
Type Description
string

Qualifier

public ByteString Qualifier { get; set; }

Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.

Property Value
Type Description
ByteString

Type

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.

Property Value
Type Description
BigtableOptionsTypesType