forked from timostamm/protobuf-ts
-
Notifications
You must be signed in to change notification settings - Fork 0
/
descriptor.ts
1846 lines (1841 loc) · 74.1 KB
/
descriptor.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// @generated by protobuf-ts 1.0.0-alpha.35 with parameters force_optimize_code_size,long_type_string
// @generated from protobuf file "google/protobuf/descriptor.proto" (package "google.protobuf", syntax proto2)
// tslint:disable
//
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc. All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//
// Author: kenton@google.com (Kenton Varda)
// Based on original Protocol Buffers design by
// Sanjay Ghemawat, Jeff Dean, and others.
//
// The messages in this file describe the definitions found in .proto files.
// A valid .proto file can be translated directly to a FileDescriptorProto
// without any other information (e.g. without reading its imports).
//
import { ScalarType } from "@protobuf-ts/runtime";
import { RepeatType } from "@protobuf-ts/runtime";
import { MessageType } from "@protobuf-ts/runtime";
/**
* The protocol compiler can output a FileDescriptorSet containing the .proto
* files it parses.
*
* @generated from protobuf message google.protobuf.FileDescriptorSet
*/
export interface FileDescriptorSet {
/**
* @generated from protobuf field: repeated google.protobuf.FileDescriptorProto file = 1;
*/
file: FileDescriptorProto[];
}
/**
* Describes a complete .proto file.
*
* @generated from protobuf message google.protobuf.FileDescriptorProto
*/
export interface FileDescriptorProto {
/**
* @generated from protobuf field: optional string name = 1;
*/
name?: string; // file name, relative to root of source tree
/**
* @generated from protobuf field: optional string package = 2;
*/
package?: string; // e.g. "foo", "foo.bar", etc.
/**
* Names of files imported by this file.
*
* @generated from protobuf field: repeated string dependency = 3;
*/
dependency: string[];
/**
* Indexes of the public imported files in the dependency list above.
*
* @generated from protobuf field: repeated int32 public_dependency = 10;
*/
publicDependency: number[];
/**
* Indexes of the weak imported files in the dependency list.
* For Google-internal migration only. Do not use.
*
* @generated from protobuf field: repeated int32 weak_dependency = 11;
*/
weakDependency: number[];
/**
* All top-level definitions in this file.
*
* @generated from protobuf field: repeated google.protobuf.DescriptorProto message_type = 4;
*/
messageType: DescriptorProto[];
/**
* @generated from protobuf field: repeated google.protobuf.EnumDescriptorProto enum_type = 5;
*/
enumType: EnumDescriptorProto[];
/**
* @generated from protobuf field: repeated google.protobuf.ServiceDescriptorProto service = 6;
*/
service: ServiceDescriptorProto[];
/**
* @generated from protobuf field: repeated google.protobuf.FieldDescriptorProto extension = 7;
*/
extension: FieldDescriptorProto[];
/**
* @generated from protobuf field: optional google.protobuf.FileOptions options = 8;
*/
options?: FileOptions;
/**
* This field contains optional information about the original source code.
* You may safely remove this entire field without harming runtime
* functionality of the descriptors -- the information is needed only by
* development tools.
*
* @generated from protobuf field: optional google.protobuf.SourceCodeInfo source_code_info = 9;
*/
sourceCodeInfo?: SourceCodeInfo;
/**
* The syntax of the proto file.
* The supported values are "proto2" and "proto3".
*
* @generated from protobuf field: optional string syntax = 12;
*/
syntax?: string;
}
/**
* Describes a message type.
*
* @generated from protobuf message google.protobuf.DescriptorProto
*/
export interface DescriptorProto {
/**
* @generated from protobuf field: optional string name = 1;
*/
name?: string;
/**
* @generated from protobuf field: repeated google.protobuf.FieldDescriptorProto field = 2;
*/
field: FieldDescriptorProto[];
/**
* @generated from protobuf field: repeated google.protobuf.FieldDescriptorProto extension = 6;
*/
extension: FieldDescriptorProto[];
/**
* @generated from protobuf field: repeated google.protobuf.DescriptorProto nested_type = 3;
*/
nestedType: DescriptorProto[];
/**
* @generated from protobuf field: repeated google.protobuf.EnumDescriptorProto enum_type = 4;
*/
enumType: EnumDescriptorProto[];
/**
* @generated from protobuf field: repeated google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;
*/
extensionRange: DescriptorProto_ExtensionRange[];
/**
* @generated from protobuf field: repeated google.protobuf.OneofDescriptorProto oneof_decl = 8;
*/
oneofDecl: OneofDescriptorProto[];
/**
* @generated from protobuf field: optional google.protobuf.MessageOptions options = 7;
*/
options?: MessageOptions;
/**
* @generated from protobuf field: repeated google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;
*/
reservedRange: DescriptorProto_ReservedRange[];
/**
* Reserved field names, which may not be used by fields in the same message.
* A given name may only be reserved once.
*
* @generated from protobuf field: repeated string reserved_name = 10;
*/
reservedName: string[];
}
/**
* @generated from protobuf message google.protobuf.DescriptorProto.ExtensionRange
*/
export interface DescriptorProto_ExtensionRange {
/**
* @generated from protobuf field: optional int32 start = 1;
*/
start?: number; // Inclusive.
/**
* @generated from protobuf field: optional int32 end = 2;
*/
end?: number; // Exclusive.
/**
* @generated from protobuf field: optional google.protobuf.ExtensionRangeOptions options = 3;
*/
options?: ExtensionRangeOptions;
}
/**
* Range of reserved tag numbers. Reserved tag numbers may not be used by
* fields or extension ranges in the same message. Reserved ranges may
* not overlap.
*
* @generated from protobuf message google.protobuf.DescriptorProto.ReservedRange
*/
export interface DescriptorProto_ReservedRange {
/**
* @generated from protobuf field: optional int32 start = 1;
*/
start?: number; // Inclusive.
/**
* @generated from protobuf field: optional int32 end = 2;
*/
end?: number; // Exclusive.
}
/**
* @generated from protobuf message google.protobuf.ExtensionRangeOptions
*/
export interface ExtensionRangeOptions {
/**
* The parser stores options it doesn't recognize here. See above.
*
* @generated from protobuf field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
*/
uninterpretedOption: UninterpretedOption[];
}
/**
* Describes a field within a message.
*
* @generated from protobuf message google.protobuf.FieldDescriptorProto
*/
export interface FieldDescriptorProto {
/**
* @generated from protobuf field: optional string name = 1;
*/
name?: string;
/**
* @generated from protobuf field: optional int32 number = 3;
*/
number?: number;
/**
* @generated from protobuf field: optional google.protobuf.FieldDescriptorProto.Label label = 4;
*/
label?: FieldDescriptorProto_Label;
/**
* If type_name is set, this need not be set. If both this and type_name
* are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
*
* @generated from protobuf field: optional google.protobuf.FieldDescriptorProto.Type type = 5;
*/
type?: FieldDescriptorProto_Type;
/**
* For message and enum types, this is the name of the type. If the name
* starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
* rules are used to find the type (i.e. first the nested types within this
* message are searched, then within the parent, on up to the root
* namespace).
*
* @generated from protobuf field: optional string type_name = 6;
*/
typeName?: string;
/**
* For extensions, this is the name of the type being extended. It is
* resolved in the same manner as type_name.
*
* @generated from protobuf field: optional string extendee = 2;
*/
extendee?: string;
/**
* For numeric types, contains the original text representation of the value.
* For booleans, "true" or "false".
* For strings, contains the default text contents (not escaped in any way).
* For bytes, contains the C escaped value. All bytes >= 128 are escaped.
* TODO(kenton): Base-64 encode?
*
* @generated from protobuf field: optional string default_value = 7;
*/
defaultValue?: string;
/**
* If set, gives the index of a oneof in the containing type's oneof_decl
* list. This field is a member of that oneof.
*
* @generated from protobuf field: optional int32 oneof_index = 9;
*/
oneofIndex?: number;
/**
* JSON name of this field. The value is set by protocol compiler. If the
* user has set a "json_name" option on this field, that option's value
* will be used. Otherwise, it's deduced from the field's name by converting
* it to camelCase.
*
* @generated from protobuf field: optional string json_name = 10;
*/
jsonName?: string;
/**
* @generated from protobuf field: optional google.protobuf.FieldOptions options = 8;
*/
options?: FieldOptions;
/**
* If true, this is a proto3 "optional". When a proto3 field is optional, it
* tracks presence regardless of field type.
*
* When proto3_optional is true, this field must be belong to a oneof to
* signal to old proto3 clients that presence is tracked for this field. This
* oneof is known as a "synthetic" oneof, and this field must be its sole
* member (each proto3 optional field gets its own synthetic oneof). Synthetic
* oneofs exist in the descriptor only, and do not generate any API. Synthetic
* oneofs must be ordered after all "real" oneofs.
*
* For message fields, proto3_optional doesn't create any semantic change,
* since non-repeated message fields always track presence. However it still
* indicates the semantic detail of whether the user wrote "optional" or not.
* This can be useful for round-tripping the .proto file. For consistency we
* give message fields a synthetic oneof also, even though it is not required
* to track presence. This is especially important because the parser can't
* tell if a field is a message or an enum, so it must always create a
* synthetic oneof.
*
* Proto2 optional fields do not set this flag, because they already indicate
* optional with `LABEL_OPTIONAL`.
*
* @generated from protobuf field: optional bool proto3_optional = 17;
*/
proto3Optional?: boolean;
}
/**
* @generated from protobuf enum google.protobuf.FieldDescriptorProto.Type
*/
export enum FieldDescriptorProto_Type {
/**
* @generated synthetic value - protobuf-ts requires all enums to have a 0 value
*/
UNSPECIFIED$ = 0,
/**
* 0 is reserved for errors.
* Order is weird for historical reasons.
*
* @generated from protobuf enum value: TYPE_DOUBLE = 1;
*/
DOUBLE = 1,
/**
* @generated from protobuf enum value: TYPE_FLOAT = 2;
*/
FLOAT = 2,
/**
* Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if
* negative values are likely.
*
* @generated from protobuf enum value: TYPE_INT64 = 3;
*/
INT64 = 3,
/**
* @generated from protobuf enum value: TYPE_UINT64 = 4;
*/
UINT64 = 4,
/**
* Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if
* negative values are likely.
*
* @generated from protobuf enum value: TYPE_INT32 = 5;
*/
INT32 = 5,
/**
* @generated from protobuf enum value: TYPE_FIXED64 = 6;
*/
FIXED64 = 6,
/**
* @generated from protobuf enum value: TYPE_FIXED32 = 7;
*/
FIXED32 = 7,
/**
* @generated from protobuf enum value: TYPE_BOOL = 8;
*/
BOOL = 8,
/**
* @generated from protobuf enum value: TYPE_STRING = 9;
*/
STRING = 9,
/**
* Tag-delimited aggregate.
* Group type is deprecated and not supported in proto3. However, Proto3
* implementations should still be able to parse the group wire format and
* treat group fields as unknown fields.
*
* @generated from protobuf enum value: TYPE_GROUP = 10;
*/
GROUP = 10,
/**
* Length-delimited aggregate.
*
* @generated from protobuf enum value: TYPE_MESSAGE = 11;
*/
MESSAGE = 11,
/**
* New in version 2.
*
* @generated from protobuf enum value: TYPE_BYTES = 12;
*/
BYTES = 12,
/**
* @generated from protobuf enum value: TYPE_UINT32 = 13;
*/
UINT32 = 13,
/**
* @generated from protobuf enum value: TYPE_ENUM = 14;
*/
ENUM = 14,
/**
* @generated from protobuf enum value: TYPE_SFIXED32 = 15;
*/
SFIXED32 = 15,
/**
* @generated from protobuf enum value: TYPE_SFIXED64 = 16;
*/
SFIXED64 = 16,
/**
* Uses ZigZag encoding.
*
* @generated from protobuf enum value: TYPE_SINT32 = 17;
*/
SINT32 = 17,
/**
* Uses ZigZag encoding.
*
* @generated from protobuf enum value: TYPE_SINT64 = 18;
*/
SINT64 = 18
}
/**
* @generated from protobuf enum google.protobuf.FieldDescriptorProto.Label
*/
export enum FieldDescriptorProto_Label {
/**
* @generated synthetic value - protobuf-ts requires all enums to have a 0 value
*/
UNSPECIFIED$ = 0,
/**
* 0 is reserved for errors
*
* @generated from protobuf enum value: LABEL_OPTIONAL = 1;
*/
OPTIONAL = 1,
/**
* @generated from protobuf enum value: LABEL_REQUIRED = 2;
*/
REQUIRED = 2,
/**
* @generated from protobuf enum value: LABEL_REPEATED = 3;
*/
REPEATED = 3
}
/**
* Describes a oneof.
*
* @generated from protobuf message google.protobuf.OneofDescriptorProto
*/
export interface OneofDescriptorProto {
/**
* @generated from protobuf field: optional string name = 1;
*/
name?: string;
/**
* @generated from protobuf field: optional google.protobuf.OneofOptions options = 2;
*/
options?: OneofOptions;
}
/**
* Describes an enum type.
*
* @generated from protobuf message google.protobuf.EnumDescriptorProto
*/
export interface EnumDescriptorProto {
/**
* @generated from protobuf field: optional string name = 1;
*/
name?: string;
/**
* @generated from protobuf field: repeated google.protobuf.EnumValueDescriptorProto value = 2;
*/
value: EnumValueDescriptorProto[];
/**
* @generated from protobuf field: optional google.protobuf.EnumOptions options = 3;
*/
options?: EnumOptions;
/**
* Range of reserved numeric values. Reserved numeric values may not be used
* by enum values in the same enum declaration. Reserved ranges may not
* overlap.
*
* @generated from protobuf field: repeated google.protobuf.EnumDescriptorProto.EnumReservedRange reserved_range = 4;
*/
reservedRange: EnumDescriptorProto_EnumReservedRange[];
/**
* Reserved enum value names, which may not be reused. A given name may only
* be reserved once.
*
* @generated from protobuf field: repeated string reserved_name = 5;
*/
reservedName: string[];
}
/**
* Range of reserved numeric values. Reserved values may not be used by
* entries in the same enum. Reserved ranges may not overlap.
*
* Note that this is distinct from DescriptorProto.ReservedRange in that it
* is inclusive such that it can appropriately represent the entire int32
* domain.
*
* @generated from protobuf message google.protobuf.EnumDescriptorProto.EnumReservedRange
*/
export interface EnumDescriptorProto_EnumReservedRange {
/**
* @generated from protobuf field: optional int32 start = 1;
*/
start?: number; // Inclusive.
/**
* @generated from protobuf field: optional int32 end = 2;
*/
end?: number; // Inclusive.
}
/**
* Describes a value within an enum.
*
* @generated from protobuf message google.protobuf.EnumValueDescriptorProto
*/
export interface EnumValueDescriptorProto {
/**
* @generated from protobuf field: optional string name = 1;
*/
name?: string;
/**
* @generated from protobuf field: optional int32 number = 2;
*/
number?: number;
/**
* @generated from protobuf field: optional google.protobuf.EnumValueOptions options = 3;
*/
options?: EnumValueOptions;
}
/**
* Describes a service.
*
* @generated from protobuf message google.protobuf.ServiceDescriptorProto
*/
export interface ServiceDescriptorProto {
/**
* @generated from protobuf field: optional string name = 1;
*/
name?: string;
/**
* @generated from protobuf field: repeated google.protobuf.MethodDescriptorProto method = 2;
*/
method: MethodDescriptorProto[];
/**
* @generated from protobuf field: optional google.protobuf.ServiceOptions options = 3;
*/
options?: ServiceOptions;
}
/**
* Describes a method of a service.
*
* @generated from protobuf message google.protobuf.MethodDescriptorProto
*/
export interface MethodDescriptorProto {
/**
* @generated from protobuf field: optional string name = 1;
*/
name?: string;
/**
* Input and output type names. These are resolved in the same way as
* FieldDescriptorProto.type_name, but must refer to a message type.
*
* @generated from protobuf field: optional string input_type = 2;
*/
inputType?: string;
/**
* @generated from protobuf field: optional string output_type = 3;
*/
outputType?: string;
/**
* @generated from protobuf field: optional google.protobuf.MethodOptions options = 4;
*/
options?: MethodOptions;
/**
* Identifies if client streams multiple client messages
*
* @generated from protobuf field: optional bool client_streaming = 5;
*/
clientStreaming?: boolean;
/**
* Identifies if server streams multiple server messages
*
* @generated from protobuf field: optional bool server_streaming = 6;
*/
serverStreaming?: boolean;
}
// ===================================================================
// Options
// Each of the definitions above may have "options" attached. These are
// just annotations which may cause code to be generated slightly differently
// or may contain hints for code that manipulates protocol messages.
//
// Clients may define custom options as extensions of the *Options messages.
// These extensions may not yet be known at parsing time, so the parser cannot
// store the values in them. Instead it stores them in a field in the *Options
// message called uninterpreted_option. This field must have the same name
// across all *Options messages. We then use this field to populate the
// extensions when we build a descriptor, at which point all protos have been
// parsed and so all extensions are known.
//
// Extension numbers for custom options may be chosen as follows:
// * For options which will only be used within a single application or
// organization, or for experimental options, use field numbers 50000
// through 99999. It is up to you to ensure that you do not use the
// same number for multiple options.
// * For options which will be published and used publicly by multiple
// independent entities, e-mail protobuf-global-extension-registry@google.com
// to reserve extension numbers. Simply provide your project name (e.g.
// Objective-C plugin) and your project website (if available) -- there's no
// need to explain how you intend to use them. Usually you only need one
// extension number. You can declare multiple options with only one extension
// number by putting them in a sub-message. See the Custom Options section of
// the docs for examples:
// https://developers.google.com/protocol-buffers/docs/proto#options
// If this turns out to be popular, a web service will be set up
// to automatically assign option numbers.
/**
* @generated from protobuf message google.protobuf.FileOptions
*/
export interface FileOptions {
/**
* Sets the Java package where classes generated from this .proto will be
* placed. By default, the proto package is used, but this is often
* inappropriate because proto packages do not normally start with backwards
* domain names.
*
* @generated from protobuf field: optional string java_package = 1;
*/
javaPackage?: string;
/**
* If set, all the classes from the .proto file are wrapped in a single
* outer class with the given name. This applies to both Proto1
* (equivalent to the old "--one_java_file" option) and Proto2 (where
* a .proto always translates to a single class, but you may want to
* explicitly choose the class name).
*
* @generated from protobuf field: optional string java_outer_classname = 8;
*/
javaOuterClassname?: string;
/**
* If set true, then the Java code generator will generate a separate .java
* file for each top-level message, enum, and service defined in the .proto
* file. Thus, these types will *not* be nested inside the outer class
* named by java_outer_classname. However, the outer class will still be
* generated to contain the file's getDescriptor() method as well as any
* top-level extensions defined in the file.
*
* @generated from protobuf field: optional bool java_multiple_files = 10;
*/
javaMultipleFiles?: boolean;
/**
* This option does nothing.
*
* @deprecated
* @generated from protobuf field: optional bool java_generate_equals_and_hash = 20 [deprecated = true];
*/
javaGenerateEqualsAndHash?: boolean;
/**
* If set true, then the Java2 code generator will generate code that
* throws an exception whenever an attempt is made to assign a non-UTF-8
* byte sequence to a string field.
* Message reflection will do the same.
* However, an extension field still accepts non-UTF-8 byte sequences.
* This option has no effect on when used with the lite runtime.
*
* @generated from protobuf field: optional bool java_string_check_utf8 = 27;
*/
javaStringCheckUtf8?: boolean;
/**
* @generated from protobuf field: optional google.protobuf.FileOptions.OptimizeMode optimize_for = 9;
*/
optimizeFor?: FileOptions_OptimizeMode;
/**
* Sets the Go package where structs generated from this .proto will be
* placed. If omitted, the Go package will be derived from the following:
* - The basename of the package import path, if provided.
* - Otherwise, the package statement in the .proto file, if present.
* - Otherwise, the basename of the .proto file, without extension.
*
* @generated from protobuf field: optional string go_package = 11;
*/
goPackage?: string;
/**
* Should generic services be generated in each language? "Generic" services
* are not specific to any particular RPC system. They are generated by the
* main code generators in each language (without additional plugins).
* Generic services were the only kind of service generation supported by
* early versions of google.protobuf.
*
* Generic services are now considered deprecated in favor of using plugins
* that generate code specific to your particular RPC system. Therefore,
* these default to false. Old code which depends on generic services should
* explicitly set them to true.
*
* @generated from protobuf field: optional bool cc_generic_services = 16;
*/
ccGenericServices?: boolean;
/**
* @generated from protobuf field: optional bool java_generic_services = 17;
*/
javaGenericServices?: boolean;
/**
* @generated from protobuf field: optional bool py_generic_services = 18;
*/
pyGenericServices?: boolean;
/**
* @generated from protobuf field: optional bool php_generic_services = 42;
*/
phpGenericServices?: boolean;
/**
* Is this file deprecated?
* Depending on the target platform, this can emit Deprecated annotations
* for everything in the file, or it will be completely ignored; in the very
* least, this is a formalization for deprecating files.
*
* @generated from protobuf field: optional bool deprecated = 23;
*/
deprecated?: boolean;
/**
* Enables the use of arenas for the proto messages in this file. This applies
* only to generated classes for C++.
*
* @generated from protobuf field: optional bool cc_enable_arenas = 31;
*/
ccEnableArenas?: boolean;
/**
* Sets the objective c class prefix which is prepended to all objective c
* generated classes from this .proto. There is no default.
*
* @generated from protobuf field: optional string objc_class_prefix = 36;
*/
objcClassPrefix?: string;
/**
* Namespace for generated classes; defaults to the package.
*
* @generated from protobuf field: optional string csharp_namespace = 37;
*/
csharpNamespace?: string;
/**
* By default Swift generators will take the proto package and CamelCase it
* replacing '.' with underscore and use that to prefix the types/symbols
* defined. When this options is provided, they will use this value instead
* to prefix the types/symbols defined.
*
* @generated from protobuf field: optional string swift_prefix = 39;
*/
swiftPrefix?: string;
/**
* Sets the php class prefix which is prepended to all php generated classes
* from this .proto. Default is empty.
*
* @generated from protobuf field: optional string php_class_prefix = 40;
*/
phpClassPrefix?: string;
/**
* Use this option to change the namespace of php generated classes. Default
* is empty. When this option is empty, the package name will be used for
* determining the namespace.
*
* @generated from protobuf field: optional string php_namespace = 41;
*/
phpNamespace?: string;
/**
* Use this option to change the namespace of php generated metadata classes.
* Default is empty. When this option is empty, the proto file name will be
* used for determining the namespace.
*
* @generated from protobuf field: optional string php_metadata_namespace = 44;
*/
phpMetadataNamespace?: string;
/**
* Use this option to change the package of ruby generated classes. Default
* is empty. When this option is not set, the package name will be used for
* determining the ruby package.
*
* @generated from protobuf field: optional string ruby_package = 45;
*/
rubyPackage?: string;
/**
* The parser stores options it doesn't recognize here.
* See the documentation for the "Options" section above.
*
* @generated from protobuf field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
*/
uninterpretedOption: UninterpretedOption[];
}
/**
* Generated classes can be optimized for speed or code size.
*
* @generated from protobuf enum google.protobuf.FileOptions.OptimizeMode
*/
export enum FileOptions_OptimizeMode {
/**
* @generated synthetic value - protobuf-ts requires all enums to have a 0 value
*/
UNSPECIFIED$ = 0,
/**
* Generate complete code for parsing, serialization,
*
* @generated from protobuf enum value: SPEED = 1;
*/
SPEED = 1,
/**
* etc.
*
* Use ReflectionOps to implement these methods.
*
* @generated from protobuf enum value: CODE_SIZE = 2;
*/
CODE_SIZE = 2,
/**
* Generate code using MessageLite and the lite runtime.
*
* @generated from protobuf enum value: LITE_RUNTIME = 3;
*/
LITE_RUNTIME = 3
}
/**
* @generated from protobuf message google.protobuf.MessageOptions
*/
export interface MessageOptions {
/**
* Set true to use the old proto1 MessageSet wire format for extensions.
* This is provided for backwards-compatibility with the MessageSet wire
* format. You should not use this for any other reason: It's less
* efficient, has fewer features, and is more complicated.
*
* The message must be defined exactly as follows:
* message Foo {
* option message_set_wire_format = true;
* extensions 4 to max;
* }
* Note that the message cannot have any defined fields; MessageSets only
* have extensions.
*
* All extensions of your type must be singular messages; e.g. they cannot
* be int32s, enums, or repeated messages.
*
* Because this is an option, the above two restrictions are not enforced by
* the protocol compiler.
*
* @generated from protobuf field: optional bool message_set_wire_format = 1;
*/
messageSetWireFormat?: boolean;
/**
* Disables the generation of the standard "descriptor()" accessor, which can
* conflict with a field of the same name. This is meant to make migration
* from proto1 easier; new code should avoid fields named "descriptor".
*
* @generated from protobuf field: optional bool no_standard_descriptor_accessor = 2;
*/
noStandardDescriptorAccessor?: boolean;
/**
* Is this message deprecated?
* Depending on the target platform, this can emit Deprecated annotations
* for the message, or it will be completely ignored; in the very least,
* this is a formalization for deprecating messages.
*
* @generated from protobuf field: optional bool deprecated = 3;
*/
deprecated?: boolean;
/**
* Whether the message is an automatically generated map entry type for the
* maps field.
*
* For maps fields:
* map<KeyType, ValueType> map_field = 1;
* The parsed descriptor looks like:
* message MapFieldEntry {
* option map_entry = true;
* optional KeyType key = 1;
* optional ValueType value = 2;
* }
* repeated MapFieldEntry map_field = 1;
*
* Implementations may choose not to generate the map_entry=true message, but
* use a native map in the target language to hold the keys and values.
* The reflection APIs in such implementations still need to work as
* if the field is a repeated message field.
*
* NOTE: Do not set the option in .proto files. Always use the maps syntax
* instead. The option should only be implicitly set by the proto compiler
* parser.
*
* @generated from protobuf field: optional bool map_entry = 7;
*/
mapEntry?: boolean;
/**
* The parser stores options it doesn't recognize here. See above.
*
* @generated from protobuf field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
*/
uninterpretedOption: UninterpretedOption[];
}
/**
* @generated from protobuf message google.protobuf.FieldOptions
*/
export interface FieldOptions {
/**
* The ctype option instructs the C++ code generator to use a different
* representation of the field than it normally would. See the specific
* options below. This option is not yet implemented in the open source
* release -- sorry, we'll try to include it in a future version!
*
* @generated from protobuf field: optional google.protobuf.FieldOptions.CType ctype = 1;
*/
ctype?: FieldOptions_CType;
/**
* The packed option can be enabled for repeated primitive fields to enable
* a more efficient representation on the wire. Rather than repeatedly
* writing the tag and type for each element, the entire array is encoded as
* a single length-delimited blob. In proto3, only explicit setting it to
* false will avoid using packed encoding.
*
* @generated from protobuf field: optional bool packed = 2;
*/
packed?: boolean;
/**
* The jstype option determines the JavaScript type used for values of the
* field. The option is permitted only for 64 bit integral and fixed types
* (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
* is represented as JavaScript string, which avoids loss of precision that
* can happen when a large value is converted to a floating point JavaScript.
* Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
* use the JavaScript "number" type. The behavior of the default option
* JS_NORMAL is implementation dependent.
*
* This option is an enum to permit additional types to be added, e.g.
* goog.math.Integer.
*
* @generated from protobuf field: optional google.protobuf.FieldOptions.JSType jstype = 6;
*/
jstype?: FieldOptions_JSType;
/**
* Should this field be parsed lazily? Lazy applies only to message-type
* fields. It means that when the outer message is initially parsed, the
* inner message's contents will not be parsed but instead stored in encoded
* form. The inner message will actually be parsed when it is first accessed.
*
* This is only a hint. Implementations are free to choose whether to use
* eager or lazy parsing regardless of the value of this option. However,
* setting this option true suggests that the protocol author believes that
* using lazy parsing on this field is worth the additional bookkeeping
* overhead typically needed to implement it.
*
* This option does not affect the public interface of any generated code;
* all method signatures remain the same. Furthermore, thread-safety of the
* interface is not affected by this option; const methods remain safe to
* call from multiple threads concurrently, while non-const methods continue
* to require exclusive access.
*
*
* Note that implementations may choose not to check required fields within
* a lazy sub-message. That is, calling IsInitialized() on the outer message
* may return true even if the inner message has missing required fields.
* This is necessary because otherwise the inner message would have to be
* parsed in order to perform the check, defeating the purpose of lazy
* parsing. An implementation which chooses not to check required fields
* must be consistent about it. That is, for any particular sub-message, the
* implementation must either *always* check its required fields, or *never*
* check its required fields, regardless of whether or not the message has
* been parsed.
*
* @generated from protobuf field: optional bool lazy = 5;
*/
lazy?: boolean;
/**
* Is this field deprecated?
* Depending on the target platform, this can emit Deprecated annotations
* for accessors, or it will be completely ignored; in the very least, this
* is a formalization for deprecating fields.
*
* @generated from protobuf field: optional bool deprecated = 3;
*/
deprecated?: boolean;
/**
* For Google-internal migration only. Do not use.
*
* @generated from protobuf field: optional bool weak = 10;
*/
weak?: boolean;
/**
* The parser stores options it doesn't recognize here. See above.
*
* @generated from protobuf field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
*/
uninterpretedOption: UninterpretedOption[];
}
/**