# Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::BigtableOptions (v2.8.0)

2.8.0 (latest) 2.7.0 2.6.2 2.5.0 2.4.0 2.3.1 2.2.0 2.1.1 2.0.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.2 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.2 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::BigtableOptions.

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

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #families

    def families() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::Google::Cloud::DiscoveryEngine::V1::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.

### #families=

    def families=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::Google::Cloud::DiscoveryEngine::V1::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.
**Returns**

- (::Google::Protobuf::Map{::String =\> ::Google::Cloud::DiscoveryEngine::V1::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.

### #key_field_name

    def key_field_name() -> ::String

**Returns**

- (::String) --- 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-_]*`.

### #key_field_name=

    def key_field_name=(value) -> ::String

**Parameter**

- **value** (::String) --- 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-_]*`.
**Returns**

- (::String) --- 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-_]*`.