bigquery  v2
Public Member Functions | Static Public Member Functions | List of all members
google_bigquery_api::BigtableOptions Class Reference
BigQuery API Data Objects

#include <bigtable_options.h>

Inheritance diagram for google_bigquery_api::BigtableOptions:

Public Member Functions

 BigtableOptions (const Json::Value &storage)
 
 BigtableOptions (Json::Value *storage)
 
virtual ~BigtableOptions ()
 
const StringPiece GetTypeName () const
 
bool has_column_families () const
 
void clear_column_families ()
 
const client::JsonCppArray< BigtableColumnFamily > get_column_families () const
 
client::JsonCppArray< BigtableColumnFamily > mutable_columnFamilies ()
 
bool has_ignore_unspecified_column_families () const
 
void clear_ignore_unspecified_column_families ()
 
bool get_ignore_unspecified_column_families () const
 
void set_ignore_unspecified_column_families (bool value)
 
bool has_read_rowkey_as_string () const
 
void clear_read_rowkey_as_string ()
 
bool get_read_rowkey_as_string () const
 
void set_read_rowkey_as_string (bool value)
 

Static Public Member Functions

static BigtableOptions * New ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ BigtableOptions() [1/2]

google_bigquery_api::BigtableOptions::BigtableOptions ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ BigtableOptions() [2/2]

google_bigquery_api::BigtableOptions::BigtableOptions ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~BigtableOptions()

google_bigquery_api::BigtableOptions::~BigtableOptions ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_column_families()

void google_bigquery_api::BigtableOptions::clear_column_families ( )
inline

Clears the 'columnFamilies' attribute.

◆ clear_ignore_unspecified_column_families()

void google_bigquery_api::BigtableOptions::clear_ignore_unspecified_column_families ( )
inline

Clears the 'ignoreUnspecifiedColumnFamilies' attribute.

◆ clear_read_rowkey_as_string()

void google_bigquery_api::BigtableOptions::clear_read_rowkey_as_string ( )
inline

Clears the 'readRowkeyAsString' attribute.

◆ get_column_families()

const client::JsonCppArray<BigtableColumnFamily > google_bigquery_api::BigtableOptions::get_column_families ( ) const

Get a reference to the value of the 'columnFamilies' attribute.

◆ get_ignore_unspecified_column_families()

bool google_bigquery_api::BigtableOptions::get_ignore_unspecified_column_families ( ) const
inline

Get the value of the 'ignoreUnspecifiedColumnFamilies' attribute.

◆ get_read_rowkey_as_string()

bool google_bigquery_api::BigtableOptions::get_read_rowkey_as_string ( ) const
inline

Get the value of the 'readRowkeyAsString' attribute.

◆ GetTypeName()

const StringPiece google_bigquery_api::BigtableOptions::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::BigtableOptions

◆ has_column_families()

bool google_bigquery_api::BigtableOptions::has_column_families ( ) const
inline

Determine if the 'columnFamilies' attribute was set.

Returns
true if the 'columnFamilies' attribute was set.

◆ has_ignore_unspecified_column_families()

bool google_bigquery_api::BigtableOptions::has_ignore_unspecified_column_families ( ) const
inline

Determine if the 'ignoreUnspecifiedColumnFamilies' attribute was set.

Returns
true if the 'ignoreUnspecifiedColumnFamilies' attribute was set.

◆ has_read_rowkey_as_string()

bool google_bigquery_api::BigtableOptions::has_read_rowkey_as_string ( ) const
inline

Determine if the 'readRowkeyAsString' attribute was set.

Returns
true if the 'readRowkeyAsString' attribute was set.

◆ mutable_columnFamilies()

client::JsonCppArray<BigtableColumnFamily > google_bigquery_api::BigtableOptions::mutable_columnFamilies ( )

Gets a reference to a mutable value of the 'columnFamilies' property.

[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
The result can be modified to change the attribute value.

◆ New()

BigtableOptions * google_bigquery_api::BigtableOptions::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_ignore_unspecified_column_families()

void google_bigquery_api::BigtableOptions::set_ignore_unspecified_column_families ( bool  value)
inline

Change the 'ignoreUnspecifiedColumnFamilies' attribute.

[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
[in]valueThe new value.

◆ set_read_rowkey_as_string()

void google_bigquery_api::BigtableOptions::set_read_rowkey_as_string ( bool  value)
inline

Change the 'readRowkeyAsString' attribute.

[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
[in]valueThe new value.
The documentation for this class was generated from the following files: