Interface BigtableOptions.BigtableColumnFamilyOrBuilder (0.43.0) 

public static interface BigtableOptions.BigtableColumnFamilyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getColumns(int index)

public abstract BigtableOptions.BigtableColumn getColumns(int index)

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.

repeated .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumn columns = 4;

Parameter
Name Description
index int
Returns
Type Description
BigtableOptions.BigtableColumn

getColumnsCount()

public abstract int getColumnsCount()

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.

repeated .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumn columns = 4;

Returns
Type Description
int

getColumnsList()

public abstract List<BigtableOptions.BigtableColumn> getColumnsList()

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.

repeated .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumn columns = 4;

Returns
Type Description
List<BigtableColumn>

getColumnsOrBuilder(int index)

public abstract BigtableOptions.BigtableColumnOrBuilder getColumnsOrBuilder(int index)

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.

repeated .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumn columns = 4;

Parameter
Name Description
index int
Returns
Type Description
BigtableOptions.BigtableColumnOrBuilder

getColumnsOrBuilderList()

public abstract List<? extends BigtableOptions.BigtableColumnOrBuilder> getColumnsOrBuilderList()

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.

repeated .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumn columns = 4;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnOrBuilder>

getEncoding()

public abstract BigtableOptions.Encoding 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.

.google.cloud.discoveryengine.v1.BigtableOptions.Encoding encoding = 2;

Returns
Type Description
BigtableOptions.Encoding

The encoding.

getEncodingValue()

public abstract int getEncodingValue()

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.

.google.cloud.discoveryengine.v1.BigtableOptions.Encoding encoding = 2;

Returns
Type Description
int

The enum numeric value on the wire for encoding.

getFieldName()

public abstract String getFieldName()

The field name to use for this column family in the document. The name has to match the pattern 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.

string field_name = 1;

Returns
Type Description
String

The fieldName.

getFieldNameBytes()

public abstract ByteString getFieldNameBytes()

The field name to use for this column family in the document. The name has to match the pattern 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.

string field_name = 1;

Returns
Type Description
ByteString

The bytes for fieldName.

getType()

public abstract BigtableOptions.Type 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.

.google.cloud.discoveryengine.v1.BigtableOptions.Type type = 3;

Returns
Type Description
BigtableOptions.Type

The type.

getTypeValue()

public abstract int getTypeValue()

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.

.google.cloud.discoveryengine.v1.BigtableOptions.Type type = 3;

Returns
Type Description
int

The enum numeric value on the wire for type.