Cloud Firestore V1 Client - Class SearchTextSpec (2.3.3)

Reference documentation and code samples for the Cloud Firestore V1 Client class SearchTextSpec.

The specification for how to build a text search index for a field.

Generated from protobuf message google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextSpec

Namespace

Google \ Cloud \ Firestore \ Admin \ V1 \ Index \ IndexField \ SearchConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ index_specs array<SearchTextIndexSpec>

Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways.

getIndexSpecs

Required. Specifications for how the field should be indexed.

Repeated so that the field can be indexed in multiple ways.

Returns
Type Description
Google\Protobuf\RepeatedField<SearchTextIndexSpec>

setIndexSpecs

Required. Specifications for how the field should be indexed.

Repeated so that the field can be indexed in multiple ways.

Parameter
Name Description
var array<SearchTextIndexSpec>
Returns
Type Description
$this