1# -*- coding: utf-8 -*-
2# Copyright 2025 Google LLC
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16from __future__ import annotations
17
18from typing import MutableMapping, MutableSequence
19
20import proto # type: ignore
21
22from google.protobuf import any_pb2 # type: ignore
23
24
25__protobuf__ = proto.module(
26 package="google.firestore.v1",
27 manifest={
28 "ExplainStats",
29 },
30)
31
32
33class ExplainStats(proto.Message):
34 r"""Pipeline explain stats.
35
36 Depending on the explain options in the original request, this
37 can contain the optimized plan and / or execution stats.
38
39 Attributes:
40 data (google.protobuf.any_pb2.Any):
41 The format depends on the ``output_format`` options in the
42 request.
43
44 Currently there are two supported options: ``TEXT`` and
45 ``JSON``. Both supply a ``google.protobuf.StringValue``.
46 """
47
48 data: any_pb2.Any = proto.Field(
49 proto.MESSAGE,
50 number=1,
51 message=any_pb2.Any,
52 )
53
54
55__all__ = tuple(sorted(__protobuf__.manifest))