api/google/descriptor library

Reexport of generated resources for the gRPC descriptor library.

Classes

DescriptorProto
Describes a message type.
DescriptorProto_ExtensionRange
DescriptorProto_ReservedRange
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.
Edition
The full set of known editions.
EnumDescriptorProto
Describes an enum type.
EnumDescriptorProto_EnumReservedRange
Range of reserved numeric values. Reserved values may not be used by entries in the same enum. Reserved ranges may not overlap.
EnumOptions
EnumValueDescriptorProto
Describes a value within an enum.
EnumValueOptions
ExtensionRangeOptions
ExtensionRangeOptions_Declaration
ExtensionRangeOptions_VerificationState
The verification state of the extension range.
FeatureSet
TODO Enums in C++ gencode (and potentially other languages) are not well scoped. This means that each of the feature enums below can clash with each other. The short names we've chosen maximize call-site readability, but leave us very open to this scenario. A future feature will be designed and implemented to handle this, hopefully before we ever hit a conflict here.
FeatureSet_EnumType
FeatureSet_FieldPresence
FeatureSet_JsonFormat
FeatureSet_MessageEncoding
FeatureSet_RepeatedFieldEncoding
FeatureSet_Utf8Validation
FeatureSetDefaults
A compiled specification for the defaults of a set of features. These messages are generated from FeatureSet extensions and can be used to seed feature resolution. The resolution with this object becomes a simple search for the closest matching edition, followed by proto merges.
FeatureSetDefaults_FeatureSetEditionDefault
A map from every known edition with a unique set of defaults to its defaults. Not all editions may be contained here. For a given edition, the defaults at the closest matching edition ordered at or before it should be used. This field must be in strict ascending order by edition.
FieldDescriptorProto
Describes a field within a message.
FieldDescriptorProto_Label
FieldDescriptorProto_Type
FieldOptions
FieldOptions_CType
FieldOptions_EditionDefault
FieldOptions_JSType
FieldOptions_OptionRetention
If set to RETENTION_SOURCE, the option will be omitted from the binary. Note: as of January 2023, support for this is in progress and does not yet have an effect (b/264593489).
FieldOptions_OptionTargetType
This indicates the types of entities that the field may apply to when used as an option. If it is unset, then the field may be freely used as an option on any kind of entity. Note: as of January 2023, support for this is in progress and does not yet have an effect (b/264593489).
FileDescriptorProto
Describes a complete .proto file.
FileDescriptorSet
The protocol compiler can output a FileDescriptorSet containing the .proto files it parses.
FileOptions
FileOptions_OptimizeMode
Generated classes can be optimized for speed or code size.
GeneratedCodeInfo
Describes the relationship between generated code and its original source file. A GeneratedCodeInfo message is associated with only one generated source file, but may contain references to different source .proto files.
GeneratedCodeInfo_Annotation
GeneratedCodeInfo_Annotation_Semantic
Represents the identified object's effect on the element in the original .proto file.
MessageOptions
MethodDescriptorProto
Describes a method of a service.
MethodOptions
MethodOptions_IdempotencyLevel
Is this method side-effect-free (or safe in HTTP parlance), or idempotent, or neither? HTTP based RPC implementation may choose GET verb for safe methods, and PUT verb for idempotent methods instead of the default POST.
OneofDescriptorProto
Describes a oneof.
OneofOptions
ServiceDescriptorProto
Describes a service.
ServiceOptions
SourceCodeInfo
Encapsulates information about the original source file from which a FileDescriptorProto was generated.
SourceCodeInfo_Location
UninterpretedOption
A message representing a option the parser does not recognize. This only appears in options protos created by the compiler::Parser class. DescriptorPool resolves these when building Descriptor objects. Therefore, options protos in descriptor objects (e.g. returned by Descriptor::options(), or produced by Descriptor::CopyTo()) will never have UninterpretedOptions in them.
UninterpretedOption_NamePart
The name of the uninterpreted option. Each string represents a segment in a dot-separated name. is_extension is true iff a segment represents an extension (denoted with parentheses in options specs in .proto files). E.g.,{ "foo", false, "bar.baz", true, "moo", false } represents "foo.(bar.baz).moo".

Constants

DescriptorProto$json → const Map<String, Object>
DescriptorProto_ExtensionRange$json → const Map<String, Object>
DescriptorProto_ReservedRange$json → const Map<String, Object>
Edition$json → const Map<String, Object>
EnumDescriptorProto$json → const Map<String, Object>
EnumDescriptorProto_EnumReservedRange$json → const Map<String, Object>
EnumOptions$json → const Map<String, Object>
EnumValueDescriptorProto$json → const Map<String, Object>
EnumValueOptions$json → const Map<String, Object>
ExtensionRangeOptions$json → const Map<String, Object>
ExtensionRangeOptions_Declaration$json → const Map<String, Object>
ExtensionRangeOptions_VerificationState$json → const Map<String, Object>
FeatureSet$json → const Map<String, Object>
FeatureSet_EnumType$json → const Map<String, Object>
FeatureSet_FieldPresence$json → const Map<String, Object>
FeatureSet_JsonFormat$json → const Map<String, Object>
FeatureSet_MessageEncoding$json → const Map<String, Object>
FeatureSet_RepeatedFieldEncoding$json → const Map<String, Object>
FeatureSet_Utf8Validation$json → const Map<String, Object>
FeatureSetDefaults$json → const Map<String, Object>
FeatureSetDefaults_FeatureSetEditionDefault$json → const Map<String, Object>
FieldDescriptorProto$json → const Map<String, Object>
FieldDescriptorProto_Label$json → const Map<String, Object>
FieldDescriptorProto_Type$json → const Map<String, Object>
FieldOptions$json → const Map<String, Object>
FieldOptions_CType$json → const Map<String, Object>
FieldOptions_EditionDefault$json → const Map<String, Object>
FieldOptions_JSType$json → const Map<String, Object>
FieldOptions_OptionRetention$json → const Map<String, Object>
FieldOptions_OptionTargetType$json → const Map<String, Object>
FileDescriptorProto$json → const Map<String, Object>
FileDescriptorSet$json → const Map<String, Object>
FileOptions$json → const Map<String, Object>
FileOptions_OptimizeMode$json → const Map<String, Object>
GeneratedCodeInfo$json → const Map<String, Object>
GeneratedCodeInfo_Annotation$json → const Map<String, Object>
GeneratedCodeInfo_Annotation_Semantic$json → const Map<String, Object>
MessageOptions$json → const Map<String, Object>
MethodDescriptorProto$json → const Map<String, Object>
MethodOptions$json → const Map<String, Object>
MethodOptions_IdempotencyLevel$json → const Map<String, Object>
OneofDescriptorProto$json → const Map<String, Object>
OneofOptions$json → const Map<String, Object>
ServiceDescriptorProto$json → const Map<String, Object>
ServiceOptions$json → const Map<String, Object>
SourceCodeInfo$json → const Map<String, Object>
SourceCodeInfo_Location$json → const Map<String, Object>
UninterpretedOption$json → const Map<String, Object>
UninterpretedOption_NamePart$json → const Map<String, Object>

Properties

descriptorProtoDescriptor → Uint8List
Descriptor for DescriptorProto. Decode as a google.protobuf.DescriptorProto.
final
editionDescriptor → Uint8List
Descriptor for Edition. Decode as a google.protobuf.EnumDescriptorProto.
final
enumDescriptorProtoDescriptor → Uint8List
Descriptor for EnumDescriptorProto. Decode as a google.protobuf.DescriptorProto.
final
enumOptionsDescriptor → Uint8List
Descriptor for EnumOptions. Decode as a google.protobuf.DescriptorProto.
final
enumValueDescriptorProtoDescriptor → Uint8List
Descriptor for EnumValueDescriptorProto. Decode as a google.protobuf.DescriptorProto.
final
enumValueOptionsDescriptor → Uint8List
Descriptor for EnumValueOptions. Decode as a google.protobuf.DescriptorProto.
final
extensionRangeOptionsDescriptor → Uint8List
Descriptor for ExtensionRangeOptions. Decode as a google.protobuf.DescriptorProto.
final
featureSetDefaultsDescriptor → Uint8List
Descriptor for FeatureSetDefaults. Decode as a google.protobuf.DescriptorProto.
final
featureSetDescriptor → Uint8List
Descriptor for FeatureSet. Decode as a google.protobuf.DescriptorProto.
final
fieldDescriptorProtoDescriptor → Uint8List
Descriptor for FieldDescriptorProto. Decode as a google.protobuf.DescriptorProto.
final
fieldOptionsDescriptor → Uint8List
Descriptor for FieldOptions. Decode as a google.protobuf.DescriptorProto.
final
fileDescriptorProtoDescriptor → Uint8List
Descriptor for FileDescriptorProto. Decode as a google.protobuf.DescriptorProto.
final
fileDescriptorSetDescriptor → Uint8List
Descriptor for FileDescriptorSet. Decode as a google.protobuf.DescriptorProto.
final
fileOptionsDescriptor → Uint8List
Descriptor for FileOptions. Decode as a google.protobuf.DescriptorProto.
final
generatedCodeInfoDescriptor → Uint8List
Descriptor for GeneratedCodeInfo. Decode as a google.protobuf.DescriptorProto.
final
messageOptionsDescriptor → Uint8List
Descriptor for MessageOptions. Decode as a google.protobuf.DescriptorProto.
final
methodDescriptorProtoDescriptor → Uint8List
Descriptor for MethodDescriptorProto. Decode as a google.protobuf.DescriptorProto.
final
methodOptionsDescriptor → Uint8List
Descriptor for MethodOptions. Decode as a google.protobuf.DescriptorProto.
final
oneofDescriptorProtoDescriptor → Uint8List
Descriptor for OneofDescriptorProto. Decode as a google.protobuf.DescriptorProto.
final
oneofOptionsDescriptor → Uint8List
Descriptor for OneofOptions. Decode as a google.protobuf.DescriptorProto.
final
serviceDescriptorProtoDescriptor → Uint8List
Descriptor for ServiceDescriptorProto. Decode as a google.protobuf.DescriptorProto.
final
serviceOptionsDescriptor → Uint8List
Descriptor for ServiceOptions. Decode as a google.protobuf.DescriptorProto.
final
sourceCodeInfoDescriptor → Uint8List
Descriptor for SourceCodeInfo. Decode as a google.protobuf.DescriptorProto.
final
uninterpretedOptionDescriptor → Uint8List
Descriptor for UninterpretedOption. Decode as a google.protobuf.DescriptorProto.
final