Class BigtableOptions (0.12.2)

BigtableOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The Bigtable Options object that contains information to support the import.

Attributes

Name Description
key_field_name str
The field name used for saving row key value in the document. The name has to match the pattern ``a-zA-Z0-9][a-zA-Z0-9-_]*``.
families MutableMapping[str, google.cloud.discoveryengine_v1beta.types.BigtableOptions.BigtableColumnFamily]
The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

Classes

BigtableColumn

BigtableColumn(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The column of the Bigtable.

BigtableColumnFamily

BigtableColumnFamily(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The column family of the Bigtable.

Encoding

Encoding(value)

The encoding mode of a Bigtable column or column family.

FamiliesEntry

FamiliesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Type

Type(value)

The type of values in a Bigtable column or column family. The values are expected to be encoded using HBase Bytes.toBytes <https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/util/Bytes.html>__ function when the encoding value is set to BINARY.