Google Cloud Discovery Engine V1 Client - Class BigtableColumnFamily (0.11.1)

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.
↳ columns array<Google\Cloud\DiscoveryEngine\V1\BigtableOptions\BigtableColumn>

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setColumns

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.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\BigtableOptions\BigtableColumn>
Returns
Type Description
$this