Reference documentation and code samples for the Cloud Firestore V1 Client class SearchTextIndexSpec.
Specification of how the field should be indexed for search text indexes.
Generated from protobuf message google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextIndexSpec
Namespace
Google \ Cloud \ Firestore \ Admin \ V1 \ Index \ IndexField \ SearchConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ index_type |
int
Required. How to index the text field value. |
↳ match_type |
int
Required. How to match the text field value. |
getIndexType
Required. How to index the text field value.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type TextIndexType. |
setIndexType
Required. How to index the text field value.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type TextIndexType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMatchType
Required. How to match the text field value.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type TextMatchType. |
setMatchType
Required. How to match the text field value.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type TextMatchType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|