client_pb2.pyi 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405
  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 descriptor_pb2 as _descriptor_pb2
  21. from google.protobuf import duration_pb2 as _duration_pb2
  22. from google.protobuf import message as _message
  23. from google.protobuf.internal import containers as _containers
  24. from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
  25. from google.api import launch_stage_pb2 as _launch_stage_pb2
  26. DESCRIPTOR: _descriptor.FileDescriptor
  27. class ClientLibraryOrganization(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
  28. __slots__ = ()
  29. CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED: _ClassVar[ClientLibraryOrganization]
  30. CLOUD: _ClassVar[ClientLibraryOrganization]
  31. ADS: _ClassVar[ClientLibraryOrganization]
  32. PHOTOS: _ClassVar[ClientLibraryOrganization]
  33. STREET_VIEW: _ClassVar[ClientLibraryOrganization]
  34. SHOPPING: _ClassVar[ClientLibraryOrganization]
  35. GEO: _ClassVar[ClientLibraryOrganization]
  36. GENERATIVE_AI: _ClassVar[ClientLibraryOrganization]
  37. class ClientLibraryDestination(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
  38. __slots__ = ()
  39. CLIENT_LIBRARY_DESTINATION_UNSPECIFIED: _ClassVar[ClientLibraryDestination]
  40. GITHUB: _ClassVar[ClientLibraryDestination]
  41. PACKAGE_MANAGER: _ClassVar[ClientLibraryDestination]
  42. CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED: ClientLibraryOrganization
  43. CLOUD: ClientLibraryOrganization
  44. ADS: ClientLibraryOrganization
  45. PHOTOS: ClientLibraryOrganization
  46. STREET_VIEW: ClientLibraryOrganization
  47. SHOPPING: ClientLibraryOrganization
  48. GEO: ClientLibraryOrganization
  49. GENERATIVE_AI: ClientLibraryOrganization
  50. CLIENT_LIBRARY_DESTINATION_UNSPECIFIED: ClientLibraryDestination
  51. GITHUB: ClientLibraryDestination
  52. PACKAGE_MANAGER: ClientLibraryDestination
  53. METHOD_SIGNATURE_FIELD_NUMBER: _ClassVar[int]
  54. method_signature: _descriptor.FieldDescriptor
  55. DEFAULT_HOST_FIELD_NUMBER: _ClassVar[int]
  56. default_host: _descriptor.FieldDescriptor
  57. OAUTH_SCOPES_FIELD_NUMBER: _ClassVar[int]
  58. oauth_scopes: _descriptor.FieldDescriptor
  59. API_VERSION_FIELD_NUMBER: _ClassVar[int]
  60. api_version: _descriptor.FieldDescriptor
  61. class CommonLanguageSettings(_message.Message):
  62. __slots__ = ("reference_docs_uri", "destinations", "selective_gapic_generation")
  63. REFERENCE_DOCS_URI_FIELD_NUMBER: _ClassVar[int]
  64. DESTINATIONS_FIELD_NUMBER: _ClassVar[int]
  65. SELECTIVE_GAPIC_GENERATION_FIELD_NUMBER: _ClassVar[int]
  66. reference_docs_uri: str
  67. destinations: _containers.RepeatedScalarFieldContainer[ClientLibraryDestination]
  68. selective_gapic_generation: SelectiveGapicGeneration
  69. def __init__(
  70. self,
  71. reference_docs_uri: _Optional[str] = ...,
  72. destinations: _Optional[_Iterable[_Union[ClientLibraryDestination, str]]] = ...,
  73. selective_gapic_generation: _Optional[
  74. _Union[SelectiveGapicGeneration, _Mapping]
  75. ] = ...,
  76. ) -> None: ...
  77. class ClientLibrarySettings(_message.Message):
  78. __slots__ = (
  79. "version",
  80. "launch_stage",
  81. "rest_numeric_enums",
  82. "java_settings",
  83. "cpp_settings",
  84. "php_settings",
  85. "python_settings",
  86. "node_settings",
  87. "dotnet_settings",
  88. "ruby_settings",
  89. "go_settings",
  90. )
  91. VERSION_FIELD_NUMBER: _ClassVar[int]
  92. LAUNCH_STAGE_FIELD_NUMBER: _ClassVar[int]
  93. REST_NUMERIC_ENUMS_FIELD_NUMBER: _ClassVar[int]
  94. JAVA_SETTINGS_FIELD_NUMBER: _ClassVar[int]
  95. CPP_SETTINGS_FIELD_NUMBER: _ClassVar[int]
  96. PHP_SETTINGS_FIELD_NUMBER: _ClassVar[int]
  97. PYTHON_SETTINGS_FIELD_NUMBER: _ClassVar[int]
  98. NODE_SETTINGS_FIELD_NUMBER: _ClassVar[int]
  99. DOTNET_SETTINGS_FIELD_NUMBER: _ClassVar[int]
  100. RUBY_SETTINGS_FIELD_NUMBER: _ClassVar[int]
  101. GO_SETTINGS_FIELD_NUMBER: _ClassVar[int]
  102. version: str
  103. launch_stage: _launch_stage_pb2.LaunchStage
  104. rest_numeric_enums: bool
  105. java_settings: JavaSettings
  106. cpp_settings: CppSettings
  107. php_settings: PhpSettings
  108. python_settings: PythonSettings
  109. node_settings: NodeSettings
  110. dotnet_settings: DotnetSettings
  111. ruby_settings: RubySettings
  112. go_settings: GoSettings
  113. def __init__(
  114. self,
  115. version: _Optional[str] = ...,
  116. launch_stage: _Optional[_Union[_launch_stage_pb2.LaunchStage, str]] = ...,
  117. rest_numeric_enums: bool = ...,
  118. java_settings: _Optional[_Union[JavaSettings, _Mapping]] = ...,
  119. cpp_settings: _Optional[_Union[CppSettings, _Mapping]] = ...,
  120. php_settings: _Optional[_Union[PhpSettings, _Mapping]] = ...,
  121. python_settings: _Optional[_Union[PythonSettings, _Mapping]] = ...,
  122. node_settings: _Optional[_Union[NodeSettings, _Mapping]] = ...,
  123. dotnet_settings: _Optional[_Union[DotnetSettings, _Mapping]] = ...,
  124. ruby_settings: _Optional[_Union[RubySettings, _Mapping]] = ...,
  125. go_settings: _Optional[_Union[GoSettings, _Mapping]] = ...,
  126. ) -> None: ...
  127. class Publishing(_message.Message):
  128. __slots__ = (
  129. "method_settings",
  130. "new_issue_uri",
  131. "documentation_uri",
  132. "api_short_name",
  133. "github_label",
  134. "codeowner_github_teams",
  135. "doc_tag_prefix",
  136. "organization",
  137. "library_settings",
  138. "proto_reference_documentation_uri",
  139. "rest_reference_documentation_uri",
  140. )
  141. METHOD_SETTINGS_FIELD_NUMBER: _ClassVar[int]
  142. NEW_ISSUE_URI_FIELD_NUMBER: _ClassVar[int]
  143. DOCUMENTATION_URI_FIELD_NUMBER: _ClassVar[int]
  144. API_SHORT_NAME_FIELD_NUMBER: _ClassVar[int]
  145. GITHUB_LABEL_FIELD_NUMBER: _ClassVar[int]
  146. CODEOWNER_GITHUB_TEAMS_FIELD_NUMBER: _ClassVar[int]
  147. DOC_TAG_PREFIX_FIELD_NUMBER: _ClassVar[int]
  148. ORGANIZATION_FIELD_NUMBER: _ClassVar[int]
  149. LIBRARY_SETTINGS_FIELD_NUMBER: _ClassVar[int]
  150. PROTO_REFERENCE_DOCUMENTATION_URI_FIELD_NUMBER: _ClassVar[int]
  151. REST_REFERENCE_DOCUMENTATION_URI_FIELD_NUMBER: _ClassVar[int]
  152. method_settings: _containers.RepeatedCompositeFieldContainer[MethodSettings]
  153. new_issue_uri: str
  154. documentation_uri: str
  155. api_short_name: str
  156. github_label: str
  157. codeowner_github_teams: _containers.RepeatedScalarFieldContainer[str]
  158. doc_tag_prefix: str
  159. organization: ClientLibraryOrganization
  160. library_settings: _containers.RepeatedCompositeFieldContainer[ClientLibrarySettings]
  161. proto_reference_documentation_uri: str
  162. rest_reference_documentation_uri: str
  163. def __init__(
  164. self,
  165. method_settings: _Optional[_Iterable[_Union[MethodSettings, _Mapping]]] = ...,
  166. new_issue_uri: _Optional[str] = ...,
  167. documentation_uri: _Optional[str] = ...,
  168. api_short_name: _Optional[str] = ...,
  169. github_label: _Optional[str] = ...,
  170. codeowner_github_teams: _Optional[_Iterable[str]] = ...,
  171. doc_tag_prefix: _Optional[str] = ...,
  172. organization: _Optional[_Union[ClientLibraryOrganization, str]] = ...,
  173. library_settings: _Optional[
  174. _Iterable[_Union[ClientLibrarySettings, _Mapping]]
  175. ] = ...,
  176. proto_reference_documentation_uri: _Optional[str] = ...,
  177. rest_reference_documentation_uri: _Optional[str] = ...,
  178. ) -> None: ...
  179. class JavaSettings(_message.Message):
  180. __slots__ = ("library_package", "service_class_names", "common")
  181. class ServiceClassNamesEntry(_message.Message):
  182. __slots__ = ("key", "value")
  183. KEY_FIELD_NUMBER: _ClassVar[int]
  184. VALUE_FIELD_NUMBER: _ClassVar[int]
  185. key: str
  186. value: str
  187. def __init__(
  188. self, key: _Optional[str] = ..., value: _Optional[str] = ...
  189. ) -> None: ...
  190. LIBRARY_PACKAGE_FIELD_NUMBER: _ClassVar[int]
  191. SERVICE_CLASS_NAMES_FIELD_NUMBER: _ClassVar[int]
  192. COMMON_FIELD_NUMBER: _ClassVar[int]
  193. library_package: str
  194. service_class_names: _containers.ScalarMap[str, str]
  195. common: CommonLanguageSettings
  196. def __init__(
  197. self,
  198. library_package: _Optional[str] = ...,
  199. service_class_names: _Optional[_Mapping[str, str]] = ...,
  200. common: _Optional[_Union[CommonLanguageSettings, _Mapping]] = ...,
  201. ) -> None: ...
  202. class CppSettings(_message.Message):
  203. __slots__ = ("common",)
  204. COMMON_FIELD_NUMBER: _ClassVar[int]
  205. common: CommonLanguageSettings
  206. def __init__(
  207. self, common: _Optional[_Union[CommonLanguageSettings, _Mapping]] = ...
  208. ) -> None: ...
  209. class PhpSettings(_message.Message):
  210. __slots__ = ("common",)
  211. COMMON_FIELD_NUMBER: _ClassVar[int]
  212. common: CommonLanguageSettings
  213. def __init__(
  214. self, common: _Optional[_Union[CommonLanguageSettings, _Mapping]] = ...
  215. ) -> None: ...
  216. class PythonSettings(_message.Message):
  217. __slots__ = ("common", "experimental_features")
  218. class ExperimentalFeatures(_message.Message):
  219. __slots__ = (
  220. "rest_async_io_enabled",
  221. "protobuf_pythonic_types_enabled",
  222. "unversioned_package_disabled",
  223. )
  224. REST_ASYNC_IO_ENABLED_FIELD_NUMBER: _ClassVar[int]
  225. PROTOBUF_PYTHONIC_TYPES_ENABLED_FIELD_NUMBER: _ClassVar[int]
  226. UNVERSIONED_PACKAGE_DISABLED_FIELD_NUMBER: _ClassVar[int]
  227. rest_async_io_enabled: bool
  228. protobuf_pythonic_types_enabled: bool
  229. unversioned_package_disabled: bool
  230. def __init__(
  231. self,
  232. rest_async_io_enabled: bool = ...,
  233. protobuf_pythonic_types_enabled: bool = ...,
  234. unversioned_package_disabled: bool = ...,
  235. ) -> None: ...
  236. COMMON_FIELD_NUMBER: _ClassVar[int]
  237. EXPERIMENTAL_FEATURES_FIELD_NUMBER: _ClassVar[int]
  238. common: CommonLanguageSettings
  239. experimental_features: PythonSettings.ExperimentalFeatures
  240. def __init__(
  241. self,
  242. common: _Optional[_Union[CommonLanguageSettings, _Mapping]] = ...,
  243. experimental_features: _Optional[
  244. _Union[PythonSettings.ExperimentalFeatures, _Mapping]
  245. ] = ...,
  246. ) -> None: ...
  247. class NodeSettings(_message.Message):
  248. __slots__ = ("common",)
  249. COMMON_FIELD_NUMBER: _ClassVar[int]
  250. common: CommonLanguageSettings
  251. def __init__(
  252. self, common: _Optional[_Union[CommonLanguageSettings, _Mapping]] = ...
  253. ) -> None: ...
  254. class DotnetSettings(_message.Message):
  255. __slots__ = (
  256. "common",
  257. "renamed_services",
  258. "renamed_resources",
  259. "ignored_resources",
  260. "forced_namespace_aliases",
  261. "handwritten_signatures",
  262. )
  263. class RenamedServicesEntry(_message.Message):
  264. __slots__ = ("key", "value")
  265. KEY_FIELD_NUMBER: _ClassVar[int]
  266. VALUE_FIELD_NUMBER: _ClassVar[int]
  267. key: str
  268. value: str
  269. def __init__(
  270. self, key: _Optional[str] = ..., value: _Optional[str] = ...
  271. ) -> None: ...
  272. class RenamedResourcesEntry(_message.Message):
  273. __slots__ = ("key", "value")
  274. KEY_FIELD_NUMBER: _ClassVar[int]
  275. VALUE_FIELD_NUMBER: _ClassVar[int]
  276. key: str
  277. value: str
  278. def __init__(
  279. self, key: _Optional[str] = ..., value: _Optional[str] = ...
  280. ) -> None: ...
  281. COMMON_FIELD_NUMBER: _ClassVar[int]
  282. RENAMED_SERVICES_FIELD_NUMBER: _ClassVar[int]
  283. RENAMED_RESOURCES_FIELD_NUMBER: _ClassVar[int]
  284. IGNORED_RESOURCES_FIELD_NUMBER: _ClassVar[int]
  285. FORCED_NAMESPACE_ALIASES_FIELD_NUMBER: _ClassVar[int]
  286. HANDWRITTEN_SIGNATURES_FIELD_NUMBER: _ClassVar[int]
  287. common: CommonLanguageSettings
  288. renamed_services: _containers.ScalarMap[str, str]
  289. renamed_resources: _containers.ScalarMap[str, str]
  290. ignored_resources: _containers.RepeatedScalarFieldContainer[str]
  291. forced_namespace_aliases: _containers.RepeatedScalarFieldContainer[str]
  292. handwritten_signatures: _containers.RepeatedScalarFieldContainer[str]
  293. def __init__(
  294. self,
  295. common: _Optional[_Union[CommonLanguageSettings, _Mapping]] = ...,
  296. renamed_services: _Optional[_Mapping[str, str]] = ...,
  297. renamed_resources: _Optional[_Mapping[str, str]] = ...,
  298. ignored_resources: _Optional[_Iterable[str]] = ...,
  299. forced_namespace_aliases: _Optional[_Iterable[str]] = ...,
  300. handwritten_signatures: _Optional[_Iterable[str]] = ...,
  301. ) -> None: ...
  302. class RubySettings(_message.Message):
  303. __slots__ = ("common",)
  304. COMMON_FIELD_NUMBER: _ClassVar[int]
  305. common: CommonLanguageSettings
  306. def __init__(
  307. self, common: _Optional[_Union[CommonLanguageSettings, _Mapping]] = ...
  308. ) -> None: ...
  309. class GoSettings(_message.Message):
  310. __slots__ = ("common", "renamed_services")
  311. class RenamedServicesEntry(_message.Message):
  312. __slots__ = ("key", "value")
  313. KEY_FIELD_NUMBER: _ClassVar[int]
  314. VALUE_FIELD_NUMBER: _ClassVar[int]
  315. key: str
  316. value: str
  317. def __init__(
  318. self, key: _Optional[str] = ..., value: _Optional[str] = ...
  319. ) -> None: ...
  320. COMMON_FIELD_NUMBER: _ClassVar[int]
  321. RENAMED_SERVICES_FIELD_NUMBER: _ClassVar[int]
  322. common: CommonLanguageSettings
  323. renamed_services: _containers.ScalarMap[str, str]
  324. def __init__(
  325. self,
  326. common: _Optional[_Union[CommonLanguageSettings, _Mapping]] = ...,
  327. renamed_services: _Optional[_Mapping[str, str]] = ...,
  328. ) -> None: ...
  329. class MethodSettings(_message.Message):
  330. __slots__ = ("selector", "long_running", "auto_populated_fields")
  331. class LongRunning(_message.Message):
  332. __slots__ = (
  333. "initial_poll_delay",
  334. "poll_delay_multiplier",
  335. "max_poll_delay",
  336. "total_poll_timeout",
  337. )
  338. INITIAL_POLL_DELAY_FIELD_NUMBER: _ClassVar[int]
  339. POLL_DELAY_MULTIPLIER_FIELD_NUMBER: _ClassVar[int]
  340. MAX_POLL_DELAY_FIELD_NUMBER: _ClassVar[int]
  341. TOTAL_POLL_TIMEOUT_FIELD_NUMBER: _ClassVar[int]
  342. initial_poll_delay: _duration_pb2.Duration
  343. poll_delay_multiplier: float
  344. max_poll_delay: _duration_pb2.Duration
  345. total_poll_timeout: _duration_pb2.Duration
  346. def __init__(
  347. self,
  348. initial_poll_delay: _Optional[
  349. _Union[_duration_pb2.Duration, _Mapping]
  350. ] = ...,
  351. poll_delay_multiplier: _Optional[float] = ...,
  352. max_poll_delay: _Optional[_Union[_duration_pb2.Duration, _Mapping]] = ...,
  353. total_poll_timeout: _Optional[
  354. _Union[_duration_pb2.Duration, _Mapping]
  355. ] = ...,
  356. ) -> None: ...
  357. SELECTOR_FIELD_NUMBER: _ClassVar[int]
  358. LONG_RUNNING_FIELD_NUMBER: _ClassVar[int]
  359. AUTO_POPULATED_FIELDS_FIELD_NUMBER: _ClassVar[int]
  360. selector: str
  361. long_running: MethodSettings.LongRunning
  362. auto_populated_fields: _containers.RepeatedScalarFieldContainer[str]
  363. def __init__(
  364. self,
  365. selector: _Optional[str] = ...,
  366. long_running: _Optional[_Union[MethodSettings.LongRunning, _Mapping]] = ...,
  367. auto_populated_fields: _Optional[_Iterable[str]] = ...,
  368. ) -> None: ...
  369. class SelectiveGapicGeneration(_message.Message):
  370. __slots__ = ("methods", "generate_omitted_as_internal")
  371. METHODS_FIELD_NUMBER: _ClassVar[int]
  372. GENERATE_OMITTED_AS_INTERNAL_FIELD_NUMBER: _ClassVar[int]
  373. methods: _containers.RepeatedScalarFieldContainer[str]
  374. generate_omitted_as_internal: bool
  375. def __init__(
  376. self,
  377. methods: _Optional[_Iterable[str]] = ...,
  378. generate_omitted_as_internal: bool = ...,
  379. ) -> None: ...