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

class google.cloud.bigquery.external_config.BigtableColumn

Options for a Bigtable column.

__init__()

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

Methods

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

Attributes

encoding	The encoding of the values when the type is not STRING
field_name	An identifier to use if the qualifier is not a valid BigQuery field identifier
only_read_latest	If this is set, only the latest version of value in this column are exposed.
qualifier_encoded	The qualifier encoded in binary.
qualifier_string	A valid UTF-8 string qualifier
type_	The type to convert the value in cells of this column.

property encoding

The encoding of the values when the type is not STRING

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

Type

str

property field_name

An identifier to use if the qualifier is not a valid BigQuery field identifier

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

Type

str

classmethod from_api_repr(resource: dict) → google.cloud.bigquery.external_config.BigtableColumn

Factory: construct a BigtableColumn instance given its API representation.

Parameters

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

Returns

Configuration parsed from resource.

Return type

external_config.BigtableColumn

property only_read_latest

If this is set, only the latest version of value in this column are exposed.

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

Type

bool

property qualifier_encoded

The qualifier encoded in binary.

The type is str (Python 2.x) or bytes (Python 3.x). The module will handle base64 encoding for you.

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

Type

Union[str, bytes]

property qualifier_string

A valid UTF-8 string qualifier

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

Type

str

to_api_repr() → dict

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.

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

Type

str