Discovery Engine v1 API - Class BigtableOptions.Types.BigtableColumnFamily (1.4.0)

Version 1.4.0

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

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 v1 API class BigtableOptions.Types.BigtableColumnFamily.

The column family of the Bigtable.

Inheritance

object > BigtableOptions.Types.BigtableColumnFamily

Implements

IMessageBigtableOptionsTypesBigtableColumnFamily, IEquatableBigtableOptionsTypesBigtableColumnFamily, IDeepCloneableBigtableOptionsTypesBigtableColumnFamily, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

BigtableColumnFamily()

public BigtableColumnFamily()

BigtableColumnFamily(BigtableColumnFamily)

public BigtableColumnFamily(BigtableOptions.Types.BigtableColumnFamily other)

Parameter
Name	Description
other	BigtableOptionsTypesBigtableColumnFamily

Properties

Columns

public RepeatedField<BigtableOptions.Types.BigtableColumn> Columns { get; }

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.

Property Value
Type	Description
RepeatedFieldBigtableOptionsTypesBigtableColumn

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 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.

Property Value
Type	Description
string

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