# Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::SearchTextIndexSpec (v1.13.0)

1.13.0 (latest) 1.12.1 1.11.0 1.10.0 1.9.1 1.8.0 1.7.0 1.6.0 1.5.0 1.4.1 1.3.0 1.2.0 1.1.0 1.0.1 0.18.0 0.17.1 0.16.0 0.15.0 0.14.3 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.5 Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::SearchTextIndexSpec.

Specification of how the field should be indexed for search text
indexes.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #index_type

    def index_type() -> ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::TextIndexType

**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::TextIndexType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index-IndexField-SearchConfig-TextIndexType)) --- Required. How to index the text field value.

### #index_type=

    def index_type=(value) -> ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::TextIndexType

**Parameter**

- **value** ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::TextIndexType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index-IndexField-SearchConfig-TextIndexType)) --- Required. How to index the text field value.
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::TextIndexType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index-IndexField-SearchConfig-TextIndexType)) --- Required. How to index the text field value.

### #match_type

    def match_type() -> ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::TextMatchType

**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::TextMatchType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index-IndexField-SearchConfig-TextMatchType)) --- Required. How to match the text field value.

### #match_type=

    def match_type=(value) -> ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::TextMatchType

**Parameter**

- **value** ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::TextMatchType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index-IndexField-SearchConfig-TextMatchType)) --- Required. How to match the text field value.
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::TextMatchType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index-IndexField-SearchConfig-TextMatchType)) --- Required. How to match the text field value.