com.google.api.services.bigquery.model

Class BigtableOptions

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.bigquery.model.BigtableOptions

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BigtableOptions
extends com.google.api.client.json.GenericJson

Options specific to Google Cloud Bigtable data sources.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the BigQuery API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
BigtableOptions()

Method Summary

Modifier and Type	Method and Description
BigtableOptions	clone()
List<BigtableColumnFamily>	getColumnFamilies() Optional.
Boolean	getIgnoreUnspecifiedColumnFamilies() Optional.
Boolean	getOutputColumnFamiliesAsJson() Optional.
Boolean	getReadRowkeyAsString() Optional.
BigtableOptions	set(String fieldName, Object value)
BigtableOptions	setColumnFamilies(List<BigtableColumnFamily> columnFamilies) Optional.
BigtableOptions	setIgnoreUnspecifiedColumnFamilies(Boolean ignoreUnspecifiedColumnFamilies) Optional.
BigtableOptions	setOutputColumnFamiliesAsJson(Boolean outputColumnFamiliesAsJson) Optional.
BigtableOptions	setReadRowkeyAsString(Boolean readRowkeyAsString) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

BigtableOptions

public BigtableOptions()

Method Detail

getColumnFamilies

public List<BigtableColumnFamily> getColumnFamilies()

Optional. 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.

Returns:

value or null for none

setColumnFamilies

public BigtableOptions setColumnFamilies(List<BigtableColumnFamily> columnFamilies)

Optional. 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.

Parameters:

columnFamilies - columnFamilies or null for none

getIgnoreUnspecifiedColumnFamilies

public Boolean getIgnoreUnspecifiedColumnFamilies()

Optional. 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.

Returns:

value or null for none

setIgnoreUnspecifiedColumnFamilies

public BigtableOptions setIgnoreUnspecifiedColumnFamilies(Boolean ignoreUnspecifiedColumnFamilies)

Optional. 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.

Parameters:

ignoreUnspecifiedColumnFamilies - ignoreUnspecifiedColumnFamilies or null for none

getOutputColumnFamiliesAsJson

public Boolean getOutputColumnFamiliesAsJson()

Optional. If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.

Returns:

value or null for none

setOutputColumnFamiliesAsJson

public BigtableOptions setOutputColumnFamiliesAsJson(Boolean outputColumnFamiliesAsJson)

Optional. If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.

Parameters:

outputColumnFamiliesAsJson - outputColumnFamiliesAsJson or null for none

getReadRowkeyAsString

public Boolean getReadRowkeyAsString()

Optional. If field 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.

Returns:

value or null for none

setReadRowkeyAsString

public BigtableOptions setReadRowkeyAsString(Boolean readRowkeyAsString)

Optional. If field 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.

Parameters:

readRowkeyAsString - readRowkeyAsString or null for none

set

public BigtableOptions set(String fieldName,
                           Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public BigtableOptions clone()

Overrides:

clone in class com.google.api.client.json.GenericJson