Google Cloud Discovery Engine V1 Client - Class BigtableColumn (1.3.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class BigtableColumn.

The column of the Bigtable.

Generated from protobuf message google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumn

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ BigtableOptions

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ qualifier string

Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.
↳ field_name 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.
↳ 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.

getQualifier

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

Returns
Type Description
string

setQualifier

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFieldName

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
Type Description
string

setFieldName

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.

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