com.google.cloud.bigquery

Class BigtableOptions.Builder

java.lang.Object

com.google.cloud.bigquery.BigtableOptions.Builder

Enclosing class:

BigtableOptions

public static final class BigtableOptions.Builder
extends Object

A builder for BigtableOptions objects.

Method Summary

Modifier and Type	Method and Description
BigtableOptions	build()
BigtableOptions.Builder	setColumnFamilies(List<BigtableColumnFamily> columnFamilies) List of column families to expose in the table schema along with their types.
BigtableOptions.Builder	setIgnoreUnspecifiedColumnFamilies(Boolean ignoreUnspecifiedColumnFamilies) If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema.
BigtableOptions.Builder	setReadRowkeyAsString(Boolean readRowkeyAsString) If readRowkeyAsString is true, then the rowkey column families will be read and converted to string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setIgnoreUnspecifiedColumnFamilies

public BigtableOptions.Builder setIgnoreUnspecifiedColumnFamilies(Boolean ignoreUnspecifiedColumnFamilies)

If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

setReadRowkeyAsString

public BigtableOptions.Builder setReadRowkeyAsString(Boolean readRowkeyAsString)

If readRowkeyAsString is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

setColumnFamilies

public BigtableOptions.Builder setColumnFamilies(List<BigtableColumnFamily> columnFamilies)

List of column families to expose in the table schema along with their types.

This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

build

public BigtableOptions build()