Send feedback
Cloud Firestore V1 Client - Class PlanSummary (1.53.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
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
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)"}
]
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)"}
]
Returns
Type Description
$this
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class PlanSummary (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1.PlanSummary)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1.PlanSummary)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1.PlanSummary)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1.PlanSummary)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1.PlanSummary)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1.PlanSummary)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1.PlanSummary)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1.PlanSummary)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1.PlanSummary)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1.PlanSummary)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1.PlanSummary)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1.PlanSummary)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1.PlanSummary)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1.PlanSummary)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1.PlanSummary)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1.PlanSummary)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1.PlanSummary)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1.PlanSummary)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1.PlanSummary)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1.PlanSummary)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1.PlanSummary)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1.PlanSummary)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1.PlanSummary) \nReference documentation and code samples for the Cloud Firestore V1 Client class PlanSummary.\n\nPlanning phase information for the query.\n\nGenerated from protobuf message `google.firestore.v1.PlanSummary`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getIndexesUsed\n\nThe indexes selected for the query. For example:\n\\[\n{\"query_scope\": \"Collection\", \"properties\": \"(foo ASC, **name** ASC)\"},\n{\"query_scope\": \"Collection\", \"properties\": \"(bar ASC, **name** ASC)\"}\n\\]\n\n### setIndexesUsed\n\nThe indexes selected for the query. For example:\n\\[\n{\"query_scope\": \"Collection\", \"properties\": \"(foo ASC, **name** ASC)\"},\n{\"query_scope\": \"Collection\", \"properties\": \"(bar ASC, **name** ASC)\"}\n\\]"]]
