Cloud Firestore V1 Client - Class PlanSummary (1.45.2)

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

Planning phase information for the query.

Generated from protobuf message google.firestore.v1.PlanSummary

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ indexes_used array<Google\Protobuf\Struct>

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

getIndexesUsed

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setIndexesUsed

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

Parameter
Name Description
var array<Google\Protobuf\Struct>
Returns
Type Description
$this