@rsdk/builtin-contract 4.0.0-next.5 → 4.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.
package/docs/README.md CHANGED
@@ -1,25 +1,26 @@
1
1
  # Protocol Documentation
2
+
2
3
  <a name="top"></a>
3
4
 
4
5
  ## Table of Contents
5
6
 
6
7
  - [grpc/error/v1/error.proto](#grpc_error_v1_error-proto)
7
8
  - [Status](#grpc-error-v1-Status)
8
-
9
+
9
10
  - [grpc/health/v1/health.proto](#grpc_health_v1_health-proto)
10
11
  - [HealthCheckRequest](#grpc-health-v1-HealthCheckRequest)
11
12
  - [HealthCheckResponse](#grpc-health-v1-HealthCheckResponse)
12
-
13
+
13
14
  - [HealthCheckResponse.ServingStatus](#grpc-health-v1-HealthCheckResponse-ServingStatus)
14
-
15
+
15
16
  - [Health](#grpc-health-v1-Health)
16
-
17
+
17
18
  - [grpc/metrics/v1/metrics.proto](#grpc_metrics_v1_metrics-proto)
18
19
  - [GetRequest](#grpc-metrics-v1-GetRequest)
19
20
  - [GetResponse](#grpc-metrics-v1-GetResponse)
20
-
21
+
21
22
  - [Metrics](#grpc-metrics-v1-Metrics)
22
-
23
+
23
24
  - [grpc/reflection/v1/reflection.proto](#grpc_reflection_v1_reflection-proto)
24
25
  - [ErrorResponse](#grpc-reflection-v1-ErrorResponse)
25
26
  - [ExtensionNumberResponse](#grpc-reflection-v1-ExtensionNumberResponse)
@@ -29,9 +30,9 @@
29
30
  - [ServerReflectionRequest](#grpc-reflection-v1-ServerReflectionRequest)
30
31
  - [ServerReflectionResponse](#grpc-reflection-v1-ServerReflectionResponse)
31
32
  - [ServiceResponse](#grpc-reflection-v1-ServiceResponse)
32
-
33
+
33
34
  - [ServerReflection](#grpc-reflection-v1-ServerReflection)
34
-
35
+
35
36
  - [grpc/reflection/v1alpha/reflection.proto](#grpc_reflection_v1alpha_reflection-proto)
36
37
  - [ErrorResponse](#grpc-reflection-v1alpha-ErrorResponse)
37
38
  - [ExtensionNumberResponse](#grpc-reflection-v1alpha-ExtensionNumberResponse)
@@ -41,518 +42,358 @@
41
42
  - [ServerReflectionRequest](#grpc-reflection-v1alpha-ServerReflectionRequest)
42
43
  - [ServerReflectionResponse](#grpc-reflection-v1alpha-ServerReflectionResponse)
43
44
  - [ServiceResponse](#grpc-reflection-v1alpha-ServiceResponse)
44
-
45
- - [ServerReflection](#grpc-reflection-v1alpha-ServerReflection)
46
-
47
- - [Scalar Value Types](#scalar-value-types)
48
45
 
46
+ - [ServerReflection](#grpc-reflection-v1alpha-ServerReflection)
49
47
 
48
+ - [Scalar Value Types](#scalar-value-types)
50
49
 
51
50
  <a name="grpc_error_v1_error-proto"></a>
52
51
  <p align="right"><a href="#top">Top</a></p>
53
52
 
54
53
  ## grpc/error/v1/error.proto
55
54
 
56
-
57
-
58
55
  <a name="grpc-error-v1-Status"></a>
59
56
 
60
57
  ### Status
61
- Status
62
-
63
-
64
- | Field | Type | Label | Description |
65
- | ----- | ---- | ----- | ----------- |
66
- | code | [int32](#int32) | | The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. |
67
- | message | [string](#string) | | A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. |
68
- | details | [google.protobuf.Struct](#google-protobuf-Struct) | optional | A list of messages that carry the error details. There is a common set of message types for APIs to use. |
69
- | exception_code | [string](#string) | optional | exception_code https://github.com/R-Vision/rsdk/blob/078fad7c8fdbb419f3a351e4da6792e163c52cf5/packages/core/src/exceptions/base/platform-exception.absract.ts#L7 |
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
-
81
-
82
58
 
59
+ Status
83
60
 
61
+ | Field | Type | Label | Description |
62
+ |----------------|---------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
63
+ | code | [int32](#int32) | | The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. |
64
+ | message | [string](#string) | | A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. |
65
+ | details | [google.protobuf.Struct](#google-protobuf-Struct) | optional | A list of messages that carry the error details. There is a common set of message types for APIs to use. |
66
+ | exception_code | [string](#string) | optional | exception_code https://github.com/R-Vision/rsdk/blob/078fad7c8fdbb419f3a351e4da6792e163c52cf5/packages/core/src/exceptions/base/platform-exception.absract.ts#L7 |
84
67
 
85
68
  <a name="grpc_health_v1_health-proto"></a>
86
69
  <p align="right"><a href="#top">Top</a></p>
87
70
 
88
71
  ## grpc/health/v1/health.proto
89
72
 
90
-
91
-
92
73
  <a name="grpc-health-v1-HealthCheckRequest"></a>
93
74
 
94
75
  ### HealthCheckRequest
95
- HealthCheckRequest
96
-
97
-
98
- | Field | Type | Label | Description |
99
- | ----- | ---- | ----- | ----------- |
100
- | service | [string](#string) | | service |
101
-
102
-
103
-
104
76
 
77
+ HealthCheckRequest
105
78
 
79
+ | Field | Type | Label | Description |
80
+ |---------|-------------------|-------|-------------|
81
+ | service | [string](#string) | | service |
106
82
 
107
83
  <a name="grpc-health-v1-HealthCheckResponse"></a>
108
84
 
109
85
  ### HealthCheckResponse
110
- HealthCheckResponse
111
-
112
-
113
- | Field | Type | Label | Description |
114
- | ----- | ---- | ----- | ----------- |
115
- | status | [HealthCheckResponse.ServingStatus](#grpc-health-v1-HealthCheckResponse-ServingStatus) | | status |
116
86
 
87
+ HealthCheckResponse
117
88
 
118
-
119
-
120
-
121
-
122
-
89
+ | Field | Type | Label | Description |
90
+ |--------|----------------------------------------------------------------------------------------|-------|-------------|
91
+ | status | [HealthCheckResponse.ServingStatus](#grpc-health-v1-HealthCheckResponse-ServingStatus) | | status |
123
92
 
124
93
  <a name="grpc-health-v1-HealthCheckResponse-ServingStatus"></a>
125
94
 
126
95
  ### HealthCheckResponse.ServingStatus
127
- ServingStatus
128
-
129
- | Name | Number | Description |
130
- | ---- | ------ | ----------- |
131
- | UNKNOWN | 0 | UNKNOWN buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX buf:lint:ignore ENUM_VALUE_PREFIX |
132
- | SERVING | 1 | SERVING buf:lint:ignore ENUM_VALUE_PREFIX |
133
- | NOT_SERVING | 2 | NOT_SERVING buf:lint:ignore ENUM_VALUE_PREFIX |
134
- | SERVICE_UNKNOWN | 3 | SERVICE_UNKNOWN — Used only by the Watch method. buf:lint:ignore ENUM_VALUE_PREFIX |
135
96
 
97
+ ServingStatus
136
98
 
137
-
138
-
139
-
140
-
99
+ | Name | Number | Description |
100
+ |-----------------|--------|------------------------------------------------------------------------------------|
101
+ | UNKNOWN | 0 | UNKNOWN buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX buf:lint:ignore ENUM_VALUE_PREFIX |
102
+ | SERVING | 1 | SERVING buf:lint:ignore ENUM_VALUE_PREFIX |
103
+ | NOT_SERVING | 2 | NOT_SERVING buf:lint:ignore ENUM_VALUE_PREFIX |
104
+ | SERVICE_UNKNOWN | 3 | SERVICE_UNKNOWN — Used only by the Watch method. buf:lint:ignore ENUM_VALUE_PREFIX |
141
105
 
142
106
  <a name="grpc-health-v1-Health"></a>
143
107
 
144
108
  ### Health
109
+
145
110
  buf:lint:ignore SERVICE_SUFFIX
146
111
  Health
147
112
 
148
- | Method Name | Request Type | Response Type | Description |
149
- | ----------- | ------------ | ------------- | ------------|
150
- | Check | [HealthCheckRequest](#grpc-health-v1-HealthCheckRequest) | [HealthCheckResponse](#grpc-health-v1-HealthCheckResponse) | Check buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME |
151
- | Watch | [HealthCheckRequest](#grpc-health-v1-HealthCheckRequest) | [HealthCheckResponse](#grpc-health-v1-HealthCheckResponse) stream | Watch buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME |
152
-
153
-
154
-
155
-
113
+ | Method Name | Request Type | Response Type | Description |
114
+ |-------------|----------------------------------------------------------|-------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
115
+ | Check | [HealthCheckRequest](#grpc-health-v1-HealthCheckRequest) | [HealthCheckResponse](#grpc-health-v1-HealthCheckResponse) | Check buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME |
116
+ | Watch | [HealthCheckRequest](#grpc-health-v1-HealthCheckRequest) | [HealthCheckResponse](#grpc-health-v1-HealthCheckResponse) stream | Watch buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME |
156
117
 
157
118
  <a name="grpc_metrics_v1_metrics-proto"></a>
158
119
  <p align="right"><a href="#top">Top</a></p>
159
120
 
160
121
  ## grpc/metrics/v1/metrics.proto
161
- metrics
162
122
 
123
+ metrics
163
124
 
164
125
  <a name="grpc-metrics-v1-GetRequest"></a>
165
126
 
166
127
  ### GetRequest
167
- Empty request
168
-
169
-
170
-
171
-
172
128
 
129
+ Empty request
173
130
 
174
131
  <a name="grpc-metrics-v1-GetResponse"></a>
175
132
 
176
133
  ### GetResponse
177
- Metrics response
178
-
179
-
180
- | Field | Type | Label | Description |
181
- | ----- | ---- | ----- | ----------- |
182
- | metrics | [string](#string) | | String in prometheus format |
183
-
184
134
 
135
+ Metrics response
185
136
 
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
137
+ | Field | Type | Label | Description |
138
+ |---------|-------------------|-------|-----------------------------|
139
+ | metrics | [string](#string) | | String in prometheus format |
194
140
 
195
141
  <a name="grpc-metrics-v1-Metrics"></a>
196
142
 
197
143
  ### Metrics
144
+
198
145
  MetricsService
199
146
  buf:lint:ignore SERVICE_SUFFIX
200
147
 
201
- | Method Name | Request Type | Response Type | Description |
202
- | ----------- | ------------ | ------------- | ------------|
203
- | Get | [GetRequest](#grpc-metrics-v1-GetRequest) | [GetResponse](#grpc-metrics-v1-GetResponse) | Get metrics in stringiried prometheus format |
204
-
205
-
206
-
207
-
148
+ | Method Name | Request Type | Response Type | Description |
149
+ |-------------|-------------------------------------------|---------------------------------------------|----------------------------------------------|
150
+ | Get | [GetRequest](#grpc-metrics-v1-GetRequest) | [GetResponse](#grpc-metrics-v1-GetResponse) | Get metrics in stringiried prometheus format |
208
151
 
209
152
  <a name="grpc_reflection_v1_reflection-proto"></a>
210
153
  <p align="right"><a href="#top">Top</a></p>
211
154
 
212
155
  ## grpc/reflection/v1/reflection.proto
213
156
 
214
-
215
-
216
157
  <a name="grpc-reflection-v1-ErrorResponse"></a>
217
158
 
218
159
  ### ErrorResponse
219
- The error code and error message sent by the server when an error occurs.
220
-
221
-
222
- | Field | Type | Label | Description |
223
- | ----- | ---- | ----- | ----------- |
224
- | error_code | [int32](#int32) | | This field uses the error codes defined in grpc::StatusCode. |
225
- | error_message | [string](#string) | | error_message |
226
-
227
-
228
-
229
160
 
161
+ The error code and error message sent by the server when an error occurs.
230
162
 
163
+ | Field | Type | Label | Description |
164
+ |---------------|-------------------|-------|--------------------------------------------------------------|
165
+ | error_code | [int32](#int32) | | This field uses the error codes defined in grpc::StatusCode. |
166
+ | error_message | [string](#string) | | error_message |
231
167
 
232
168
  <a name="grpc-reflection-v1-ExtensionNumberResponse"></a>
233
169
 
234
170
  ### ExtensionNumberResponse
171
+
235
172
  A list of extension numbers sent by the server answering
236
173
  all_extension_numbers_of_type request.
237
174
 
238
-
239
- | Field | Type | Label | Description |
240
- | ----- | ---- | ----- | ----------- |
241
- | base_type_name | [string](#string) | | Full name of the base type, including the package name. The format is &lt;package&gt;.&lt;type&gt; |
242
- | extension_number | [int32](#int32) | repeated | extension_number |
243
-
244
-
245
-
246
-
247
-
175
+ | Field | Type | Label | Description |
176
+ |------------------|-------------------|----------|----------------------------------------------------------------------------------------------------|
177
+ | base_type_name | [string](#string) | | Full name of the base type, including the package name. The format is &lt;package&gt;.&lt;type&gt; |
178
+ | extension_number | [int32](#int32) | repeated | extension_number |
248
179
 
249
180
  <a name="grpc-reflection-v1-ExtensionRequest"></a>
250
181
 
251
182
  ### ExtensionRequest
183
+
252
184
  The type name and extension number sent by the client when requesting
253
185
  file_containing_extension.
254
186
 
255
-
256
- | Field | Type | Label | Description |
257
- | ----- | ---- | ----- | ----------- |
258
- | containing_type | [string](#string) | | Fully-qualified type name. The format should be &lt;package&gt;.&lt;type&gt; |
259
- | extension_number | [int32](#int32) | | extension_number |
260
-
261
-
262
-
263
-
264
-
187
+ | Field | Type | Label | Description |
188
+ |------------------|-------------------|-------|------------------------------------------------------------------------------|
189
+ | containing_type | [string](#string) | | Fully-qualified type name. The format should be &lt;package&gt;.&lt;type&gt; |
190
+ | extension_number | [int32](#int32) | | extension_number |
265
191
 
266
192
  <a name="grpc-reflection-v1-FileDescriptorResponse"></a>
267
193
 
268
194
  ### FileDescriptorResponse
195
+
269
196
  Serialized FileDescriptorProto messages sent by the server answering
270
197
  a file_by_filename, file_containing_symbol, or file_containing_extension
271
198
  request.
272
199
 
273
-
274
- | Field | Type | Label | Description |
275
- | ----- | ---- | ----- | ----------- |
200
+ | Field | Type | Label | Description |
201
+ |-----------------------|-----------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
276
202
  | file_descriptor_proto | [bytes](#bytes) | repeated | Serialized FileDescriptorProto messages. We avoid taking a dependency on descriptor.proto, which uses proto2 only features, by making them opaque bytes instead. |
277
203
 
278
-
279
-
280
-
281
-
282
-
283
204
  <a name="grpc-reflection-v1-ListServiceResponse"></a>
284
205
 
285
206
  ### ListServiceResponse
286
- A list of ServiceResponse sent by the server answering list_services request.
287
207
 
208
+ A list of ServiceResponse sent by the server answering list_services request.
288
209
 
289
- | Field | Type | Label | Description |
290
- | ----- | ---- | ----- | ----------- |
210
+ | Field | Type | Label | Description |
211
+ |---------|--------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------|
291
212
  | service | [ServiceResponse](#grpc-reflection-v1-ServiceResponse) | repeated | The information of each service may be expanded in the future, so we use ServiceResponse message to encapsulate it. |
292
213
 
293
-
294
-
295
-
296
-
297
-
298
214
  <a name="grpc-reflection-v1-ServerReflectionRequest"></a>
299
215
 
300
216
  ### ServerReflectionRequest
301
- The message sent by the client when calling ServerReflectionInfo method.
302
-
303
-
304
- | Field | Type | Label | Description |
305
- | ----- | ---- | ----- | ----------- |
306
- | host | [string](#string) | | host |
307
- | file_by_filename | [string](#string) | | Find a proto file by the file name. |
308
- | file_containing_symbol | [string](#string) | | Find the proto file that declares the given fully-qualified symbol name. This field should be a fully-qualified symbol name (e.g. &lt;package&gt;.&lt;service&gt;[.&lt;method&gt;] or &lt;package&gt;.&lt;type&gt;). |
309
- | file_containing_extension | [ExtensionRequest](#grpc-reflection-v1-ExtensionRequest) | | Find the proto file which defines an extension extending the given message type with the given field number. |
310
- | all_extension_numbers_of_type | [string](#string) | | Finds the tag numbers used by all known extensions of the given message type, and appends them to ExtensionNumberResponse in an undefined order. Its corresponding method is best-effort: it&#39;s not guaranteed that the reflection service will implement this method, and it&#39;s not guaranteed that this method will provide all extensions. Returns StatusCode::UNIMPLEMENTED if it&#39;s not implemented. This field should be a fully-qualified type name. The format is &lt;package&gt;.&lt;type&gt; |
311
- | list_services | [string](#string) | | List the full names of registered services. The content will not be checked. |
312
-
313
-
314
-
315
217
 
218
+ The message sent by the client when calling ServerReflectionInfo method.
316
219
 
220
+ | Field | Type | Label | Description |
221
+ |-------------------------------|----------------------------------------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
222
+ | host | [string](#string) | | host |
223
+ | file_by_filename | [string](#string) | | Find a proto file by the file name. |
224
+ | file_containing_symbol | [string](#string) | | Find the proto file that declares the given fully-qualified symbol name. This field should be a fully-qualified symbol name (e.g. &lt;package&gt;.&lt;service&gt;[.&lt;method&gt;] or &lt;package&gt;.&lt;type&gt;). |
225
+ | file_containing_extension | [ExtensionRequest](#grpc-reflection-v1-ExtensionRequest) | | Find the proto file which defines an extension extending the given message type with the given field number. |
226
+ | all_extension_numbers_of_type | [string](#string) | | Finds the tag numbers used by all known extensions of the given message type, and appends them to ExtensionNumberResponse in an undefined order. Its corresponding method is best-effort: it&#39;s not guaranteed that the reflection service will implement this method, and it&#39;s not guaranteed that this method will provide all extensions. Returns StatusCode::UNIMPLEMENTED if it&#39;s not implemented. This field should be a fully-qualified type name. The format is &lt;package&gt;.&lt;type&gt; |
227
+ | list_services | [string](#string) | | List the full names of registered services. The content will not be checked. |
317
228
 
318
229
  <a name="grpc-reflection-v1-ServerReflectionResponse"></a>
319
230
 
320
231
  ### ServerReflectionResponse
321
- The message sent by the server to answer ServerReflectionInfo method.
322
-
323
-
324
- | Field | Type | Label | Description |
325
- | ----- | ---- | ----- | ----------- |
326
- | valid_host | [string](#string) | | valid_host |
327
- | original_request | [ServerReflectionRequest](#grpc-reflection-v1-ServerReflectionRequest) | | original_request |
328
- | file_descriptor_response | [FileDescriptorResponse](#grpc-reflection-v1-FileDescriptorResponse) | | This message is used to answer file_by_filename, file_containing_symbol, file_containing_extension requests with transitive dependencies. As the repeated label is not allowed in oneof fields, we use a FileDescriptorResponse message to encapsulate the repeated fields. The reflection service is allowed to avoid sending FileDescriptorProtos that were previously sent in response to earlier requests in the stream. |
329
- | all_extension_numbers_response | [ExtensionNumberResponse](#grpc-reflection-v1-ExtensionNumberResponse) | | This message is used to answer all_extension_numbers_of_type requests. |
330
- | list_services_response | [ListServiceResponse](#grpc-reflection-v1-ListServiceResponse) | | This message is used to answer list_services requests. |
331
- | error_response | [ErrorResponse](#grpc-reflection-v1-ErrorResponse) | | This message is used when an error occurs. |
332
-
333
-
334
-
335
232
 
233
+ The message sent by the server to answer ServerReflectionInfo method.
336
234
 
235
+ | Field | Type | Label | Description |
236
+ |--------------------------------|------------------------------------------------------------------------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
237
+ | valid_host | [string](#string) | | valid_host |
238
+ | original_request | [ServerReflectionRequest](#grpc-reflection-v1-ServerReflectionRequest) | | original_request |
239
+ | file_descriptor_response | [FileDescriptorResponse](#grpc-reflection-v1-FileDescriptorResponse) | | This message is used to answer file_by_filename, file_containing_symbol, file_containing_extension requests with transitive dependencies. As the repeated label is not allowed in oneof fields, we use a FileDescriptorResponse message to encapsulate the repeated fields. The reflection service is allowed to avoid sending FileDescriptorProtos that were previously sent in response to earlier requests in the stream. |
240
+ | all_extension_numbers_response | [ExtensionNumberResponse](#grpc-reflection-v1-ExtensionNumberResponse) | | This message is used to answer all_extension_numbers_of_type requests. |
241
+ | list_services_response | [ListServiceResponse](#grpc-reflection-v1-ListServiceResponse) | | This message is used to answer list_services requests. |
242
+ | error_response | [ErrorResponse](#grpc-reflection-v1-ErrorResponse) | | This message is used when an error occurs. |
337
243
 
338
244
  <a name="grpc-reflection-v1-ServiceResponse"></a>
339
245
 
340
246
  ### ServiceResponse
247
+
341
248
  The information of a single service used by ListServiceResponse to answer
342
249
  list_services request.
343
250
 
344
-
345
- | Field | Type | Label | Description |
346
- | ----- | ---- | ----- | ----------- |
347
- | name | [string](#string) | | Full name of a registered service, including its package name. The format is &lt;package&gt;.&lt;service&gt; |
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
251
+ | Field | Type | Label | Description |
252
+ |-------|-------------------|-------|--------------------------------------------------------------------------------------------------------------|
253
+ | name | [string](#string) | | Full name of a registered service, including its package name. The format is &lt;package&gt;.&lt;service&gt; |
359
254
 
360
255
  <a name="grpc-reflection-v1-ServerReflection"></a>
361
256
 
362
257
  ### ServerReflection
258
+
363
259
  ServerReflection
364
260
  buf:lint:ignore SERVICE_SUFFIX
365
261
 
366
- | Method Name | Request Type | Response Type | Description |
367
- | ----------- | ------------ | ------------- | ------------|
262
+ | Method Name | Request Type | Response Type | Description |
263
+ |----------------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
368
264
  | ServerReflectionInfo | [ServerReflectionRequest](#grpc-reflection-v1-ServerReflectionRequest) stream | [ServerReflectionResponse](#grpc-reflection-v1-ServerReflectionResponse) stream | The reflection service is structured as a bidirectional stream, ensuring all related requests go to a single server. buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME |
369
265
 
370
-
371
-
372
-
373
-
374
266
  <a name="grpc_reflection_v1alpha_reflection-proto"></a>
375
267
  <p align="right"><a href="#top">Top</a></p>
376
268
 
377
269
  ## grpc/reflection/v1alpha/reflection.proto
378
270
 
379
-
380
-
381
271
  <a name="grpc-reflection-v1alpha-ErrorResponse"></a>
382
272
 
383
273
  ### ErrorResponse
384
- The error code and error message sent by the server when an error occurs.
385
-
386
-
387
- | Field | Type | Label | Description |
388
- | ----- | ---- | ----- | ----------- |
389
- | error_code | [int32](#int32) | | This field uses the error codes defined in grpc::StatusCode. |
390
- | error_message | [string](#string) | | error_message |
391
-
392
-
393
-
394
274
 
275
+ The error code and error message sent by the server when an error occurs.
395
276
 
277
+ | Field | Type | Label | Description |
278
+ |---------------|-------------------|-------|--------------------------------------------------------------|
279
+ | error_code | [int32](#int32) | | This field uses the error codes defined in grpc::StatusCode. |
280
+ | error_message | [string](#string) | | error_message |
396
281
 
397
282
  <a name="grpc-reflection-v1alpha-ExtensionNumberResponse"></a>
398
283
 
399
284
  ### ExtensionNumberResponse
285
+
400
286
  A list of extension numbers sent by the server answering
401
287
  all_extension_numbers_of_type request.
402
288
 
403
-
404
- | Field | Type | Label | Description |
405
- | ----- | ---- | ----- | ----------- |
406
- | base_type_name | [string](#string) | | Full name of the base type, including the package name. The format is &lt;package&gt;.&lt;type&gt; |
407
- | extension_number | [int32](#int32) | repeated | extension_number |
408
-
409
-
410
-
411
-
412
-
289
+ | Field | Type | Label | Description |
290
+ |------------------|-------------------|----------|----------------------------------------------------------------------------------------------------|
291
+ | base_type_name | [string](#string) | | Full name of the base type, including the package name. The format is &lt;package&gt;.&lt;type&gt; |
292
+ | extension_number | [int32](#int32) | repeated | extension_number |
413
293
 
414
294
  <a name="grpc-reflection-v1alpha-ExtensionRequest"></a>
415
295
 
416
296
  ### ExtensionRequest
297
+
417
298
  The type name and extension number sent by the client when requesting
418
299
  file_containing_extension.
419
300
 
420
-
421
- | Field | Type | Label | Description |
422
- | ----- | ---- | ----- | ----------- |
423
- | containing_type | [string](#string) | | Fully-qualified type name. The format should be &lt;package&gt;.&lt;type&gt; |
424
- | extension_number | [int32](#int32) | | extension_number |
425
-
426
-
427
-
428
-
429
-
301
+ | Field | Type | Label | Description |
302
+ |------------------|-------------------|-------|------------------------------------------------------------------------------|
303
+ | containing_type | [string](#string) | | Fully-qualified type name. The format should be &lt;package&gt;.&lt;type&gt; |
304
+ | extension_number | [int32](#int32) | | extension_number |
430
305
 
431
306
  <a name="grpc-reflection-v1alpha-FileDescriptorResponse"></a>
432
307
 
433
308
  ### FileDescriptorResponse
309
+
434
310
  Serialized FileDescriptorProto messages sent by the server answering
435
311
  a file_by_filename, file_containing_symbol, or file_containing_extension
436
312
  request.
437
313
 
438
-
439
- | Field | Type | Label | Description |
440
- | ----- | ---- | ----- | ----------- |
314
+ | Field | Type | Label | Description |
315
+ |-----------------------|-----------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
441
316
  | file_descriptor_proto | [bytes](#bytes) | repeated | Serialized FileDescriptorProto messages. We avoid taking a dependency on descriptor.proto, which uses proto2 only features, by making them opaque bytes instead. |
442
317
 
443
-
444
-
445
-
446
-
447
-
448
318
  <a name="grpc-reflection-v1alpha-ListServiceResponse"></a>
449
319
 
450
320
  ### ListServiceResponse
451
- A list of ServiceResponse sent by the server answering list_services request.
452
321
 
322
+ A list of ServiceResponse sent by the server answering list_services request.
453
323
 
454
- | Field | Type | Label | Description |
455
- | ----- | ---- | ----- | ----------- |
324
+ | Field | Type | Label | Description |
325
+ |---------|-------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------|
456
326
  | service | [ServiceResponse](#grpc-reflection-v1alpha-ServiceResponse) | repeated | The information of each service may be expanded in the future, so we use ServiceResponse message to encapsulate it. |
457
327
 
458
-
459
-
460
-
461
-
462
-
463
328
  <a name="grpc-reflection-v1alpha-ServerReflectionRequest"></a>
464
329
 
465
330
  ### ServerReflectionRequest
466
- The message sent by the client when calling ServerReflectionInfo method.
467
-
468
-
469
- | Field | Type | Label | Description |
470
- | ----- | ---- | ----- | ----------- |
471
- | host | [string](#string) | | host |
472
- | file_by_filename | [string](#string) | | Find a proto file by the file name. |
473
- | file_containing_symbol | [string](#string) | | Find the proto file that declares the given fully-qualified symbol name. This field should be a fully-qualified symbol name (e.g. &lt;package&gt;.&lt;service&gt;[.&lt;method&gt;] or &lt;package&gt;.&lt;type&gt;). |
474
- | file_containing_extension | [ExtensionRequest](#grpc-reflection-v1alpha-ExtensionRequest) | | Find the proto file which defines an extension extending the given message type with the given field number. |
475
- | all_extension_numbers_of_type | [string](#string) | | Finds the tag numbers used by all known extensions of the given message type, and appends them to ExtensionNumberResponse in an undefined order. Its corresponding method is best-effort: it&#39;s not guaranteed that the reflection service will implement this method, and it&#39;s not guaranteed that this method will provide all extensions. Returns StatusCode::UNIMPLEMENTED if it&#39;s not implemented. This field should be a fully-qualified type name. The format is &lt;package&gt;.&lt;type&gt; |
476
- | list_services | [string](#string) | | List the full names of registered services. The content will not be checked. |
477
-
478
-
479
-
480
331
 
332
+ The message sent by the client when calling ServerReflectionInfo method.
481
333
 
334
+ | Field | Type | Label | Description |
335
+ |-------------------------------|---------------------------------------------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
336
+ | host | [string](#string) | | host |
337
+ | file_by_filename | [string](#string) | | Find a proto file by the file name. |
338
+ | file_containing_symbol | [string](#string) | | Find the proto file that declares the given fully-qualified symbol name. This field should be a fully-qualified symbol name (e.g. &lt;package&gt;.&lt;service&gt;[.&lt;method&gt;] or &lt;package&gt;.&lt;type&gt;). |
339
+ | file_containing_extension | [ExtensionRequest](#grpc-reflection-v1alpha-ExtensionRequest) | | Find the proto file which defines an extension extending the given message type with the given field number. |
340
+ | all_extension_numbers_of_type | [string](#string) | | Finds the tag numbers used by all known extensions of the given message type, and appends them to ExtensionNumberResponse in an undefined order. Its corresponding method is best-effort: it&#39;s not guaranteed that the reflection service will implement this method, and it&#39;s not guaranteed that this method will provide all extensions. Returns StatusCode::UNIMPLEMENTED if it&#39;s not implemented. This field should be a fully-qualified type name. The format is &lt;package&gt;.&lt;type&gt; |
341
+ | list_services | [string](#string) | | List the full names of registered services. The content will not be checked. |
482
342
 
483
343
  <a name="grpc-reflection-v1alpha-ServerReflectionResponse"></a>
484
344
 
485
345
  ### ServerReflectionResponse
486
- The message sent by the server to answer ServerReflectionInfo method.
487
-
488
-
489
- | Field | Type | Label | Description |
490
- | ----- | ---- | ----- | ----------- |
491
- | valid_host | [string](#string) | | valid_host |
492
- | original_request | [ServerReflectionRequest](#grpc-reflection-v1alpha-ServerReflectionRequest) | | original_request |
493
- | file_descriptor_response | [FileDescriptorResponse](#grpc-reflection-v1alpha-FileDescriptorResponse) | | This message is used to answer file_by_filename, file_containing_symbol, file_containing_extension requests with transitive dependencies. As the repeated label is not allowed in oneof fields, we use a FileDescriptorResponse message to encapsulate the repeated fields. The reflection service is allowed to avoid sending FileDescriptorProtos that were previously sent in response to earlier requests in the stream. |
494
- | all_extension_numbers_response | [ExtensionNumberResponse](#grpc-reflection-v1alpha-ExtensionNumberResponse) | | This message is used to answer all_extension_numbers_of_type requst. |
495
- | list_services_response | [ListServiceResponse](#grpc-reflection-v1alpha-ListServiceResponse) | | This message is used to answer list_services request. |
496
- | error_response | [ErrorResponse](#grpc-reflection-v1alpha-ErrorResponse) | | This message is used when an error occurs. |
497
-
498
-
499
-
500
346
 
347
+ The message sent by the server to answer ServerReflectionInfo method.
501
348
 
349
+ | Field | Type | Label | Description |
350
+ |--------------------------------|-----------------------------------------------------------------------------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
351
+ | valid_host | [string](#string) | | valid_host |
352
+ | original_request | [ServerReflectionRequest](#grpc-reflection-v1alpha-ServerReflectionRequest) | | original_request |
353
+ | file_descriptor_response | [FileDescriptorResponse](#grpc-reflection-v1alpha-FileDescriptorResponse) | | This message is used to answer file_by_filename, file_containing_symbol, file_containing_extension requests with transitive dependencies. As the repeated label is not allowed in oneof fields, we use a FileDescriptorResponse message to encapsulate the repeated fields. The reflection service is allowed to avoid sending FileDescriptorProtos that were previously sent in response to earlier requests in the stream. |
354
+ | all_extension_numbers_response | [ExtensionNumberResponse](#grpc-reflection-v1alpha-ExtensionNumberResponse) | | This message is used to answer all_extension_numbers_of_type requst. |
355
+ | list_services_response | [ListServiceResponse](#grpc-reflection-v1alpha-ListServiceResponse) | | This message is used to answer list_services request. |
356
+ | error_response | [ErrorResponse](#grpc-reflection-v1alpha-ErrorResponse) | | This message is used when an error occurs. |
502
357
 
503
358
  <a name="grpc-reflection-v1alpha-ServiceResponse"></a>
504
359
 
505
360
  ### ServiceResponse
361
+
506
362
  The information of a single service used by ListServiceResponse to answer
507
363
  list_services request.
508
364
 
509
-
510
- | Field | Type | Label | Description |
511
- | ----- | ---- | ----- | ----------- |
512
- | name | [string](#string) | | Full name of a registered service, including its package name. The format is &lt;package&gt;.&lt;service&gt; |
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
-
523
-
365
+ | Field | Type | Label | Description |
366
+ |-------|-------------------|-------|--------------------------------------------------------------------------------------------------------------|
367
+ | name | [string](#string) | | Full name of a registered service, including its package name. The format is &lt;package&gt;.&lt;service&gt; |
524
368
 
525
369
  <a name="grpc-reflection-v1alpha-ServerReflection"></a>
526
370
 
527
371
  ### ServerReflection
372
+
528
373
  ServerReflection
529
374
  buf:lint:ignore SERVICE_SUFFIX
530
375
 
531
- | Method Name | Request Type | Response Type | Description |
532
- | ----------- | ------------ | ------------- | ------------|
376
+ | Method Name | Request Type | Response Type | Description |
377
+ |----------------------|------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
533
378
  | ServerReflectionInfo | [ServerReflectionRequest](#grpc-reflection-v1alpha-ServerReflectionRequest) stream | [ServerReflectionResponse](#grpc-reflection-v1alpha-ServerReflectionResponse) stream | The reflection service is structured as a bidirectional stream, ensuring all related requests go to a single server. buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME |
534
379
 
535
-
536
-
537
-
538
-
539
380
  ## Scalar Value Types
540
381
 
541
- | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
542
- | ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
543
- | <a name="double" /> double | | double | double | float | float64 | double | float | Float |
544
- | <a name="float" /> float | | float | float | float | float32 | float | float | Float |
545
- | <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
546
- | <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
547
- | <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
548
- | <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
549
- | <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
550
- | <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
551
- | <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
552
- | <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
553
- | <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
554
- | <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
555
- | <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
556
- | <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
557
- | <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
382
+ | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
383
+ |--------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------|------------|-------------|---------|------------|----------------|--------------------------------|
384
+ | <a name="double" /> double | | double | double | float | float64 | double | float | Float |
385
+ | <a name="float" /> float | | float | float | float | float32 | float | float | Float |
386
+ | <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
387
+ | <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
388
+ | <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
389
+ | <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
390
+ | <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
391
+ | <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
392
+ | <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
393
+ | <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
394
+ | <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
395
+ | <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
396
+ | <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
397
+ | <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
398
+ | <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
558
399