@hyperlane-xyz/cli 16.2.0 → 18.0.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 (190) hide show
  1. package/cli-bundle/index.js +39174 -1835
  2. package/examples/submit/transactions/{alfajores-transactions.json → sepolia-transactions.json} +1 -1
  3. package/package.json +5 -5
  4. package/cli-bundle/798.index.js +0 -169715
  5. package/cli-bundle/proto/channelz.proto +0 -564
  6. package/cli-bundle/protos/compute_operations.d.ts +0 -7304
  7. package/cli-bundle/protos/compute_operations.js +0 -1
  8. package/cli-bundle/protos/compute_operations.json +0 -1
  9. package/cli-bundle/protos/google/api/annotations.proto +0 -31
  10. package/cli-bundle/protos/google/api/apikeys/v2/apikeys.proto +0 -288
  11. package/cli-bundle/protos/google/api/apikeys/v2/resources.proto +0 -175
  12. package/cli-bundle/protos/google/api/auth.proto +0 -237
  13. package/cli-bundle/protos/google/api/backend.proto +0 -185
  14. package/cli-bundle/protos/google/api/billing.proto +0 -77
  15. package/cli-bundle/protos/google/api/client.proto +0 -427
  16. package/cli-bundle/protos/google/api/cloudquotas/v1/cloudquotas.proto +0 -322
  17. package/cli-bundle/protos/google/api/cloudquotas/v1/resources.proto +0 -311
  18. package/cli-bundle/protos/google/api/config_change.proto +0 -84
  19. package/cli-bundle/protos/google/api/consumer.proto +0 -82
  20. package/cli-bundle/protos/google/api/context.proto +0 -90
  21. package/cli-bundle/protos/google/api/control.proto +0 -41
  22. package/cli-bundle/protos/google/api/distribution.proto +0 -213
  23. package/cli-bundle/protos/google/api/documentation.proto +0 -168
  24. package/cli-bundle/protos/google/api/endpoint.proto +0 -73
  25. package/cli-bundle/protos/google/api/error_reason.proto +0 -589
  26. package/cli-bundle/protos/google/api/expr/conformance/v1alpha1/conformance_service.proto +0 -183
  27. package/cli-bundle/protos/google/api/expr/v1alpha1/checked.proto +0 -343
  28. package/cli-bundle/protos/google/api/expr/v1alpha1/eval.proto +0 -118
  29. package/cli-bundle/protos/google/api/expr/v1alpha1/explain.proto +0 -53
  30. package/cli-bundle/protos/google/api/expr/v1alpha1/syntax.proto +0 -400
  31. package/cli-bundle/protos/google/api/expr/v1alpha1/value.proto +0 -115
  32. package/cli-bundle/protos/google/api/expr/v1beta1/decl.proto +0 -84
  33. package/cli-bundle/protos/google/api/expr/v1beta1/eval.proto +0 -125
  34. package/cli-bundle/protos/google/api/expr/v1beta1/expr.proto +0 -265
  35. package/cli-bundle/protos/google/api/expr/v1beta1/source.proto +0 -62
  36. package/cli-bundle/protos/google/api/expr/v1beta1/value.proto +0 -114
  37. package/cli-bundle/protos/google/api/field_behavior.proto +0 -104
  38. package/cli-bundle/protos/google/api/field_info.proto +0 -79
  39. package/cli-bundle/protos/google/api/http.proto +0 -379
  40. package/cli-bundle/protos/google/api/httpbody.proto +0 -81
  41. package/cli-bundle/protos/google/api/label.proto +0 -48
  42. package/cli-bundle/protos/google/api/launch_stage.proto +0 -72
  43. package/cli-bundle/protos/google/api/log.proto +0 -54
  44. package/cli-bundle/protos/google/api/logging.proto +0 -81
  45. package/cli-bundle/protos/google/api/metric.proto +0 -268
  46. package/cli-bundle/protos/google/api/monitored_resource.proto +0 -130
  47. package/cli-bundle/protos/google/api/monitoring.proto +0 -107
  48. package/cli-bundle/protos/google/api/policy.proto +0 -85
  49. package/cli-bundle/protos/google/api/quota.proto +0 -184
  50. package/cli-bundle/protos/google/api/resource.proto +0 -238
  51. package/cli-bundle/protos/google/api/routing.proto +0 -461
  52. package/cli-bundle/protos/google/api/service.proto +0 -191
  53. package/cli-bundle/protos/google/api/servicecontrol/v1/check_error.proto +0 -124
  54. package/cli-bundle/protos/google/api/servicecontrol/v1/distribution.proto +0 -166
  55. package/cli-bundle/protos/google/api/servicecontrol/v1/http_request.proto +0 -93
  56. package/cli-bundle/protos/google/api/servicecontrol/v1/log_entry.proto +0 -126
  57. package/cli-bundle/protos/google/api/servicecontrol/v1/metric_value.proto +0 -81
  58. package/cli-bundle/protos/google/api/servicecontrol/v1/operation.proto +0 -123
  59. package/cli-bundle/protos/google/api/servicecontrol/v1/quota_controller.proto +0 -245
  60. package/cli-bundle/protos/google/api/servicecontrol/v1/service_controller.proto +0 -260
  61. package/cli-bundle/protos/google/api/servicecontrol/v2/service_controller.proto +0 -196
  62. package/cli-bundle/protos/google/api/servicemanagement/v1/resources.proto +0 -295
  63. package/cli-bundle/protos/google/api/servicemanagement/v1/servicemanager.proto +0 -508
  64. package/cli-bundle/protos/google/api/serviceusage/v1/resources.proto +0 -130
  65. package/cli-bundle/protos/google/api/serviceusage/v1/serviceusage.proto +0 -305
  66. package/cli-bundle/protos/google/api/serviceusage/v1beta1/resources.proto +0 -458
  67. package/cli-bundle/protos/google/api/serviceusage/v1beta1/serviceusage.proto +0 -793
  68. package/cli-bundle/protos/google/api/source_info.proto +0 -31
  69. package/cli-bundle/protos/google/api/system_parameter.proto +0 -96
  70. package/cli-bundle/protos/google/api/usage.proto +0 -96
  71. package/cli-bundle/protos/google/api/visibility.proto +0 -113
  72. package/cli-bundle/protos/google/cloud/location/locations.proto +0 -108
  73. package/cli-bundle/protos/google/iam/v1/iam_policy.proto +0 -155
  74. package/cli-bundle/protos/google/iam/v1/logging/audit_data.proto +0 -33
  75. package/cli-bundle/protos/google/iam/v1/options.proto +0 -48
  76. package/cli-bundle/protos/google/iam/v1/policy.proto +0 -410
  77. package/cli-bundle/protos/google/logging/type/http_request.proto +0 -95
  78. package/cli-bundle/protos/google/logging/type/log_severity.proto +0 -71
  79. package/cli-bundle/protos/google/longrunning/operations.proto +0 -247
  80. package/cli-bundle/protos/google/monitoring/v3/alert.proto +0 -669
  81. package/cli-bundle/protos/google/monitoring/v3/alert_service.proto +0 -256
  82. package/cli-bundle/protos/google/monitoring/v3/common.proto +0 -488
  83. package/cli-bundle/protos/google/monitoring/v3/dropped_labels.proto +0 -46
  84. package/cli-bundle/protos/google/monitoring/v3/group.proto +0 -90
  85. package/cli-bundle/protos/google/monitoring/v3/group_service.proto +0 -290
  86. package/cli-bundle/protos/google/monitoring/v3/metric.proto +0 -239
  87. package/cli-bundle/protos/google/monitoring/v3/metric_service.proto +0 -522
  88. package/cli-bundle/protos/google/monitoring/v3/mutation_record.proto +0 -36
  89. package/cli-bundle/protos/google/monitoring/v3/notification.proto +0 -195
  90. package/cli-bundle/protos/google/monitoring/v3/notification_service.proto +0 -448
  91. package/cli-bundle/protos/google/monitoring/v3/query_service.proto +0 -48
  92. package/cli-bundle/protos/google/monitoring/v3/service.proto +0 -457
  93. package/cli-bundle/protos/google/monitoring/v3/service_service.proto +0 -352
  94. package/cli-bundle/protos/google/monitoring/v3/snooze.proto +0 -78
  95. package/cli-bundle/protos/google/monitoring/v3/snooze_service.proto +0 -210
  96. package/cli-bundle/protos/google/monitoring/v3/span_context.proto +0 -45
  97. package/cli-bundle/protos/google/monitoring/v3/uptime.proto +0 -564
  98. package/cli-bundle/protos/google/monitoring/v3/uptime_service.proto +0 -259
  99. package/cli-bundle/protos/google/protobuf/any.proto +0 -162
  100. package/cli-bundle/protos/google/protobuf/api.proto +0 -207
  101. package/cli-bundle/protos/google/protobuf/bridge/message_set.proto +0 -76
  102. package/cli-bundle/protos/google/protobuf/compiler/plugin.proto +0 -180
  103. package/cli-bundle/protos/google/protobuf/compiler/ruby/ruby_generated_code.proto +0 -77
  104. package/cli-bundle/protos/google/protobuf/compiler/ruby/ruby_generated_code_proto2.proto +0 -78
  105. package/cli-bundle/protos/google/protobuf/compiler/ruby/ruby_generated_code_proto2_import.proto +0 -12
  106. package/cli-bundle/protos/google/protobuf/compiler/ruby/ruby_generated_pkg_explicit.proto +0 -16
  107. package/cli-bundle/protos/google/protobuf/compiler/ruby/ruby_generated_pkg_explicit_legacy.proto +0 -16
  108. package/cli-bundle/protos/google/protobuf/compiler/ruby/ruby_generated_pkg_implicit.proto +0 -14
  109. package/cli-bundle/protos/google/protobuf/cpp_features.proto +0 -45
  110. package/cli-bundle/protos/google/protobuf/descriptor.proto +0 -1225
  111. package/cli-bundle/protos/google/protobuf/duration.proto +0 -115
  112. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_enum.proto +0 -26
  113. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_group.proto +0 -18
  114. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_import.proto +0 -16
  115. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_inline_comments.proto +0 -33
  116. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_multiline_comments.proto +0 -33
  117. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_optional.proto +0 -65
  118. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_packed.proto +0 -14
  119. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_proto3_enum.proto +0 -18
  120. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_required.proto +0 -47
  121. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_unpacked.proto +0 -19
  122. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_utf8_disabled.proto +0 -16
  123. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_utf8_lite.proto +0 -17
  124. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_utf8_verify.proto +0 -14
  125. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_enum.proto +0 -26
  126. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_implicit.proto +0 -65
  127. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_import.proto +0 -16
  128. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_optional.proto +0 -47
  129. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_packed.proto +0 -20
  130. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_unpacked.proto +0 -19
  131. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_utf8_strict.proto +0 -15
  132. package/cli-bundle/protos/google/protobuf/editions/golden/editions_transform_proto2.proto +0 -129
  133. package/cli-bundle/protos/google/protobuf/editions/golden/editions_transform_proto2_lite.proto +0 -19
  134. package/cli-bundle/protos/google/protobuf/editions/golden/editions_transform_proto2_utf8_disabled.proto +0 -18
  135. package/cli-bundle/protos/google/protobuf/editions/golden/editions_transform_proto3.proto +0 -32
  136. package/cli-bundle/protos/google/protobuf/editions/golden/editions_transform_proto3_utf8_disabled.proto +0 -18
  137. package/cli-bundle/protos/google/protobuf/editions/golden/simple_proto2.proto +0 -14
  138. package/cli-bundle/protos/google/protobuf/editions/golden/simple_proto2_import.proto +0 -16
  139. package/cli-bundle/protos/google/protobuf/editions/golden/simple_proto3.proto +0 -14
  140. package/cli-bundle/protos/google/protobuf/editions/proto/editions_transform_proto2.proto +0 -91
  141. package/cli-bundle/protos/google/protobuf/editions/proto/editions_transform_proto2_lite.proto +0 -20
  142. package/cli-bundle/protos/google/protobuf/editions/proto/editions_transform_proto2_utf8_disabled.proto +0 -19
  143. package/cli-bundle/protos/google/protobuf/editions/proto/editions_transform_proto3.proto +0 -25
  144. package/cli-bundle/protos/google/protobuf/editions/proto/editions_transform_proto3_utf8_disabled.proto +0 -19
  145. package/cli-bundle/protos/google/protobuf/empty.proto +0 -51
  146. package/cli-bundle/protos/google/protobuf/field_mask.proto +0 -245
  147. package/cli-bundle/protos/google/protobuf/sample_messages_edition.proto +0 -427
  148. package/cli-bundle/protos/google/protobuf/source_context.proto +0 -48
  149. package/cli-bundle/protos/google/protobuf/struct.proto +0 -95
  150. package/cli-bundle/protos/google/protobuf/timestamp.proto +0 -144
  151. package/cli-bundle/protos/google/protobuf/type.proto +0 -193
  152. package/cli-bundle/protos/google/protobuf/util/json_format.proto +0 -116
  153. package/cli-bundle/protos/google/protobuf/util/json_format_proto3.proto +0 -301
  154. package/cli-bundle/protos/google/protobuf/wrappers.proto +0 -123
  155. package/cli-bundle/protos/google/rpc/code.proto +0 -186
  156. package/cli-bundle/protos/google/rpc/context/attribute_context.proto +0 -344
  157. package/cli-bundle/protos/google/rpc/context/audit_context.proto +0 -49
  158. package/cli-bundle/protos/google/rpc/error_details.proto +0 -285
  159. package/cli-bundle/protos/google/rpc/http.proto +0 -64
  160. package/cli-bundle/protos/google/rpc/status.proto +0 -49
  161. package/cli-bundle/protos/google/type/calendar_period.proto +0 -56
  162. package/cli-bundle/protos/google/type/color.proto +0 -174
  163. package/cli-bundle/protos/google/type/date.proto +0 -52
  164. package/cli-bundle/protos/google/type/datetime.proto +0 -104
  165. package/cli-bundle/protos/google/type/dayofweek.proto +0 -50
  166. package/cli-bundle/protos/google/type/decimal.proto +0 -95
  167. package/cli-bundle/protos/google/type/expr.proto +0 -73
  168. package/cli-bundle/protos/google/type/fraction.proto +0 -33
  169. package/cli-bundle/protos/google/type/interval.proto +0 -46
  170. package/cli-bundle/protos/google/type/latlng.proto +0 -37
  171. package/cli-bundle/protos/google/type/localized_text.proto +0 -36
  172. package/cli-bundle/protos/google/type/money.proto +0 -42
  173. package/cli-bundle/protos/google/type/month.proto +0 -65
  174. package/cli-bundle/protos/google/type/phone_number.proto +0 -113
  175. package/cli-bundle/protos/google/type/postal_address.proto +0 -134
  176. package/cli-bundle/protos/google/type/quaternion.proto +0 -94
  177. package/cli-bundle/protos/google/type/timeofday.proto +0 -44
  178. package/cli-bundle/protos/http.d.ts +0 -347
  179. package/cli-bundle/protos/http.js +0 -1
  180. package/cli-bundle/protos/iam_service.d.ts +0 -5035
  181. package/cli-bundle/protos/iam_service.js +0 -1
  182. package/cli-bundle/protos/iam_service.json +0 -1
  183. package/cli-bundle/protos/locations.d.ts +0 -4060
  184. package/cli-bundle/protos/locations.js +0 -1
  185. package/cli-bundle/protos/locations.json +0 -1
  186. package/cli-bundle/protos/operations.d.ts +0 -4783
  187. package/cli-bundle/protos/operations.js +0 -1
  188. package/cli-bundle/protos/operations.json +0 -1
  189. package/cli-bundle/protos/status.json +0 -1
  190. package/cli-bundle/worker2.js +0 -174
@@ -1,1225 +0,0 @@
1
- // Protocol Buffers - Google's data interchange format
2
- // Copyright 2008 Google Inc. All rights reserved.
3
- // https://developers.google.com/protocol-buffers/
4
- //
5
- // Redistribution and use in source and binary forms, with or without
6
- // modification, are permitted provided that the following conditions are
7
- // met:
8
- //
9
- // * Redistributions of source code must retain the above copyright
10
- // notice, this list of conditions and the following disclaimer.
11
- // * Redistributions in binary form must reproduce the above
12
- // copyright notice, this list of conditions and the following disclaimer
13
- // in the documentation and/or other materials provided with the
14
- // distribution.
15
- // * Neither the name of Google Inc. nor the names of its
16
- // contributors may be used to endorse or promote products derived from
17
- // this software without specific prior written permission.
18
- //
19
- // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20
- // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21
- // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22
- // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23
- // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24
- // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25
- // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26
- // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27
- // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28
- // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
- // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
-
31
- // Author: kenton@google.com (Kenton Varda)
32
- // Based on original Protocol Buffers design by
33
- // Sanjay Ghemawat, Jeff Dean, and others.
34
- //
35
- // The messages in this file describe the definitions found in .proto files.
36
- // A valid .proto file can be translated directly to a FileDescriptorProto
37
- // without any other information (e.g. without reading its imports).
38
-
39
- syntax = "proto2";
40
-
41
- package google.protobuf;
42
-
43
- option go_package = "google.golang.org/protobuf/types/descriptorpb";
44
- option java_package = "com.google.protobuf";
45
- option java_outer_classname = "DescriptorProtos";
46
- option csharp_namespace = "Google.Protobuf.Reflection";
47
- option objc_class_prefix = "GPB";
48
- option cc_enable_arenas = true;
49
-
50
- // descriptor.proto must be optimized for speed because reflection-based
51
- // algorithms don't work during bootstrapping.
52
- option optimize_for = SPEED;
53
-
54
- // The protocol compiler can output a FileDescriptorSet containing the .proto
55
- // files it parses.
56
- message FileDescriptorSet {
57
- repeated FileDescriptorProto file = 1;
58
- }
59
-
60
- // The full set of known editions.
61
- enum Edition {
62
- // A placeholder for an unknown edition value.
63
- EDITION_UNKNOWN = 0;
64
-
65
- // Legacy syntax "editions". These pre-date editions, but behave much like
66
- // distinct editions. These can't be used to specify the edition of proto
67
- // files, but feature definitions must supply proto2/proto3 defaults for
68
- // backwards compatibility.
69
- EDITION_PROTO2 = 998;
70
- EDITION_PROTO3 = 999;
71
-
72
- // Editions that have been released. The specific values are arbitrary and
73
- // should not be depended on, but they will always be time-ordered for easy
74
- // comparison.
75
- EDITION_2023 = 1000;
76
- EDITION_2024 = 1001;
77
-
78
- // Placeholder editions for testing feature resolution. These should not be
79
- // used or relyed on outside of tests.
80
- EDITION_1_TEST_ONLY = 1;
81
- EDITION_2_TEST_ONLY = 2;
82
- EDITION_99997_TEST_ONLY = 99997;
83
- EDITION_99998_TEST_ONLY = 99998;
84
- EDITION_99999_TEST_ONLY = 99999;
85
-
86
- // Placeholder for specifying unbounded edition support. This should only
87
- // ever be used by plugins that can expect to never require any changes to
88
- // support a new edition.
89
- EDITION_MAX = 0x7FFFFFFF;
90
- }
91
-
92
- // Describes a complete .proto file.
93
- message FileDescriptorProto {
94
- optional string name = 1; // file name, relative to root of source tree
95
- optional string package = 2; // e.g. "foo", "foo.bar", etc.
96
-
97
- // Names of files imported by this file.
98
- repeated string dependency = 3;
99
- // Indexes of the public imported files in the dependency list above.
100
- repeated int32 public_dependency = 10;
101
- // Indexes of the weak imported files in the dependency list.
102
- // For Google-internal migration only. Do not use.
103
- repeated int32 weak_dependency = 11;
104
-
105
- // All top-level definitions in this file.
106
- repeated DescriptorProto message_type = 4;
107
- repeated EnumDescriptorProto enum_type = 5;
108
- repeated ServiceDescriptorProto service = 6;
109
- repeated FieldDescriptorProto extension = 7;
110
-
111
- optional FileOptions options = 8;
112
-
113
- // This field contains optional information about the original source code.
114
- // You may safely remove this entire field without harming runtime
115
- // functionality of the descriptors -- the information is needed only by
116
- // development tools.
117
- optional SourceCodeInfo source_code_info = 9;
118
-
119
- // The syntax of the proto file.
120
- // The supported values are "proto2", "proto3", and "editions".
121
- //
122
- // If `edition` is present, this value must be "editions".
123
- optional string syntax = 12;
124
-
125
- // The edition of the proto file.
126
- optional Edition edition = 14;
127
- }
128
-
129
- // Describes a message type.
130
- message DescriptorProto {
131
- optional string name = 1;
132
-
133
- repeated FieldDescriptorProto field = 2;
134
- repeated FieldDescriptorProto extension = 6;
135
-
136
- repeated DescriptorProto nested_type = 3;
137
- repeated EnumDescriptorProto enum_type = 4;
138
-
139
- message ExtensionRange {
140
- optional int32 start = 1; // Inclusive.
141
- optional int32 end = 2; // Exclusive.
142
-
143
- optional ExtensionRangeOptions options = 3;
144
- }
145
- repeated ExtensionRange extension_range = 5;
146
-
147
- repeated OneofDescriptorProto oneof_decl = 8;
148
-
149
- optional MessageOptions options = 7;
150
-
151
- // Range of reserved tag numbers. Reserved tag numbers may not be used by
152
- // fields or extension ranges in the same message. Reserved ranges may
153
- // not overlap.
154
- message ReservedRange {
155
- optional int32 start = 1; // Inclusive.
156
- optional int32 end = 2; // Exclusive.
157
- }
158
- repeated ReservedRange reserved_range = 9;
159
- // Reserved field names, which may not be used by fields in the same message.
160
- // A given name may only be reserved once.
161
- repeated string reserved_name = 10;
162
- }
163
-
164
- message ExtensionRangeOptions {
165
- // The parser stores options it doesn't recognize here. See above.
166
- repeated UninterpretedOption uninterpreted_option = 999;
167
-
168
- message Declaration {
169
- // The extension number declared within the extension range.
170
- optional int32 number = 1;
171
-
172
- // The fully-qualified name of the extension field. There must be a leading
173
- // dot in front of the full name.
174
- optional string full_name = 2;
175
-
176
- // The fully-qualified type name of the extension field. Unlike
177
- // Metadata.type, Declaration.type must have a leading dot for messages
178
- // and enums.
179
- optional string type = 3;
180
-
181
- // If true, indicates that the number is reserved in the extension range,
182
- // and any extension field with the number will fail to compile. Set this
183
- // when a declared extension field is deleted.
184
- optional bool reserved = 5;
185
-
186
- // If true, indicates that the extension must be defined as repeated.
187
- // Otherwise the extension must be defined as optional.
188
- optional bool repeated = 6;
189
-
190
- reserved 4; // removed is_repeated
191
- }
192
-
193
- // For external users: DO NOT USE. We are in the process of open sourcing
194
- // extension declaration and executing internal cleanups before it can be
195
- // used externally.
196
- repeated Declaration declaration = 2 [retention = RETENTION_SOURCE];
197
-
198
- // Any features defined in the specific edition.
199
- optional FeatureSet features = 50;
200
-
201
- // The verification state of the extension range.
202
- enum VerificationState {
203
- // All the extensions of the range must be declared.
204
- DECLARATION = 0;
205
- UNVERIFIED = 1;
206
- }
207
-
208
- // The verification state of the range.
209
- // TODO: flip the default to DECLARATION once all empty ranges
210
- // are marked as UNVERIFIED.
211
- optional VerificationState verification = 3
212
- [default = UNVERIFIED, retention = RETENTION_SOURCE];
213
-
214
- // Clients can define custom options in extensions of this message. See above.
215
- extensions 1000 to max;
216
- }
217
-
218
- // Describes a field within a message.
219
- message FieldDescriptorProto {
220
- enum Type {
221
- // 0 is reserved for errors.
222
- // Order is weird for historical reasons.
223
- TYPE_DOUBLE = 1;
224
- TYPE_FLOAT = 2;
225
- // Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if
226
- // negative values are likely.
227
- TYPE_INT64 = 3;
228
- TYPE_UINT64 = 4;
229
- // Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if
230
- // negative values are likely.
231
- TYPE_INT32 = 5;
232
- TYPE_FIXED64 = 6;
233
- TYPE_FIXED32 = 7;
234
- TYPE_BOOL = 8;
235
- TYPE_STRING = 9;
236
- // Tag-delimited aggregate.
237
- // Group type is deprecated and not supported after google.protobuf. However, Proto3
238
- // implementations should still be able to parse the group wire format and
239
- // treat group fields as unknown fields. In Editions, the group wire format
240
- // can be enabled via the `message_encoding` feature.
241
- TYPE_GROUP = 10;
242
- TYPE_MESSAGE = 11; // Length-delimited aggregate.
243
-
244
- // New in version 2.
245
- TYPE_BYTES = 12;
246
- TYPE_UINT32 = 13;
247
- TYPE_ENUM = 14;
248
- TYPE_SFIXED32 = 15;
249
- TYPE_SFIXED64 = 16;
250
- TYPE_SINT32 = 17; // Uses ZigZag encoding.
251
- TYPE_SINT64 = 18; // Uses ZigZag encoding.
252
- }
253
-
254
- enum Label {
255
- // 0 is reserved for errors
256
- LABEL_OPTIONAL = 1;
257
- LABEL_REPEATED = 3;
258
- // The required label is only allowed in google.protobuf. In proto3 and Editions
259
- // it's explicitly prohibited. In Editions, the `field_presence` feature
260
- // can be used to get this behavior.
261
- LABEL_REQUIRED = 2;
262
- }
263
-
264
- optional string name = 1;
265
- optional int32 number = 3;
266
- optional Label label = 4;
267
-
268
- // If type_name is set, this need not be set. If both this and type_name
269
- // are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
270
- optional Type type = 5;
271
-
272
- // For message and enum types, this is the name of the type. If the name
273
- // starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
274
- // rules are used to find the type (i.e. first the nested types within this
275
- // message are searched, then within the parent, on up to the root
276
- // namespace).
277
- optional string type_name = 6;
278
-
279
- // For extensions, this is the name of the type being extended. It is
280
- // resolved in the same manner as type_name.
281
- optional string extendee = 2;
282
-
283
- // For numeric types, contains the original text representation of the value.
284
- // For booleans, "true" or "false".
285
- // For strings, contains the default text contents (not escaped in any way).
286
- // For bytes, contains the C escaped value. All bytes >= 128 are escaped.
287
- optional string default_value = 7;
288
-
289
- // If set, gives the index of a oneof in the containing type's oneof_decl
290
- // list. This field is a member of that oneof.
291
- optional int32 oneof_index = 9;
292
-
293
- // JSON name of this field. The value is set by protocol compiler. If the
294
- // user has set a "json_name" option on this field, that option's value
295
- // will be used. Otherwise, it's deduced from the field's name by converting
296
- // it to camelCase.
297
- optional string json_name = 10;
298
-
299
- optional FieldOptions options = 8;
300
-
301
- // If true, this is a proto3 "optional". When a proto3 field is optional, it
302
- // tracks presence regardless of field type.
303
- //
304
- // When proto3_optional is true, this field must belong to a oneof to signal
305
- // to old proto3 clients that presence is tracked for this field. This oneof
306
- // is known as a "synthetic" oneof, and this field must be its sole member
307
- // (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs
308
- // exist in the descriptor only, and do not generate any API. Synthetic oneofs
309
- // must be ordered after all "real" oneofs.
310
- //
311
- // For message fields, proto3_optional doesn't create any semantic change,
312
- // since non-repeated message fields always track presence. However it still
313
- // indicates the semantic detail of whether the user wrote "optional" or not.
314
- // This can be useful for round-tripping the .proto file. For consistency we
315
- // give message fields a synthetic oneof also, even though it is not required
316
- // to track presence. This is especially important because the parser can't
317
- // tell if a field is a message or an enum, so it must always create a
318
- // synthetic oneof.
319
- //
320
- // Proto2 optional fields do not set this flag, because they already indicate
321
- // optional with `LABEL_OPTIONAL`.
322
- optional bool proto3_optional = 17;
323
- }
324
-
325
- // Describes a oneof.
326
- message OneofDescriptorProto {
327
- optional string name = 1;
328
- optional OneofOptions options = 2;
329
- }
330
-
331
- // Describes an enum type.
332
- message EnumDescriptorProto {
333
- optional string name = 1;
334
-
335
- repeated EnumValueDescriptorProto value = 2;
336
-
337
- optional EnumOptions options = 3;
338
-
339
- // Range of reserved numeric values. Reserved values may not be used by
340
- // entries in the same enum. Reserved ranges may not overlap.
341
- //
342
- // Note that this is distinct from DescriptorProto.ReservedRange in that it
343
- // is inclusive such that it can appropriately represent the entire int32
344
- // domain.
345
- message EnumReservedRange {
346
- optional int32 start = 1; // Inclusive.
347
- optional int32 end = 2; // Inclusive.
348
- }
349
-
350
- // Range of reserved numeric values. Reserved numeric values may not be used
351
- // by enum values in the same enum declaration. Reserved ranges may not
352
- // overlap.
353
- repeated EnumReservedRange reserved_range = 4;
354
-
355
- // Reserved enum value names, which may not be reused. A given name may only
356
- // be reserved once.
357
- repeated string reserved_name = 5;
358
- }
359
-
360
- // Describes a value within an enum.
361
- message EnumValueDescriptorProto {
362
- optional string name = 1;
363
- optional int32 number = 2;
364
-
365
- optional EnumValueOptions options = 3;
366
- }
367
-
368
- // Describes a service.
369
- message ServiceDescriptorProto {
370
- optional string name = 1;
371
- repeated MethodDescriptorProto method = 2;
372
-
373
- optional ServiceOptions options = 3;
374
- }
375
-
376
- // Describes a method of a service.
377
- message MethodDescriptorProto {
378
- optional string name = 1;
379
-
380
- // Input and output type names. These are resolved in the same way as
381
- // FieldDescriptorProto.type_name, but must refer to a message type.
382
- optional string input_type = 2;
383
- optional string output_type = 3;
384
-
385
- optional MethodOptions options = 4;
386
-
387
- // Identifies if client streams multiple client messages
388
- optional bool client_streaming = 5 [default = false];
389
- // Identifies if server streams multiple server messages
390
- optional bool server_streaming = 6 [default = false];
391
- }
392
-
393
- // ===================================================================
394
- // Options
395
-
396
- // Each of the definitions above may have "options" attached. These are
397
- // just annotations which may cause code to be generated slightly differently
398
- // or may contain hints for code that manipulates protocol messages.
399
- //
400
- // Clients may define custom options as extensions of the *Options messages.
401
- // These extensions may not yet be known at parsing time, so the parser cannot
402
- // store the values in them. Instead it stores them in a field in the *Options
403
- // message called uninterpreted_option. This field must have the same name
404
- // across all *Options messages. We then use this field to populate the
405
- // extensions when we build a descriptor, at which point all protos have been
406
- // parsed and so all extensions are known.
407
- //
408
- // Extension numbers for custom options may be chosen as follows:
409
- // * For options which will only be used within a single application or
410
- // organization, or for experimental options, use field numbers 50000
411
- // through 99999. It is up to you to ensure that you do not use the
412
- // same number for multiple options.
413
- // * For options which will be published and used publicly by multiple
414
- // independent entities, e-mail protobuf-global-extension-registry@google.com
415
- // to reserve extension numbers. Simply provide your project name (e.g.
416
- // Objective-C plugin) and your project website (if available) -- there's no
417
- // need to explain how you intend to use them. Usually you only need one
418
- // extension number. You can declare multiple options with only one extension
419
- // number by putting them in a sub-message. See the Custom Options section of
420
- // the docs for examples:
421
- // https://developers.google.com/protocol-buffers/docs/proto#options
422
- // If this turns out to be popular, a web service will be set up
423
- // to automatically assign option numbers.
424
-
425
- message FileOptions {
426
-
427
- // Sets the Java package where classes generated from this .proto will be
428
- // placed. By default, the proto package is used, but this is often
429
- // inappropriate because proto packages do not normally start with backwards
430
- // domain names.
431
- optional string java_package = 1;
432
-
433
- // Controls the name of the wrapper Java class generated for the .proto file.
434
- // That class will always contain the .proto file's getDescriptor() method as
435
- // well as any top-level extensions defined in the .proto file.
436
- // If java_multiple_files is disabled, then all the other classes from the
437
- // .proto file will be nested inside the single wrapper outer class.
438
- optional string java_outer_classname = 8;
439
-
440
- // If enabled, then the Java code generator will generate a separate .java
441
- // file for each top-level message, enum, and service defined in the .proto
442
- // file. Thus, these types will *not* be nested inside the wrapper class
443
- // named by java_outer_classname. However, the wrapper class will still be
444
- // generated to contain the file's getDescriptor() method as well as any
445
- // top-level extensions defined in the file.
446
- optional bool java_multiple_files = 10 [default = false];
447
-
448
- // This option does nothing.
449
- optional bool java_generate_equals_and_hash = 20 [deprecated=true];
450
-
451
- // A proto2 file can set this to true to opt in to UTF-8 checking for Java,
452
- // which will throw an exception if invalid UTF-8 is parsed from the wire or
453
- // assigned to a string field.
454
- //
455
- // TODO: clarify exactly what kinds of field types this option
456
- // applies to, and update these docs accordingly.
457
- //
458
- // Proto3 files already perform these checks. Setting the option explicitly to
459
- // false has no effect: it cannot be used to opt proto3 files out of UTF-8
460
- // checks.
461
- optional bool java_string_check_utf8 = 27 [default = false];
462
-
463
- // Generated classes can be optimized for speed or code size.
464
- enum OptimizeMode {
465
- SPEED = 1; // Generate complete code for parsing, serialization,
466
- // etc.
467
- CODE_SIZE = 2; // Use ReflectionOps to implement these methods.
468
- LITE_RUNTIME = 3; // Generate code using MessageLite and the lite runtime.
469
- }
470
- optional OptimizeMode optimize_for = 9 [default = SPEED];
471
-
472
- // Sets the Go package where structs generated from this .proto will be
473
- // placed. If omitted, the Go package will be derived from the following:
474
- // - The basename of the package import path, if provided.
475
- // - Otherwise, the package statement in the .proto file, if present.
476
- // - Otherwise, the basename of the .proto file, without extension.
477
- optional string go_package = 11;
478
-
479
- // Should generic services be generated in each language? "Generic" services
480
- // are not specific to any particular RPC system. They are generated by the
481
- // main code generators in each language (without additional plugins).
482
- // Generic services were the only kind of service generation supported by
483
- // early versions of google.protobuf.
484
- //
485
- // Generic services are now considered deprecated in favor of using plugins
486
- // that generate code specific to your particular RPC system. Therefore,
487
- // these default to false. Old code which depends on generic services should
488
- // explicitly set them to true.
489
- optional bool cc_generic_services = 16 [default = false];
490
- optional bool java_generic_services = 17 [default = false];
491
- optional bool py_generic_services = 18 [default = false];
492
- reserved 42; // removed php_generic_services
493
-
494
- // Is this file deprecated?
495
- // Depending on the target platform, this can emit Deprecated annotations
496
- // for everything in the file, or it will be completely ignored; in the very
497
- // least, this is a formalization for deprecating files.
498
- optional bool deprecated = 23 [default = false];
499
-
500
- // Enables the use of arenas for the proto messages in this file. This applies
501
- // only to generated classes for C++.
502
- optional bool cc_enable_arenas = 31 [default = true];
503
-
504
- // Sets the objective c class prefix which is prepended to all objective c
505
- // generated classes from this .proto. There is no default.
506
- optional string objc_class_prefix = 36;
507
-
508
- // Namespace for generated classes; defaults to the package.
509
- optional string csharp_namespace = 37;
510
-
511
- // By default Swift generators will take the proto package and CamelCase it
512
- // replacing '.' with underscore and use that to prefix the types/symbols
513
- // defined. When this options is provided, they will use this value instead
514
- // to prefix the types/symbols defined.
515
- optional string swift_prefix = 39;
516
-
517
- // Sets the php class prefix which is prepended to all php generated classes
518
- // from this .proto. Default is empty.
519
- optional string php_class_prefix = 40;
520
-
521
- // Use this option to change the namespace of php generated classes. Default
522
- // is empty. When this option is empty, the package name will be used for
523
- // determining the namespace.
524
- optional string php_namespace = 41;
525
-
526
- // Use this option to change the namespace of php generated metadata classes.
527
- // Default is empty. When this option is empty, the proto file name will be
528
- // used for determining the namespace.
529
- optional string php_metadata_namespace = 44;
530
-
531
- // Use this option to change the package of ruby generated classes. Default
532
- // is empty. When this option is not set, the package name will be used for
533
- // determining the ruby package.
534
- optional string ruby_package = 45;
535
-
536
- // Any features defined in the specific edition.
537
- optional FeatureSet features = 50;
538
-
539
- // The parser stores options it doesn't recognize here.
540
- // See the documentation for the "Options" section above.
541
- repeated UninterpretedOption uninterpreted_option = 999;
542
-
543
- // Clients can define custom options in extensions of this message.
544
- // See the documentation for the "Options" section above.
545
- extensions 1000 to max;
546
-
547
- reserved 38;
548
- }
549
-
550
- message MessageOptions {
551
- // Set true to use the old proto1 MessageSet wire format for extensions.
552
- // This is provided for backwards-compatibility with the MessageSet wire
553
- // format. You should not use this for any other reason: It's less
554
- // efficient, has fewer features, and is more complicated.
555
- //
556
- // The message must be defined exactly as follows:
557
- // message Foo {
558
- // option message_set_wire_format = true;
559
- // extensions 4 to max;
560
- // }
561
- // Note that the message cannot have any defined fields; MessageSets only
562
- // have extensions.
563
- //
564
- // All extensions of your type must be singular messages; e.g. they cannot
565
- // be int32s, enums, or repeated messages.
566
- //
567
- // Because this is an option, the above two restrictions are not enforced by
568
- // the protocol compiler.
569
- optional bool message_set_wire_format = 1 [default = false];
570
-
571
- // Disables the generation of the standard "descriptor()" accessor, which can
572
- // conflict with a field of the same name. This is meant to make migration
573
- // from proto1 easier; new code should avoid fields named "descriptor".
574
- optional bool no_standard_descriptor_accessor = 2 [default = false];
575
-
576
- // Is this message deprecated?
577
- // Depending on the target platform, this can emit Deprecated annotations
578
- // for the message, or it will be completely ignored; in the very least,
579
- // this is a formalization for deprecating messages.
580
- optional bool deprecated = 3 [default = false];
581
-
582
- reserved 4, 5, 6;
583
-
584
- // Whether the message is an automatically generated map entry type for the
585
- // maps field.
586
- //
587
- // For maps fields:
588
- // map<KeyType, ValueType> map_field = 1;
589
- // The parsed descriptor looks like:
590
- // message MapFieldEntry {
591
- // option map_entry = true;
592
- // optional KeyType key = 1;
593
- // optional ValueType value = 2;
594
- // }
595
- // repeated MapFieldEntry map_field = 1;
596
- //
597
- // Implementations may choose not to generate the map_entry=true message, but
598
- // use a native map in the target language to hold the keys and values.
599
- // The reflection APIs in such implementations still need to work as
600
- // if the field is a repeated message field.
601
- //
602
- // NOTE: Do not set the option in .proto files. Always use the maps syntax
603
- // instead. The option should only be implicitly set by the proto compiler
604
- // parser.
605
- optional bool map_entry = 7;
606
-
607
- reserved 8; // javalite_serializable
608
- reserved 9; // javanano_as_lite
609
-
610
- // Enable the legacy handling of JSON field name conflicts. This lowercases
611
- // and strips underscored from the fields before comparison in proto3 only.
612
- // The new behavior takes `json_name` into account and applies to proto2 as
613
- // well.
614
- //
615
- // This should only be used as a temporary measure against broken builds due
616
- // to the change in behavior for JSON field name conflicts.
617
- //
618
- // TODO This is legacy behavior we plan to remove once downstream
619
- // teams have had time to migrate.
620
- optional bool deprecated_legacy_json_field_conflicts = 11 [deprecated = true];
621
-
622
- // Any features defined in the specific edition.
623
- optional FeatureSet features = 12;
624
-
625
- // The parser stores options it doesn't recognize here. See above.
626
- repeated UninterpretedOption uninterpreted_option = 999;
627
-
628
- // Clients can define custom options in extensions of this message. See above.
629
- extensions 1000 to max;
630
- }
631
-
632
- message FieldOptions {
633
- // The ctype option instructs the C++ code generator to use a different
634
- // representation of the field than it normally would. See the specific
635
- // options below. This option is only implemented to support use of
636
- // [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
637
- // type "bytes" in the open source release -- sorry, we'll try to include
638
- // other types in a future version!
639
- optional CType ctype = 1 [default = STRING];
640
- enum CType {
641
- // Default mode.
642
- STRING = 0;
643
-
644
- // The option [ctype=CORD] may be applied to a non-repeated field of type
645
- // "bytes". It indicates that in C++, the data should be stored in a Cord
646
- // instead of a string. For very large strings, this may reduce memory
647
- // fragmentation. It may also allow better performance when parsing from a
648
- // Cord, or when parsing with aliasing enabled, as the parsed Cord may then
649
- // alias the original buffer.
650
- CORD = 1;
651
-
652
- STRING_PIECE = 2;
653
- }
654
- // The packed option can be enabled for repeated primitive fields to enable
655
- // a more efficient representation on the wire. Rather than repeatedly
656
- // writing the tag and type for each element, the entire array is encoded as
657
- // a single length-delimited blob. In proto3, only explicit setting it to
658
- // false will avoid using packed encoding. This option is prohibited in
659
- // Editions, but the `repeated_field_encoding` feature can be used to control
660
- // the behavior.
661
- optional bool packed = 2;
662
-
663
- // The jstype option determines the JavaScript type used for values of the
664
- // field. The option is permitted only for 64 bit integral and fixed types
665
- // (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
666
- // is represented as JavaScript string, which avoids loss of precision that
667
- // can happen when a large value is converted to a floating point JavaScript.
668
- // Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
669
- // use the JavaScript "number" type. The behavior of the default option
670
- // JS_NORMAL is implementation dependent.
671
- //
672
- // This option is an enum to permit additional types to be added, e.g.
673
- // goog.math.Integer.
674
- optional JSType jstype = 6 [default = JS_NORMAL];
675
- enum JSType {
676
- // Use the default type.
677
- JS_NORMAL = 0;
678
-
679
- // Use JavaScript strings.
680
- JS_STRING = 1;
681
-
682
- // Use JavaScript numbers.
683
- JS_NUMBER = 2;
684
- }
685
-
686
- // Should this field be parsed lazily? Lazy applies only to message-type
687
- // fields. It means that when the outer message is initially parsed, the
688
- // inner message's contents will not be parsed but instead stored in encoded
689
- // form. The inner message will actually be parsed when it is first accessed.
690
- //
691
- // This is only a hint. Implementations are free to choose whether to use
692
- // eager or lazy parsing regardless of the value of this option. However,
693
- // setting this option true suggests that the protocol author believes that
694
- // using lazy parsing on this field is worth the additional bookkeeping
695
- // overhead typically needed to implement it.
696
- //
697
- // This option does not affect the public interface of any generated code;
698
- // all method signatures remain the same. Furthermore, thread-safety of the
699
- // interface is not affected by this option; const methods remain safe to
700
- // call from multiple threads concurrently, while non-const methods continue
701
- // to require exclusive access.
702
- //
703
- // Note that lazy message fields are still eagerly verified to check
704
- // ill-formed wireformat or missing required fields. Calling IsInitialized()
705
- // on the outer message would fail if the inner message has missing required
706
- // fields. Failed verification would result in parsing failure (except when
707
- // uninitialized messages are acceptable).
708
- optional bool lazy = 5 [default = false];
709
-
710
- // unverified_lazy does no correctness checks on the byte stream. This should
711
- // only be used where lazy with verification is prohibitive for performance
712
- // reasons.
713
- optional bool unverified_lazy = 15 [default = false];
714
-
715
- // Is this field deprecated?
716
- // Depending on the target platform, this can emit Deprecated annotations
717
- // for accessors, or it will be completely ignored; in the very least, this
718
- // is a formalization for deprecating fields.
719
- optional bool deprecated = 3 [default = false];
720
-
721
- // For Google-internal migration only. Do not use.
722
- optional bool weak = 10 [default = false];
723
-
724
- // Indicate that the field value should not be printed out when using debug
725
- // formats, e.g. when the field contains sensitive credentials.
726
- optional bool debug_redact = 16 [default = false];
727
-
728
- // If set to RETENTION_SOURCE, the option will be omitted from the binary.
729
- // Note: as of January 2023, support for this is in progress and does not yet
730
- // have an effect (b/264593489).
731
- enum OptionRetention {
732
- RETENTION_UNKNOWN = 0;
733
- RETENTION_RUNTIME = 1;
734
- RETENTION_SOURCE = 2;
735
- }
736
-
737
- optional OptionRetention retention = 17;
738
-
739
- // This indicates the types of entities that the field may apply to when used
740
- // as an option. If it is unset, then the field may be freely used as an
741
- // option on any kind of entity. Note: as of January 2023, support for this is
742
- // in progress and does not yet have an effect (b/264593489).
743
- enum OptionTargetType {
744
- TARGET_TYPE_UNKNOWN = 0;
745
- TARGET_TYPE_FILE = 1;
746
- TARGET_TYPE_EXTENSION_RANGE = 2;
747
- TARGET_TYPE_MESSAGE = 3;
748
- TARGET_TYPE_FIELD = 4;
749
- TARGET_TYPE_ONEOF = 5;
750
- TARGET_TYPE_ENUM = 6;
751
- TARGET_TYPE_ENUM_ENTRY = 7;
752
- TARGET_TYPE_SERVICE = 8;
753
- TARGET_TYPE_METHOD = 9;
754
- }
755
-
756
- repeated OptionTargetType targets = 19;
757
-
758
- message EditionDefault {
759
- optional Edition edition = 3;
760
- optional string value = 2; // Textproto value.
761
- }
762
- repeated EditionDefault edition_defaults = 20;
763
-
764
- // Any features defined in the specific edition.
765
- optional FeatureSet features = 21;
766
-
767
- // The parser stores options it doesn't recognize here. See above.
768
- repeated UninterpretedOption uninterpreted_option = 999;
769
-
770
- // Clients can define custom options in extensions of this message. See above.
771
- extensions 1000 to max;
772
-
773
- reserved 4; // removed jtype
774
- reserved 18; // reserve target, target_obsolete_do_not_use
775
- }
776
-
777
- message OneofOptions {
778
- // Any features defined in the specific edition.
779
- optional FeatureSet features = 1;
780
-
781
- // The parser stores options it doesn't recognize here. See above.
782
- repeated UninterpretedOption uninterpreted_option = 999;
783
-
784
- // Clients can define custom options in extensions of this message. See above.
785
- extensions 1000 to max;
786
- }
787
-
788
- message EnumOptions {
789
-
790
- // Set this option to true to allow mapping different tag names to the same
791
- // value.
792
- optional bool allow_alias = 2;
793
-
794
- // Is this enum deprecated?
795
- // Depending on the target platform, this can emit Deprecated annotations
796
- // for the enum, or it will be completely ignored; in the very least, this
797
- // is a formalization for deprecating enums.
798
- optional bool deprecated = 3 [default = false];
799
-
800
- reserved 5; // javanano_as_lite
801
-
802
- // Enable the legacy handling of JSON field name conflicts. This lowercases
803
- // and strips underscored from the fields before comparison in proto3 only.
804
- // The new behavior takes `json_name` into account and applies to proto2 as
805
- // well.
806
- // TODO Remove this legacy behavior once downstream teams have
807
- // had time to migrate.
808
- optional bool deprecated_legacy_json_field_conflicts = 6 [deprecated = true];
809
-
810
- // Any features defined in the specific edition.
811
- optional FeatureSet features = 7;
812
-
813
- // The parser stores options it doesn't recognize here. See above.
814
- repeated UninterpretedOption uninterpreted_option = 999;
815
-
816
- // Clients can define custom options in extensions of this message. See above.
817
- extensions 1000 to max;
818
- }
819
-
820
- message EnumValueOptions {
821
- // Is this enum value deprecated?
822
- // Depending on the target platform, this can emit Deprecated annotations
823
- // for the enum value, or it will be completely ignored; in the very least,
824
- // this is a formalization for deprecating enum values.
825
- optional bool deprecated = 1 [default = false];
826
-
827
- // Any features defined in the specific edition.
828
- optional FeatureSet features = 2;
829
-
830
- // Indicate that fields annotated with this enum value should not be printed
831
- // out when using debug formats, e.g. when the field contains sensitive
832
- // credentials.
833
- optional bool debug_redact = 3 [default = false];
834
-
835
- // The parser stores options it doesn't recognize here. See above.
836
- repeated UninterpretedOption uninterpreted_option = 999;
837
-
838
- // Clients can define custom options in extensions of this message. See above.
839
- extensions 1000 to max;
840
- }
841
-
842
- message ServiceOptions {
843
-
844
- // Any features defined in the specific edition.
845
- optional FeatureSet features = 34;
846
-
847
- // Note: Field numbers 1 through 32 are reserved for Google's internal RPC
848
- // framework. We apologize for hoarding these numbers to ourselves, but
849
- // we were already using them long before we decided to release Protocol
850
- // Buffers.
851
-
852
- // Is this service deprecated?
853
- // Depending on the target platform, this can emit Deprecated annotations
854
- // for the service, or it will be completely ignored; in the very least,
855
- // this is a formalization for deprecating services.
856
- optional bool deprecated = 33 [default = false];
857
-
858
- // The parser stores options it doesn't recognize here. See above.
859
- repeated UninterpretedOption uninterpreted_option = 999;
860
-
861
- // Clients can define custom options in extensions of this message. See above.
862
- extensions 1000 to max;
863
- }
864
-
865
- message MethodOptions {
866
-
867
- // Note: Field numbers 1 through 32 are reserved for Google's internal RPC
868
- // framework. We apologize for hoarding these numbers to ourselves, but
869
- // we were already using them long before we decided to release Protocol
870
- // Buffers.
871
-
872
- // Is this method deprecated?
873
- // Depending on the target platform, this can emit Deprecated annotations
874
- // for the method, or it will be completely ignored; in the very least,
875
- // this is a formalization for deprecating methods.
876
- optional bool deprecated = 33 [default = false];
877
-
878
- // Is this method side-effect-free (or safe in HTTP parlance), or idempotent,
879
- // or neither? HTTP based RPC implementation may choose GET verb for safe
880
- // methods, and PUT verb for idempotent methods instead of the default POST.
881
- enum IdempotencyLevel {
882
- IDEMPOTENCY_UNKNOWN = 0;
883
- NO_SIDE_EFFECTS = 1; // implies idempotent
884
- IDEMPOTENT = 2; // idempotent, but may have side effects
885
- }
886
- optional IdempotencyLevel idempotency_level = 34
887
- [default = IDEMPOTENCY_UNKNOWN];
888
-
889
- // Any features defined in the specific edition.
890
- optional FeatureSet features = 35;
891
-
892
- // The parser stores options it doesn't recognize here. See above.
893
- repeated UninterpretedOption uninterpreted_option = 999;
894
-
895
- // Clients can define custom options in extensions of this message. See above.
896
- extensions 1000 to max;
897
- }
898
-
899
- // A message representing a option the parser does not recognize. This only
900
- // appears in options protos created by the compiler::Parser class.
901
- // DescriptorPool resolves these when building Descriptor objects. Therefore,
902
- // options protos in descriptor objects (e.g. returned by Descriptor::options(),
903
- // or produced by Descriptor::CopyTo()) will never have UninterpretedOptions
904
- // in them.
905
- message UninterpretedOption {
906
- // The name of the uninterpreted option. Each string represents a segment in
907
- // a dot-separated name. is_extension is true iff a segment represents an
908
- // extension (denoted with parentheses in options specs in .proto files).
909
- // E.g.,{ ["foo", false], ["bar.baz", true], ["moo", false] } represents
910
- // "foo.(bar.baz).moo".
911
- message NamePart {
912
- required string name_part = 1;
913
- required bool is_extension = 2;
914
- }
915
- repeated NamePart name = 2;
916
-
917
- // The value of the uninterpreted option, in whatever type the tokenizer
918
- // identified it as during parsing. Exactly one of these should be set.
919
- optional string identifier_value = 3;
920
- optional uint64 positive_int_value = 4;
921
- optional int64 negative_int_value = 5;
922
- optional double double_value = 6;
923
- optional bytes string_value = 7;
924
- optional string aggregate_value = 8;
925
- }
926
-
927
- // ===================================================================
928
- // Features
929
-
930
- // TODO Enums in C++ gencode (and potentially other languages) are
931
- // not well scoped. This means that each of the feature enums below can clash
932
- // with each other. The short names we've chosen maximize call-site
933
- // readability, but leave us very open to this scenario. A future feature will
934
- // be designed and implemented to handle this, hopefully before we ever hit a
935
- // conflict here.
936
- message FeatureSet {
937
- enum FieldPresence {
938
- FIELD_PRESENCE_UNKNOWN = 0;
939
- EXPLICIT = 1;
940
- IMPLICIT = 2;
941
- LEGACY_REQUIRED = 3;
942
- }
943
- optional FieldPresence field_presence = 1 [
944
- retention = RETENTION_RUNTIME,
945
- targets = TARGET_TYPE_FIELD,
946
- targets = TARGET_TYPE_FILE,
947
- edition_defaults = { edition: EDITION_PROTO2, value: "EXPLICIT" },
948
- edition_defaults = { edition: EDITION_PROTO3, value: "IMPLICIT" },
949
- edition_defaults = { edition: EDITION_2023, value: "EXPLICIT" }
950
- ];
951
-
952
- enum EnumType {
953
- ENUM_TYPE_UNKNOWN = 0;
954
- OPEN = 1;
955
- CLOSED = 2;
956
- }
957
- optional EnumType enum_type = 2 [
958
- retention = RETENTION_RUNTIME,
959
- targets = TARGET_TYPE_ENUM,
960
- targets = TARGET_TYPE_FILE,
961
- edition_defaults = { edition: EDITION_PROTO2, value: "CLOSED" },
962
- edition_defaults = { edition: EDITION_PROTO3, value: "OPEN" }
963
- ];
964
-
965
- enum RepeatedFieldEncoding {
966
- REPEATED_FIELD_ENCODING_UNKNOWN = 0;
967
- PACKED = 1;
968
- EXPANDED = 2;
969
- }
970
- optional RepeatedFieldEncoding repeated_field_encoding = 3 [
971
- retention = RETENTION_RUNTIME,
972
- targets = TARGET_TYPE_FIELD,
973
- targets = TARGET_TYPE_FILE,
974
- edition_defaults = { edition: EDITION_PROTO2, value: "EXPANDED" },
975
- edition_defaults = { edition: EDITION_PROTO3, value: "PACKED" }
976
- ];
977
-
978
- enum Utf8Validation {
979
- UTF8_VALIDATION_UNKNOWN = 0;
980
- VERIFY = 2;
981
- NONE = 3;
982
- }
983
- optional Utf8Validation utf8_validation = 4 [
984
- retention = RETENTION_RUNTIME,
985
- targets = TARGET_TYPE_FIELD,
986
- targets = TARGET_TYPE_FILE,
987
- edition_defaults = { edition: EDITION_PROTO2, value: "NONE" },
988
- edition_defaults = { edition: EDITION_PROTO3, value: "VERIFY" }
989
- ];
990
-
991
- enum MessageEncoding {
992
- MESSAGE_ENCODING_UNKNOWN = 0;
993
- LENGTH_PREFIXED = 1;
994
- DELIMITED = 2;
995
- }
996
- optional MessageEncoding message_encoding = 5 [
997
- retention = RETENTION_RUNTIME,
998
- targets = TARGET_TYPE_FIELD,
999
- targets = TARGET_TYPE_FILE,
1000
- edition_defaults = { edition: EDITION_PROTO2, value: "LENGTH_PREFIXED" }
1001
- ];
1002
-
1003
- enum JsonFormat {
1004
- JSON_FORMAT_UNKNOWN = 0;
1005
- ALLOW = 1;
1006
- LEGACY_BEST_EFFORT = 2;
1007
- }
1008
- optional JsonFormat json_format = 6 [
1009
- retention = RETENTION_RUNTIME,
1010
- targets = TARGET_TYPE_MESSAGE,
1011
- targets = TARGET_TYPE_ENUM,
1012
- targets = TARGET_TYPE_FILE,
1013
- edition_defaults = { edition: EDITION_PROTO2, value: "LEGACY_BEST_EFFORT" },
1014
- edition_defaults = { edition: EDITION_PROTO3, value: "ALLOW" }
1015
- ];
1016
-
1017
- reserved 999;
1018
-
1019
- extensions 1000; // for Protobuf C++
1020
- extensions 1001; // for Protobuf Java
1021
- extensions 1002; // for Protobuf Go
1022
-
1023
- extensions 9990; // for deprecated Java Proto1
1024
-
1025
- extensions 9995 to 9999; // For internal testing
1026
- extensions 10000; // for https://github.com/bufbuild/protobuf-es
1027
- }
1028
-
1029
- // A compiled specification for the defaults of a set of features. These
1030
- // messages are generated from FeatureSet extensions and can be used to seed
1031
- // feature resolution. The resolution with this object becomes a simple search
1032
- // for the closest matching edition, followed by proto merges.
1033
- message FeatureSetDefaults {
1034
- // A map from every known edition with a unique set of defaults to its
1035
- // defaults. Not all editions may be contained here. For a given edition,
1036
- // the defaults at the closest matching edition ordered at or before it should
1037
- // be used. This field must be in strict ascending order by edition.
1038
- message FeatureSetEditionDefault {
1039
- optional Edition edition = 3;
1040
- optional FeatureSet features = 2;
1041
- }
1042
- repeated FeatureSetEditionDefault defaults = 1;
1043
-
1044
- // The minimum supported edition (inclusive) when this was constructed.
1045
- // Editions before this will not have defaults.
1046
- optional Edition minimum_edition = 4;
1047
-
1048
- // The maximum known edition (inclusive) when this was constructed. Editions
1049
- // after this will not have reliable defaults.
1050
- optional Edition maximum_edition = 5;
1051
- }
1052
-
1053
- // ===================================================================
1054
- // Optional source code info
1055
-
1056
- // Encapsulates information about the original source file from which a
1057
- // FileDescriptorProto was generated.
1058
- message SourceCodeInfo {
1059
- // A Location identifies a piece of source code in a .proto file which
1060
- // corresponds to a particular definition. This information is intended
1061
- // to be useful to IDEs, code indexers, documentation generators, and similar
1062
- // tools.
1063
- //
1064
- // For example, say we have a file like:
1065
- // message Foo {
1066
- // optional string foo = 1;
1067
- // }
1068
- // Let's look at just the field definition:
1069
- // optional string foo = 1;
1070
- // ^ ^^ ^^ ^ ^^^
1071
- // a bc de f ghi
1072
- // We have the following locations:
1073
- // span path represents
1074
- // [a,i) [ 4, 0, 2, 0 ] The whole field definition.
1075
- // [a,b) [ 4, 0, 2, 0, 4 ] The label (optional).
1076
- // [c,d) [ 4, 0, 2, 0, 5 ] The type (string).
1077
- // [e,f) [ 4, 0, 2, 0, 1 ] The name (foo).
1078
- // [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
1079
- //
1080
- // Notes:
1081
- // - A location may refer to a repeated field itself (i.e. not to any
1082
- // particular index within it). This is used whenever a set of elements are
1083
- // logically enclosed in a single code segment. For example, an entire
1084
- // extend block (possibly containing multiple extension definitions) will
1085
- // have an outer location whose path refers to the "extensions" repeated
1086
- // field without an index.
1087
- // - Multiple locations may have the same path. This happens when a single
1088
- // logical declaration is spread out across multiple places. The most
1089
- // obvious example is the "extend" block again -- there may be multiple
1090
- // extend blocks in the same scope, each of which will have the same path.
1091
- // - A location's span is not always a subset of its parent's span. For
1092
- // example, the "extendee" of an extension declaration appears at the
1093
- // beginning of the "extend" block and is shared by all extensions within
1094
- // the block.
1095
- // - Just because a location's span is a subset of some other location's span
1096
- // does not mean that it is a descendant. For example, a "group" defines
1097
- // both a type and a field in a single declaration. Thus, the locations
1098
- // corresponding to the type and field and their components will overlap.
1099
- // - Code which tries to interpret locations should probably be designed to
1100
- // ignore those that it doesn't understand, as more types of locations could
1101
- // be recorded in the future.
1102
- repeated Location location = 1;
1103
- message Location {
1104
- // Identifies which part of the FileDescriptorProto was defined at this
1105
- // location.
1106
- //
1107
- // Each element is a field number or an index. They form a path from
1108
- // the root FileDescriptorProto to the place where the definition appears.
1109
- // For example, this path:
1110
- // [ 4, 3, 2, 7, 1 ]
1111
- // refers to:
1112
- // file.message_type(3) // 4, 3
1113
- // .field(7) // 2, 7
1114
- // .name() // 1
1115
- // This is because FileDescriptorProto.message_type has field number 4:
1116
- // repeated DescriptorProto message_type = 4;
1117
- // and DescriptorProto.field has field number 2:
1118
- // repeated FieldDescriptorProto field = 2;
1119
- // and FieldDescriptorProto.name has field number 1:
1120
- // optional string name = 1;
1121
- //
1122
- // Thus, the above path gives the location of a field name. If we removed
1123
- // the last element:
1124
- // [ 4, 3, 2, 7 ]
1125
- // this path refers to the whole field declaration (from the beginning
1126
- // of the label to the terminating semicolon).
1127
- repeated int32 path = 1 [packed = true];
1128
-
1129
- // Always has exactly three or four elements: start line, start column,
1130
- // end line (optional, otherwise assumed same as start line), end column.
1131
- // These are packed into a single field for efficiency. Note that line
1132
- // and column numbers are zero-based -- typically you will want to add
1133
- // 1 to each before displaying to a user.
1134
- repeated int32 span = 2 [packed = true];
1135
-
1136
- // If this SourceCodeInfo represents a complete declaration, these are any
1137
- // comments appearing before and after the declaration which appear to be
1138
- // attached to the declaration.
1139
- //
1140
- // A series of line comments appearing on consecutive lines, with no other
1141
- // tokens appearing on those lines, will be treated as a single comment.
1142
- //
1143
- // leading_detached_comments will keep paragraphs of comments that appear
1144
- // before (but not connected to) the current element. Each paragraph,
1145
- // separated by empty lines, will be one comment element in the repeated
1146
- // field.
1147
- //
1148
- // Only the comment content is provided; comment markers (e.g. //) are
1149
- // stripped out. For block comments, leading whitespace and an asterisk
1150
- // will be stripped from the beginning of each line other than the first.
1151
- // Newlines are included in the output.
1152
- //
1153
- // Examples:
1154
- //
1155
- // optional int32 foo = 1; // Comment attached to foo.
1156
- // // Comment attached to bar.
1157
- // optional int32 bar = 2;
1158
- //
1159
- // optional string baz = 3;
1160
- // // Comment attached to baz.
1161
- // // Another line attached to baz.
1162
- //
1163
- // // Comment attached to moo.
1164
- // //
1165
- // // Another line attached to moo.
1166
- // optional double moo = 4;
1167
- //
1168
- // // Detached comment for corge. This is not leading or trailing comments
1169
- // // to moo or corge because there are blank lines separating it from
1170
- // // both.
1171
- //
1172
- // // Detached comment for corge paragraph 2.
1173
- //
1174
- // optional string corge = 5;
1175
- // /* Block comment attached
1176
- // * to corge. Leading asterisks
1177
- // * will be removed. */
1178
- // /* Block comment attached to
1179
- // * grault. */
1180
- // optional int32 grault = 6;
1181
- //
1182
- // // ignored detached comments.
1183
- optional string leading_comments = 3;
1184
- optional string trailing_comments = 4;
1185
- repeated string leading_detached_comments = 6;
1186
- }
1187
- }
1188
-
1189
- // Describes the relationship between generated code and its original source
1190
- // file. A GeneratedCodeInfo message is associated with only one generated
1191
- // source file, but may contain references to different source .proto files.
1192
- message GeneratedCodeInfo {
1193
- // An Annotation connects some span of text in generated code to an element
1194
- // of its generating .proto file.
1195
- repeated Annotation annotation = 1;
1196
- message Annotation {
1197
- // Identifies the element in the original source .proto file. This field
1198
- // is formatted the same as SourceCodeInfo.Location.path.
1199
- repeated int32 path = 1 [packed = true];
1200
-
1201
- // Identifies the filesystem path to the original source .proto.
1202
- optional string source_file = 2;
1203
-
1204
- // Identifies the starting offset in bytes in the generated code
1205
- // that relates to the identified object.
1206
- optional int32 begin = 3;
1207
-
1208
- // Identifies the ending offset in bytes in the generated code that
1209
- // relates to the identified object. The end offset should be one past
1210
- // the last relevant byte (so the length of the text = end - begin).
1211
- optional int32 end = 4;
1212
-
1213
- // Represents the identified object's effect on the element in the original
1214
- // .proto file.
1215
- enum Semantic {
1216
- // There is no effect or the effect is indescribable.
1217
- NONE = 0;
1218
- // The element is set or otherwise mutated.
1219
- SET = 1;
1220
- // An alias to the element is returned.
1221
- ALIAS = 2;
1222
- }
1223
- optional Semantic semantic = 5;
1224
- }
1225
- }