Reference documentation and code samples for the Cloud Firestore V1 Client class SearchConfig.
The configuration for how to index a field for search.
Generated from protobuf message google.firestore.admin.v1.Index.IndexField.SearchConfig
Namespace
Google \ Cloud \ Firestore \ Admin \ V1 \ Index \ IndexFieldMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ text_spec |
SearchConfig\SearchTextSpec
Optional. The specification for building a text search index for a field. |
↳ geo_spec |
SearchConfig\SearchGeoSpec
Optional. The specification for building a geo search index for a field. |
getTextSpec
Optional. The specification for building a text search index for a field.
| Returns | |
|---|---|
| Type | Description |
SearchConfig\SearchTextSpec|null |
|
hasTextSpec
clearTextSpec
setTextSpec
Optional. The specification for building a text search index for a field.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchConfig\SearchTextSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGeoSpec
Optional. The specification for building a geo search index for a field.
| Returns | |
|---|---|
| Type | Description |
SearchConfig\SearchGeoSpec|null |
|
hasGeoSpec
clearGeoSpec
setGeoSpec
Optional. The specification for building a geo search index for a field.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchConfig\SearchGeoSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|