Interface BigtableOptionsOrBuilder (0.48.0)

public interface BigtableOptionsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsFamilies(String key)

public abstract boolean containsFamilies(String key)

The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

map<string, .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnFamily> families = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

getFamilies() (deprecated)

public abstract Map<String,BigtableOptions.BigtableColumnFamily> getFamilies()

Use #getFamiliesMap() instead.

Returns
Type Description
Map<String,BigtableColumnFamily>

getFamiliesCount()

public abstract int getFamiliesCount()

The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

map<string, .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnFamily> families = 2;

Returns
Type Description
int

getFamiliesMap()

public abstract Map<String,BigtableOptions.BigtableColumnFamily> getFamiliesMap()

The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

map<string, .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnFamily> families = 2;

Returns
Type Description
Map<String,BigtableColumnFamily>

getFamiliesOrDefault(String key, BigtableOptions.BigtableColumnFamily defaultValue)

public abstract BigtableOptions.BigtableColumnFamily getFamiliesOrDefault(String key, BigtableOptions.BigtableColumnFamily defaultValue)

The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

map<string, .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnFamily> families = 2;

Parameters
Name Description
key String
defaultValue BigtableOptions.BigtableColumnFamily
Returns
Type Description
BigtableOptions.BigtableColumnFamily

getFamiliesOrThrow(String key)

public abstract BigtableOptions.BigtableColumnFamily getFamiliesOrThrow(String key)

The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

map<string, .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnFamily> families = 2;

Parameter
Name Description
key String
Returns
Type Description
BigtableOptions.BigtableColumnFamily

getKeyFieldName()

public abstract String getKeyFieldName()

The field name used for saving row key value in the document. The name has to match the pattern a-zA-Z0-9*.

string key_field_name = 1;

Returns
Type Description
String

The keyFieldName.

getKeyFieldNameBytes()

public abstract ByteString getKeyFieldNameBytes()

The field name used for saving row key value in the document. The name has to match the pattern a-zA-Z0-9*.

string key_field_name = 1;

Returns
Type Description
ByteString

The bytes for keyFieldName.