@devvit/protos 0.11.4 → 0.11.5-next-2024-12-09-1c29dd3cd.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (244) hide show
  1. package/meta.min.json +7814 -0
  2. package/package.json +4 -4
  3. package/protos.min.js +2 -0
  4. package/protos.min.js.map +7 -0
  5. package/schema/.snootobuf/deps/buf/validate/expression.proto +92 -0
  6. package/schema/.snootobuf/deps/buf/validate/priv/private.proto +41 -0
  7. package/schema/.snootobuf/deps/buf/validate/validate.proto +4130 -0
  8. package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/audit.proto +72 -0
  9. package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/auth.proto +49 -0
  10. package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/organization.proto +54 -0
  11. package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/service.proto +46 -0
  12. package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/subscription.proto +72 -0
  13. package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/ui.proto +20 -0
  14. package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/user.proto +45 -0
  15. package/schema/.snootobuf/deps/devvit/data/api/v1alpha/admin.proto +54 -0
  16. package/schema/.snootobuf/deps/devvit/data/api/v1alpha/delivery.proto +773 -0
  17. package/schema/.snootobuf/deps/devvit/data/api/v1alpha/filter.proto +66 -0
  18. package/schema/.snootobuf/deps/devvit/data/api/v1alpha/firehose.proto +100 -0
  19. package/schema/.snootobuf/deps/devvit/data/api/v1alpha/intake.proto +19 -0
  20. package/schema/.snootobuf/deps/devvit/events/v1alpha/events.proto +446 -0
  21. package/schema/.snootobuf/deps/devvit/gateway/v1alpha/payments.proto +24 -0
  22. package/schema/.snootobuf/deps/devvit/options/options.proto +98 -0
  23. package/schema/.snootobuf/deps/devvit/reddit/v2alpha/commentv2.proto +29 -0
  24. package/schema/.snootobuf/deps/devvit/reddit/v2alpha/flair.proto +25 -0
  25. package/schema/.snootobuf/deps/devvit/reddit/v2alpha/modaction.proto +53 -0
  26. package/schema/.snootobuf/deps/devvit/reddit/v2alpha/modmail.proto +56 -0
  27. package/schema/.snootobuf/deps/devvit/reddit/v2alpha/postv2.proto +107 -0
  28. package/schema/.snootobuf/deps/devvit/reddit/v2alpha/subredditv2.proto +41 -0
  29. package/schema/.snootobuf/deps/devvit/reddit/v2alpha/userv2.proto +23 -0
  30. package/schema/.snootobuf/deps/devvit/triggers/v1alpha/triggers.proto +162 -0
  31. package/schema/.snootobuf/deps/enum/account_gender_category.proto +14 -0
  32. package/schema/.snootobuf/deps/enum/approval_status.proto +15 -0
  33. package/schema/.snootobuf/deps/enum/automated_reporting_level.proto +12 -0
  34. package/schema/.snootobuf/deps/enum/ban_evasion_threshold.proto +13 -0
  35. package/schema/.snootobuf/deps/enum/ban_info_action.proto +12 -0
  36. package/schema/.snootobuf/deps/enum/block_relation_type.proto +11 -0
  37. package/schema/.snootobuf/deps/enum/comment_sort.proto +18 -0
  38. package/schema/.snootobuf/deps/enum/comment_type.proto +11 -0
  39. package/schema/.snootobuf/deps/enum/crowd_control_level.proto +12 -0
  40. package/schema/.snootobuf/deps/enum/discussion_type.proto +10 -0
  41. package/schema/.snootobuf/deps/enum/distinguish_type.proto +14 -0
  42. package/schema/.snootobuf/deps/enum/flair_position.proto +11 -0
  43. package/schema/.snootobuf/deps/enum/hateful_content_threshold.proto +12 -0
  44. package/schema/.snootobuf/deps/enum/link_content_type.proto +11 -0
  45. package/schema/.snootobuf/deps/enum/link_type.proto +11 -0
  46. package/schema/.snootobuf/deps/enum/link_visibility.proto +11 -0
  47. package/schema/.snootobuf/deps/enum/prediction_leaderboard_entry_type.proto +11 -0
  48. package/schema/.snootobuf/deps/enum/promo_layout.proto +11 -0
  49. package/schema/.snootobuf/deps/enum/removed_by_type.proto +18 -0
  50. package/schema/.snootobuf/deps/enum/spam_level.proto +11 -0
  51. package/schema/.snootobuf/deps/enum/subreddit_type.proto +16 -0
  52. package/schema/.snootobuf/deps/enum/verdict.proto +14 -0
  53. package/schema/.snootobuf/deps/enum/vote.proto +12 -0
  54. package/schema/.snootobuf/deps/enum/whitelist_status.proto +17 -0
  55. package/schema/.snootobuf/deps/enum/wiki_edit_mode.proto +12 -0
  56. package/schema/.snootobuf/deps/evaluator/evaluator.proto +203 -0
  57. package/schema/.snootobuf/deps/google/api/annotations.proto +31 -0
  58. package/schema/.snootobuf/deps/google/api/apikeys/v2/apikeys.proto +288 -0
  59. package/schema/.snootobuf/deps/google/api/apikeys/v2/resources.proto +175 -0
  60. package/schema/.snootobuf/deps/google/api/auth.proto +237 -0
  61. package/schema/.snootobuf/deps/google/api/backend.proto +185 -0
  62. package/schema/.snootobuf/deps/google/api/billing.proto +77 -0
  63. package/schema/.snootobuf/deps/google/api/client.proto +431 -0
  64. package/schema/.snootobuf/deps/google/api/cloudquotas/v1/cloudquotas.proto +322 -0
  65. package/schema/.snootobuf/deps/google/api/cloudquotas/v1/resources.proto +315 -0
  66. package/schema/.snootobuf/deps/google/api/config_change.proto +84 -0
  67. package/schema/.snootobuf/deps/google/api/consumer.proto +82 -0
  68. package/schema/.snootobuf/deps/google/api/context.proto +92 -0
  69. package/schema/.snootobuf/deps/google/api/control.proto +41 -0
  70. package/schema/.snootobuf/deps/google/api/distribution.proto +213 -0
  71. package/schema/.snootobuf/deps/google/api/documentation.proto +168 -0
  72. package/schema/.snootobuf/deps/google/api/endpoint.proto +69 -0
  73. package/schema/.snootobuf/deps/google/api/error_reason.proto +589 -0
  74. package/schema/.snootobuf/deps/google/api/expr/conformance/v1alpha1/conformance_service.proto +183 -0
  75. package/schema/.snootobuf/deps/google/api/expr/v1alpha1/checked.proto +343 -0
  76. package/schema/.snootobuf/deps/google/api/expr/v1alpha1/eval.proto +118 -0
  77. package/schema/.snootobuf/deps/google/api/expr/v1alpha1/explain.proto +53 -0
  78. package/schema/.snootobuf/deps/google/api/expr/v1alpha1/syntax.proto +438 -0
  79. package/schema/.snootobuf/deps/google/api/expr/v1alpha1/value.proto +115 -0
  80. package/schema/.snootobuf/deps/google/api/expr/v1beta1/decl.proto +84 -0
  81. package/schema/.snootobuf/deps/google/api/expr/v1beta1/eval.proto +125 -0
  82. package/schema/.snootobuf/deps/google/api/expr/v1beta1/expr.proto +265 -0
  83. package/schema/.snootobuf/deps/google/api/expr/v1beta1/source.proto +62 -0
  84. package/schema/.snootobuf/deps/google/api/expr/v1beta1/value.proto +114 -0
  85. package/schema/.snootobuf/deps/google/api/field_behavior.proto +104 -0
  86. package/schema/.snootobuf/deps/google/api/field_info.proto +106 -0
  87. package/schema/.snootobuf/deps/google/api/http.proto +371 -0
  88. package/schema/.snootobuf/deps/google/api/httpbody.proto +81 -0
  89. package/schema/.snootobuf/deps/google/api/label.proto +48 -0
  90. package/schema/.snootobuf/deps/google/api/launch_stage.proto +72 -0
  91. package/schema/.snootobuf/deps/google/api/log.proto +54 -0
  92. package/schema/.snootobuf/deps/google/api/logging.proto +81 -0
  93. package/schema/.snootobuf/deps/google/api/metric.proto +268 -0
  94. package/schema/.snootobuf/deps/google/api/monitored_resource.proto +130 -0
  95. package/schema/.snootobuf/deps/google/api/monitoring.proto +107 -0
  96. package/schema/.snootobuf/deps/google/api/policy.proto +85 -0
  97. package/schema/.snootobuf/deps/google/api/quota.proto +184 -0
  98. package/schema/.snootobuf/deps/google/api/resource.proto +243 -0
  99. package/schema/.snootobuf/deps/google/api/routing.proto +461 -0
  100. package/schema/.snootobuf/deps/google/api/service.proto +191 -0
  101. package/schema/.snootobuf/deps/google/api/servicecontrol/v1/check_error.proto +124 -0
  102. package/schema/.snootobuf/deps/google/api/servicecontrol/v1/distribution.proto +166 -0
  103. package/schema/.snootobuf/deps/google/api/servicecontrol/v1/http_request.proto +93 -0
  104. package/schema/.snootobuf/deps/google/api/servicecontrol/v1/log_entry.proto +126 -0
  105. package/schema/.snootobuf/deps/google/api/servicecontrol/v1/metric_value.proto +81 -0
  106. package/schema/.snootobuf/deps/google/api/servicecontrol/v1/operation.proto +123 -0
  107. package/schema/.snootobuf/deps/google/api/servicecontrol/v1/quota_controller.proto +245 -0
  108. package/schema/.snootobuf/deps/google/api/servicecontrol/v1/service_controller.proto +260 -0
  109. package/schema/.snootobuf/deps/google/api/servicecontrol/v2/service_controller.proto +196 -0
  110. package/schema/.snootobuf/deps/google/api/servicemanagement/v1/resources.proto +295 -0
  111. package/schema/.snootobuf/deps/google/api/servicemanagement/v1/servicemanager.proto +508 -0
  112. package/schema/.snootobuf/deps/google/api/serviceusage/v1/resources.proto +130 -0
  113. package/schema/.snootobuf/deps/google/api/serviceusage/v1/serviceusage.proto +305 -0
  114. package/schema/.snootobuf/deps/google/api/serviceusage/v1beta1/resources.proto +458 -0
  115. package/schema/.snootobuf/deps/google/api/serviceusage/v1beta1/serviceusage.proto +793 -0
  116. package/schema/.snootobuf/deps/google/api/source_info.proto +31 -0
  117. package/schema/.snootobuf/deps/google/api/system_parameter.proto +96 -0
  118. package/schema/.snootobuf/deps/google/api/usage.proto +96 -0
  119. package/schema/.snootobuf/deps/google/api/visibility.proto +113 -0
  120. package/schema/.snootobuf/deps/google/cloud/extended_operations.proto +150 -0
  121. package/schema/.snootobuf/deps/google/iam/admin/v1/iam.proto +1087 -0
  122. package/schema/.snootobuf/deps/google/iam/v1/iam_policy.proto +145 -0
  123. package/schema/.snootobuf/deps/google/iam/v1/logging/audit_data.proto +34 -0
  124. package/schema/.snootobuf/deps/google/iam/v1/options.proto +41 -0
  125. package/schema/.snootobuf/deps/google/iam/v1/policy.proto +240 -0
  126. package/schema/.snootobuf/deps/google/logging/type/http_request.proto +92 -0
  127. package/schema/.snootobuf/deps/google/logging/type/log_severity.proto +72 -0
  128. package/schema/.snootobuf/deps/google/longrunning/operations.proto +247 -0
  129. package/schema/.snootobuf/deps/google/protobuf/any.proto +158 -0
  130. package/schema/.snootobuf/deps/google/protobuf/api.proto +208 -0
  131. package/schema/.snootobuf/deps/google/protobuf/compiler/plugin.proto +183 -0
  132. package/schema/.snootobuf/deps/google/protobuf/descriptor.proto +921 -0
  133. package/schema/.snootobuf/deps/google/protobuf/duration.proto +116 -0
  134. package/schema/.snootobuf/deps/google/protobuf/empty.proto +51 -0
  135. package/schema/.snootobuf/deps/google/protobuf/field_mask.proto +245 -0
  136. package/schema/.snootobuf/deps/google/protobuf/source_context.proto +48 -0
  137. package/schema/.snootobuf/deps/google/protobuf/struct.proto +95 -0
  138. package/schema/.snootobuf/deps/google/protobuf/timestamp.proto +147 -0
  139. package/schema/.snootobuf/deps/google/protobuf/type.proto +187 -0
  140. package/schema/.snootobuf/deps/google/protobuf/wrappers.proto +123 -0
  141. package/schema/.snootobuf/deps/google/rpc/code.proto +186 -0
  142. package/schema/.snootobuf/deps/google/rpc/context/attribute_context.proto +287 -0
  143. package/schema/.snootobuf/deps/google/rpc/error_details.proto +246 -0
  144. package/schema/.snootobuf/deps/google/rpc/status.proto +47 -0
  145. package/schema/.snootobuf/deps/google/type/calendar_period.proto +57 -0
  146. package/schema/.snootobuf/deps/google/type/color.proto +170 -0
  147. package/schema/.snootobuf/deps/google/type/date.proto +50 -0
  148. package/schema/.snootobuf/deps/google/type/datetime.proto +97 -0
  149. package/schema/.snootobuf/deps/google/type/dayofweek.proto +51 -0
  150. package/schema/.snootobuf/deps/google/type/expr.proto +51 -0
  151. package/schema/.snootobuf/deps/google/type/fraction.proto +34 -0
  152. package/schema/.snootobuf/deps/google/type/latlng.proto +37 -0
  153. package/schema/.snootobuf/deps/google/type/money.proto +43 -0
  154. package/schema/.snootobuf/deps/google/type/month.proto +66 -0
  155. package/schema/.snootobuf/deps/google/type/postal_address.proto +135 -0
  156. package/schema/.snootobuf/deps/google/type/quaternion.proto +95 -0
  157. package/schema/.snootobuf/deps/google/type/timeofday.proto +44 -0
  158. package/schema/.snootobuf/deps/openapi/helper.proto +20 -0
  159. package/schema/.snootobuf/deps/products-api/protos/reddit/xpaymentsplatform/payproducts/v1/currencies.proto +189 -0
  160. package/schema/.snootobuf/deps/products-api/protos/reddit/xpaymentsplatform/payproducts/v1/payproducts.proto +118 -0
  161. package/schema/.snootobuf/deps/reddit/api/metadata/v1/metadata.proto +55 -0
  162. package/schema/.snootobuf/deps/reddit/coreplatform/account/v1/account.proto +579 -0
  163. package/schema/.snootobuf/deps/reddit/coreplatform/account/v1/account_relations.proto +43 -0
  164. package/schema/.snootobuf/deps/reddit/coreplatform/api/metadata/v1/metadata.proto +82 -0
  165. package/schema/.snootobuf/deps/reddit/coreplatform/blocking/v1/user_blocking_service.proto +221 -0
  166. package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comment_tree.proto +78 -0
  167. package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comment_tree_service.proto +189 -0
  168. package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comment_tree_structure.proto +29 -0
  169. package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comments.proto +417 -0
  170. package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comments_service.proto +72 -0
  171. package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/auth.proto +25 -0
  172. package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/features.proto +52 -0
  173. package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/lang.proto +16 -0
  174. package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/legal.proto +20 -0
  175. package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/media.proto +149 -0
  176. package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/moderation.proto +197 -0
  177. package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/safety.proto +116 -0
  178. package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/time.proto +25 -0
  179. package/schema/.snootobuf/deps/reddit/coreplatform/domains/v1/domains_metadata_service.proto +101 -0
  180. package/schema/.snootobuf/deps/reddit/coreplatform/grpc_thrift/v1/grpc_thrift_options.proto +34 -0
  181. package/schema/.snootobuf/deps/reddit/coreplatform/links/v1/links.proto +798 -0
  182. package/schema/.snootobuf/deps/reddit/coreplatform/links/v1/links_service.proto +186 -0
  183. package/schema/.snootobuf/deps/reddit/coreplatform/messages/v1/messages.proto +110 -0
  184. package/schema/.snootobuf/deps/reddit/coreplatform/sensitive/v1/wrappers.proto +51 -0
  185. package/schema/.snootobuf/deps/reddit/coreplatform/subreddit/v1/subreddit.proto +1202 -0
  186. package/schema/.snootobuf/deps/reddit/coreplatform/subreddit/v1/subreddit_member_relations.proto +85 -0
  187. package/schema/.snootobuf/deps/reddit/coreplatform/subreddit/v1/subreddit_moderator_service.proto +363 -0
  188. package/schema/.snootobuf/deps/reddit/coreplatform/subreddit/v1/subreddit_service.proto +301 -0
  189. package/schema/.snootobuf/deps/reddit/coreplatform/thing/v0/thing.proto +2869 -0
  190. package/schema/.snootobuf/deps/reddit/devvit/custom_post/v1/custom_post.proto +15 -0
  191. package/schema/.snootobuf/deps/reddit/devvit/custom_post/v1/service.proto +11 -0
  192. package/schema/.snootobuf/deps/reddit/devvit/subreddit/v1/context_action.proto +48 -0
  193. package/schema/.snootobuf/deps/reddit/devvit/subreddit/v1/manifest.proto +70 -0
  194. package/schema/.snootobuf/deps/reddit/devvit/subreddit/v1/service.proto +11 -0
  195. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/acknowledge_order_delivery.proto +17 -0
  196. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/checkout.proto +89 -0
  197. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/common.proto +322 -0
  198. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/delete_products.proto +17 -0
  199. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/events.proto +14 -0
  200. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_batch_products.proto +15 -0
  201. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_gold_balances.proto +48 -0
  202. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_order.proto +31 -0
  203. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_orders.proto +26 -0
  204. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_orders_by_user.proto +15 -0
  205. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_payout_info_batch.proto +52 -0
  206. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_products.proto +23 -0
  207. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_user_profiles.proto +28 -0
  208. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/refund_order.proto +17 -0
  209. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/service.proto +49 -0
  210. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/service_data_compliance.proto +20 -0
  211. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/upsert_products.proto +17 -0
  212. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paygatewaypsps/v1/paygatewaypsps.proto +158 -0
  213. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payorders/v1/payments_data_compliance.proto +18 -0
  214. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payorders/v1/payorders.proto +195 -0
  215. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/admin.proto +44 -0
  216. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/ledger.proto +200 -0
  217. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/payments_data_compliance.proto +18 -0
  218. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/paypayments.proto +210 -0
  219. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payproducts/v1/currencies.proto +189 -0
  220. package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payproducts/v1/payproducts.proto +135 -0
  221. package/schema/.snootobuf/deps/snooron_sources/text_classification/text_classification.proto +29 -0
  222. package/schema/.snootobuf/deps/snooron_sources/v2_event/v2_event.proto +3292 -0
  223. package/schema/.snootobuf/deps/validate/validate.proto +862 -0
  224. package/schema/devvit/dev_portal/app/app.proto +3 -0
  225. package/schema/devvit/dev_portal/app/info/app_info.proto +13 -1
  226. package/schema/devvit/ui/block_kit/v1beta/ui.proto +1 -1
  227. package/schema/devvit/ui/effects/web_view/v1alpha/fullscreen.proto +7 -1
  228. package/schema/snootobuf.devenv.lock +459 -292
  229. package/schema/snootobuf.lock +459 -292
  230. package/schema/snootobuf.redditapi.lock +459 -292
  231. package/schema/snootobuf.ts.lock +459 -293
  232. package/types/devvit/dev_portal/app/app.d.ts +2 -0
  233. package/types/devvit/dev_portal/app/app.d.ts.map +1 -1
  234. package/types/devvit/dev_portal/app/app.js +17 -0
  235. package/types/devvit/dev_portal/app/info/app_info.d.ts +13 -0
  236. package/types/devvit/dev_portal/app/info/app_info.d.ts.map +1 -1
  237. package/types/devvit/dev_portal/app/info/app_info.js +17 -0
  238. package/types/devvit/dev_portal/dev_portal.d.ts +42 -0
  239. package/types/devvit/dev_portal/dev_portal.d.ts.map +1 -1
  240. package/types/devvit/reddit/custom_post/v1alpha/custom_post.d.ts +4 -0
  241. package/types/devvit/reddit/custom_post/v1alpha/custom_post.d.ts.map +1 -1
  242. package/types/devvit/ui/effects/web_view/v1alpha/fullscreen.d.ts +8 -1
  243. package/types/devvit/ui/effects/web_view/v1alpha/fullscreen.d.ts.map +1 -1
  244. package/types/devvit/ui/effects/web_view/v1alpha/fullscreen.js +15 -1
@@ -0,0 +1,31 @@
1
+ // Copyright 2024 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
+
15
+ syntax = "proto3";
16
+
17
+ package google.api;
18
+
19
+ import "google/protobuf/any.proto";
20
+
21
+ option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
22
+ option java_multiple_files = true;
23
+ option java_outer_classname = "SourceInfoProto";
24
+ option java_package = "com.google.api";
25
+ option objc_class_prefix = "GAPI";
26
+
27
+ // Source information used to create a Service Config
28
+ message SourceInfo {
29
+ // All files used during config generation.
30
+ repeated google.protobuf.Any source_files = 1;
31
+ }
@@ -0,0 +1,96 @@
1
+ // Copyright 2024 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
+
15
+ syntax = "proto3";
16
+
17
+ package google.api;
18
+
19
+ option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
20
+ option java_multiple_files = true;
21
+ option java_outer_classname = "SystemParameterProto";
22
+ option java_package = "com.google.api";
23
+ option objc_class_prefix = "GAPI";
24
+
25
+ // ### System parameter configuration
26
+ //
27
+ // A system parameter is a special kind of parameter defined by the API
28
+ // system, not by an individual API. It is typically mapped to an HTTP header
29
+ // and/or a URL query parameter. This configuration specifies which methods
30
+ // change the names of the system parameters.
31
+ message SystemParameters {
32
+ // Define system parameters.
33
+ //
34
+ // The parameters defined here will override the default parameters
35
+ // implemented by the system. If this field is missing from the service
36
+ // config, default system parameters will be used. Default system parameters
37
+ // and names is implementation-dependent.
38
+ //
39
+ // Example: define api key for all methods
40
+ //
41
+ // system_parameters
42
+ // rules:
43
+ // - selector: "*"
44
+ // parameters:
45
+ // - name: api_key
46
+ // url_query_parameter: api_key
47
+ //
48
+ //
49
+ // Example: define 2 api key names for a specific method.
50
+ //
51
+ // system_parameters
52
+ // rules:
53
+ // - selector: "/ListShelves"
54
+ // parameters:
55
+ // - name: api_key
56
+ // http_header: Api-Key1
57
+ // - name: api_key
58
+ // http_header: Api-Key2
59
+ //
60
+ // **NOTE:** All service configuration rules follow "last one wins" order.
61
+ repeated SystemParameterRule rules = 1;
62
+ }
63
+
64
+ // Define a system parameter rule mapping system parameter definitions to
65
+ // methods.
66
+ message SystemParameterRule {
67
+ // Selects the methods to which this rule applies. Use '*' to indicate all
68
+ // methods in all APIs.
69
+ //
70
+ // Refer to [selector][google.api.DocumentationRule.selector] for syntax
71
+ // details.
72
+ string selector = 1;
73
+
74
+ // Define parameters. Multiple names may be defined for a parameter.
75
+ // For a given method call, only one of them should be used. If multiple
76
+ // names are used the behavior is implementation-dependent.
77
+ // If none of the specified names are present the behavior is
78
+ // parameter-dependent.
79
+ repeated SystemParameter parameters = 2;
80
+ }
81
+
82
+ // Define a parameter's name and location. The parameter may be passed as either
83
+ // an HTTP header or a URL query parameter, and if both are passed the behavior
84
+ // is implementation-dependent.
85
+ message SystemParameter {
86
+ // Define the name of the parameter, such as "api_key" . It is case sensitive.
87
+ string name = 1;
88
+
89
+ // Define the HTTP header name to use for the parameter. It is case
90
+ // insensitive.
91
+ string http_header = 2;
92
+
93
+ // Define the URL query parameter name to use for the parameter. It is case
94
+ // sensitive.
95
+ string url_query_parameter = 3;
96
+ }
@@ -0,0 +1,96 @@
1
+ // Copyright 2024 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
+
15
+ syntax = "proto3";
16
+
17
+ package google.api;
18
+
19
+ option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
20
+ option java_multiple_files = true;
21
+ option java_outer_classname = "UsageProto";
22
+ option java_package = "com.google.api";
23
+ option objc_class_prefix = "GAPI";
24
+
25
+ // Configuration controlling usage of a service.
26
+ message Usage {
27
+ // Requirements that must be satisfied before a consumer project can use the
28
+ // service. Each requirement is of the form <service.name>/<requirement-id>;
29
+ // for example 'serviceusage.googleapis.com/billing-enabled'.
30
+ //
31
+ // For Google APIs, a Terms of Service requirement must be included here.
32
+ // Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud".
33
+ // Other Google APIs should include
34
+ // "serviceusage.googleapis.com/tos/universal". Additional ToS can be
35
+ // included based on the business needs.
36
+ repeated string requirements = 1;
37
+
38
+ // A list of usage rules that apply to individual API methods.
39
+ //
40
+ // **NOTE:** All service configuration rules follow "last one wins" order.
41
+ repeated UsageRule rules = 6;
42
+
43
+ // The full resource name of a channel used for sending notifications to the
44
+ // service producer.
45
+ //
46
+ // Google Service Management currently only supports
47
+ // [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification
48
+ // channel. To use Google Cloud Pub/Sub as the channel, this must be the name
49
+ // of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format
50
+ // documented in https://cloud.google.com/pubsub/docs/overview.
51
+ string producer_notification_channel = 7;
52
+ }
53
+
54
+ // Usage configuration rules for the service.
55
+ //
56
+ // NOTE: Under development.
57
+ //
58
+ //
59
+ // Use this rule to configure unregistered calls for the service. Unregistered
60
+ // calls are calls that do not contain consumer project identity.
61
+ // (Example: calls that do not contain an API key).
62
+ // By default, API methods do not allow unregistered calls, and each method call
63
+ // must be identified by a consumer project identity. Use this rule to
64
+ // allow/disallow unregistered calls.
65
+ //
66
+ // Example of an API that wants to allow unregistered calls for entire service.
67
+ //
68
+ // usage:
69
+ // rules:
70
+ // - selector: "*"
71
+ // allow_unregistered_calls: true
72
+ //
73
+ // Example of a method that wants to allow unregistered calls.
74
+ //
75
+ // usage:
76
+ // rules:
77
+ // - selector: "google.example.library.v1.LibraryService.CreateBook"
78
+ // allow_unregistered_calls: true
79
+ message UsageRule {
80
+ // Selects the methods to which this rule applies. Use '*' to indicate all
81
+ // methods in all APIs.
82
+ //
83
+ // Refer to [selector][google.api.DocumentationRule.selector] for syntax
84
+ // details.
85
+ string selector = 1;
86
+
87
+ // If true, the selected method allows unregistered calls, e.g. calls
88
+ // that don't identify any user or application.
89
+ bool allow_unregistered_calls = 2;
90
+
91
+ // If true, the selected method should skip service control and the control
92
+ // plane features, such as quota and billing, will not be available.
93
+ // This flag is used by Google Cloud Endpoints to bypass checks for internal
94
+ // methods, such as service health check methods.
95
+ bool skip_service_control = 3;
96
+ }
@@ -0,0 +1,113 @@
1
+ // Copyright 2024 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
+
15
+ syntax = "proto3";
16
+
17
+ package google.api;
18
+
19
+ import "google/protobuf/descriptor.proto";
20
+
21
+ option cc_enable_arenas = true;
22
+ option go_package = "google.golang.org/genproto/googleapis/api/visibility;visibility";
23
+ option java_multiple_files = true;
24
+ option java_outer_classname = "VisibilityProto";
25
+ option java_package = "com.google.api";
26
+ option objc_class_prefix = "GAPI";
27
+
28
+ extend google.protobuf.EnumOptions {
29
+ // See `VisibilityRule`.
30
+ google.api.VisibilityRule enum_visibility = 72295727;
31
+ }
32
+
33
+ extend google.protobuf.EnumValueOptions {
34
+ // See `VisibilityRule`.
35
+ google.api.VisibilityRule value_visibility = 72295727;
36
+ }
37
+
38
+ extend google.protobuf.FieldOptions {
39
+ // See `VisibilityRule`.
40
+ google.api.VisibilityRule field_visibility = 72295727;
41
+ }
42
+
43
+ extend google.protobuf.MessageOptions {
44
+ // See `VisibilityRule`.
45
+ google.api.VisibilityRule message_visibility = 72295727;
46
+ }
47
+
48
+ extend google.protobuf.MethodOptions {
49
+ // See `VisibilityRule`.
50
+ google.api.VisibilityRule method_visibility = 72295727;
51
+ }
52
+
53
+ extend google.protobuf.ServiceOptions {
54
+ // See `VisibilityRule`.
55
+ google.api.VisibilityRule api_visibility = 72295727;
56
+ }
57
+
58
+ // `Visibility` restricts service consumer's access to service elements,
59
+ // such as whether an application can call a visibility-restricted method.
60
+ // The restriction is expressed by applying visibility labels on service
61
+ // elements. The visibility labels are elsewhere linked to service consumers.
62
+ //
63
+ // A service can define multiple visibility labels, but a service consumer
64
+ // should be granted at most one visibility label. Multiple visibility
65
+ // labels for a single service consumer are not supported.
66
+ //
67
+ // If an element and all its parents have no visibility label, its visibility
68
+ // is unconditionally granted.
69
+ //
70
+ // Example:
71
+ //
72
+ // visibility:
73
+ // rules:
74
+ // - selector: google.calendar.Calendar.EnhancedSearch
75
+ // restriction: PREVIEW
76
+ // - selector: google.calendar.Calendar.Delegate
77
+ // restriction: INTERNAL
78
+ //
79
+ // Here, all methods are publicly visible except for the restricted methods
80
+ // EnhancedSearch and Delegate.
81
+ message Visibility {
82
+ // A list of visibility rules that apply to individual API elements.
83
+ //
84
+ // **NOTE:** All service configuration rules follow "last one wins" order.
85
+ repeated VisibilityRule rules = 1;
86
+ }
87
+
88
+ // A visibility rule provides visibility configuration for an individual API
89
+ // element.
90
+ message VisibilityRule {
91
+ // Selects methods, messages, fields, enums, etc. to which this rule applies.
92
+ //
93
+ // Refer to [selector][google.api.DocumentationRule.selector] for syntax
94
+ // details.
95
+ string selector = 1;
96
+
97
+ // A comma-separated list of visibility labels that apply to the `selector`.
98
+ // Any of the listed labels can be used to grant the visibility.
99
+ //
100
+ // If a rule has multiple labels, removing one of the labels but not all of
101
+ // them can break clients.
102
+ //
103
+ // Example:
104
+ //
105
+ // visibility:
106
+ // rules:
107
+ // - selector: google.calendar.Calendar.EnhancedSearch
108
+ // restriction: INTERNAL, PREVIEW
109
+ //
110
+ // Removing INTERNAL from this restriction will break clients that rely on
111
+ // this method and only had access to it through INTERNAL.
112
+ string restriction = 2;
113
+ }
@@ -0,0 +1,150 @@
1
+ // Copyright 2021 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
+
15
+ // This file contains custom annotations that are used by GAPIC generators to
16
+ // handle Long Running Operation methods (LRO) that are NOT compliant with
17
+ // https://google.aip.dev/151. These annotations are public for technical
18
+ // reasons only. Please DO NOT USE them in your protos.
19
+ syntax = "proto3";
20
+
21
+ package google.cloud;
22
+
23
+ import "google/protobuf/descriptor.proto";
24
+
25
+ option go_package = "google.golang.org/genproto/googleapis/cloud/extendedops;extendedops";
26
+ option java_multiple_files = true;
27
+ option java_outer_classname = "ExtendedOperationsProto";
28
+ option java_package = "com.google.cloud";
29
+ option objc_class_prefix = "GAPI";
30
+
31
+ // FieldOptions to match corresponding fields in the initial request,
32
+ // polling request and operation response messages.
33
+ //
34
+ // Example:
35
+ //
36
+ // In an API-specific operation message:
37
+ //
38
+ // message MyOperation {
39
+ // string http_error_message = 1 [(operation_field) = ERROR_MESSAGE];
40
+ // int32 http_error_status_code = 2 [(operation_field) = ERROR_CODE];
41
+ // string id = 3 [(operation_field) = NAME];
42
+ // Status status = 4 [(operation_field) = STATUS];
43
+ // }
44
+ //
45
+ // In a polling request message (the one which is used to poll for an LRO
46
+ // status):
47
+ //
48
+ // message MyPollingRequest {
49
+ // string operation = 1 [(operation_response_field) = "id"];
50
+ // string project = 2;
51
+ // string region = 3;
52
+ // }
53
+ //
54
+ // In an initial request message (the one which starts an LRO):
55
+ //
56
+ // message MyInitialRequest {
57
+ // string my_project = 2 [(operation_request_field) = "project"];
58
+ // string my_region = 3 [(operation_request_field) = "region"];
59
+ // }
60
+ //
61
+ extend google.protobuf.FieldOptions {
62
+ // A field annotation that maps fields in an API-specific Operation object to
63
+ // their standard counterparts in google.longrunning.Operation. See
64
+ // OperationResponseMapping enum definition.
65
+ OperationResponseMapping operation_field = 1149;
66
+
67
+ // A field annotation that maps fields in the initial request message
68
+ // (the one which started the LRO) to their counterparts in the polling
69
+ // request message. For non-standard LRO, the polling response may be missing
70
+ // some of the information needed to make a subsequent polling request. The
71
+ // missing information (for example, project or region ID) is contained in the
72
+ // fields of the initial request message that this annotation must be applied
73
+ // to. The string value of the annotation corresponds to the name of the
74
+ // counterpart field in the polling request message that the annotated field's
75
+ // value will be copied to.
76
+ string operation_request_field = 1150;
77
+
78
+ // A field annotation that maps fields in the polling request message to their
79
+ // counterparts in the initial and/or polling response message. The initial
80
+ // and the polling methods return an API-specific Operation object. Some of
81
+ // the fields from that response object must be reused in the subsequent
82
+ // request (like operation name/ID) to fully identify the polled operation.
83
+ // This annotation must be applied to the fields in the polling request
84
+ // message, the string value of the annotation must correspond to the name of
85
+ // the counterpart field in the Operation response object whose value will be
86
+ // copied to the annotated field.
87
+ string operation_response_field = 1151;
88
+ }
89
+
90
+ // MethodOptions to identify the actual service and method used for operation
91
+ // status polling.
92
+ //
93
+ // Example:
94
+ //
95
+ // In a method, which starts an LRO:
96
+ //
97
+ // service MyService {
98
+ // rpc Foo(MyInitialRequest) returns (MyOperation) {
99
+ // option (operation_service) = "MyPollingService";
100
+ // }
101
+ // }
102
+ //
103
+ // In a polling method:
104
+ //
105
+ // service MyPollingService {
106
+ // rpc Get(MyPollingRequest) returns (MyOperation) {
107
+ // option (operation_polling_method) = true;
108
+ // }
109
+ // }
110
+ extend google.protobuf.MethodOptions {
111
+ // A method annotation that maps an LRO method (the one which starts an LRO)
112
+ // to the service, which will be used to poll for the operation status. The
113
+ // annotation must be applied to the method which starts an LRO, the string
114
+ // value of the annotation must correspond to the name of the service used to
115
+ // poll for the operation status.
116
+ string operation_service = 1249;
117
+
118
+ // A method annotation that marks methods that can be used for polling
119
+ // operation status (e.g. the MyPollingService.Get(MyPollingRequest) method).
120
+ bool operation_polling_method = 1250;
121
+ }
122
+
123
+ // An enum to be used to mark the essential (for polling) fields in an
124
+ // API-specific Operation object. A custom Operation object may contain many
125
+ // different fields, but only few of them are essential to conduct a successful
126
+ // polling process.
127
+ enum OperationResponseMapping {
128
+ // Do not use.
129
+ UNDEFINED = 0;
130
+
131
+ // A field in an API-specific (custom) Operation object which carries the same
132
+ // meaning as google.longrunning.Operation.name.
133
+ NAME = 1;
134
+
135
+ // A field in an API-specific (custom) Operation object which carries the same
136
+ // meaning as google.longrunning.Operation.done. If the annotated field is of
137
+ // an enum type, `annotated_field_name == EnumType.DONE` semantics should be
138
+ // equivalent to `Operation.done == true`. If the annotated field is of type
139
+ // boolean, then it should follow the same semantics as Operation.done.
140
+ // Otherwise, a non-empty value should be treated as `Operation.done == true`.
141
+ STATUS = 2;
142
+
143
+ // A field in an API-specific (custom) Operation object which carries the same
144
+ // meaning as google.longrunning.Operation.error.code.
145
+ ERROR_CODE = 3;
146
+
147
+ // A field in an API-specific (custom) Operation object which carries the same
148
+ // meaning as google.longrunning.Operation.error.message.
149
+ ERROR_MESSAGE = 4;
150
+ }