documentation_pb2.pyi 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. # Copyright 2025 Google LLC
  2. #
  3. # Licensed under the Apache License, Version 2.0 (the "License");
  4. # you may not use this file except in compliance with the License.
  5. # You may obtain a copy of the License at
  6. #
  7. # http://www.apache.org/licenses/LICENSE-2.0
  8. #
  9. # Unless required by applicable law or agreed to in writing, software
  10. # distributed under the License is distributed on an "AS IS" BASIS,
  11. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. # See the License for the specific language governing permissions and
  13. # limitations under the License.
  14. from typing import ClassVar as _ClassVar
  15. from typing import Iterable as _Iterable
  16. from typing import Mapping as _Mapping
  17. from typing import Optional as _Optional
  18. from typing import Union as _Union
  19. from google.protobuf import descriptor as _descriptor
  20. from google.protobuf import message as _message
  21. from google.protobuf.internal import containers as _containers
  22. DESCRIPTOR: _descriptor.FileDescriptor
  23. class Documentation(_message.Message):
  24. __slots__ = (
  25. "summary",
  26. "pages",
  27. "rules",
  28. "documentation_root_url",
  29. "service_root_url",
  30. "overview",
  31. )
  32. SUMMARY_FIELD_NUMBER: _ClassVar[int]
  33. PAGES_FIELD_NUMBER: _ClassVar[int]
  34. RULES_FIELD_NUMBER: _ClassVar[int]
  35. DOCUMENTATION_ROOT_URL_FIELD_NUMBER: _ClassVar[int]
  36. SERVICE_ROOT_URL_FIELD_NUMBER: _ClassVar[int]
  37. OVERVIEW_FIELD_NUMBER: _ClassVar[int]
  38. summary: str
  39. pages: _containers.RepeatedCompositeFieldContainer[Page]
  40. rules: _containers.RepeatedCompositeFieldContainer[DocumentationRule]
  41. documentation_root_url: str
  42. service_root_url: str
  43. overview: str
  44. def __init__(
  45. self,
  46. summary: _Optional[str] = ...,
  47. pages: _Optional[_Iterable[_Union[Page, _Mapping]]] = ...,
  48. rules: _Optional[_Iterable[_Union[DocumentationRule, _Mapping]]] = ...,
  49. documentation_root_url: _Optional[str] = ...,
  50. service_root_url: _Optional[str] = ...,
  51. overview: _Optional[str] = ...,
  52. ) -> None: ...
  53. class DocumentationRule(_message.Message):
  54. __slots__ = ("selector", "description", "deprecation_description")
  55. SELECTOR_FIELD_NUMBER: _ClassVar[int]
  56. DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
  57. DEPRECATION_DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
  58. selector: str
  59. description: str
  60. deprecation_description: str
  61. def __init__(
  62. self,
  63. selector: _Optional[str] = ...,
  64. description: _Optional[str] = ...,
  65. deprecation_description: _Optional[str] = ...,
  66. ) -> None: ...
  67. class Page(_message.Message):
  68. __slots__ = ("name", "content", "subpages")
  69. NAME_FIELD_NUMBER: _ClassVar[int]
  70. CONTENT_FIELD_NUMBER: _ClassVar[int]
  71. SUBPAGES_FIELD_NUMBER: _ClassVar[int]
  72. name: str
  73. content: str
  74. subpages: _containers.RepeatedCompositeFieldContainer[Page]
  75. def __init__(
  76. self,
  77. name: _Optional[str] = ...,
  78. content: _Optional[str] = ...,
  79. subpages: _Optional[_Iterable[_Union[Page, _Mapping]]] = ...,
  80. ) -> None: ...