As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

google.cloud.bigquery.external_config.BigtableColumnFamily

class google.cloud.bigquery.external_config.BigtableColumnFamily

Options for a Bigtable column family.

__init__()

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__()	Initialize self.
from_api_repr(resource)	Factory: construct a BigtableColumnFamily instance given its API representation.
to_api_repr()	Build an API representation of this object.

Attributes

columns	Lists of columns that should be exposed as individual fields.
encoding	The encoding of the values when the type is not STRING
family_id	Identifier of the column family.
only_read_latest	If this is set only the latest version of value are exposed for all columns in this column family.
type_	The type to convert the value in cells of this column family.

property columns

Lists of columns that should be exposed as individual fields.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.columns

Type

List[BigtableColumn]

property encoding

The encoding of the values when the type is not STRING

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.encoding

Type

str

property family_id

Identifier of the column family.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.family_id

Type

str

classmethod from_api_repr(resource)

Factory: construct a BigtableColumnFamily instance given its API representation.

Parameters

resource (Dict[str, Any]) – Definition of a BigtableColumnFamily instance in the same representation as is returned from the API.

Returns

Configuration parsed from resource.

Return type

BigtableColumnFamily

property only_read_latest

If this is set only the latest version of value are exposed for all columns in this column family.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.only_read_latest

Type

bool

to_api_repr()

Build an API representation of this object.

Returns

A dictionary in the format used by the BigQuery API.

Return type

Dict[str, Any]

property type_

The type to convert the value in cells of this column family.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.type

Type

str