package descriptorpb

Import Path
	google.golang.org/protobuf/types/descriptorpb (on go.dev)

Dependency Relation
	imports 5 packages, and imported by 2 packages

Involved Source Files descriptor.pb.go
Package-Level Type Names (total 33, all are exported)
/* sort exporteds by: | */
Describes a message type. EnumType []*EnumDescriptorProto Extension []*FieldDescriptorProto ExtensionRange []*DescriptorProto_ExtensionRange Field []*FieldDescriptorProto Name *string NestedType []*DescriptorProto OneofDecl []*OneofDescriptorProto Options *MessageOptions Reserved field names, which may not be used by fields in the same message. A given name may only be reserved once. ReservedRange []*DescriptorProto_ReservedRange Deprecated: Use DescriptorProto.ProtoReflect.Descriptor instead. (*T) GetEnumType() []*EnumDescriptorProto (*T) GetExtension() []*FieldDescriptorProto (*T) GetExtensionRange() []*DescriptorProto_ExtensionRange (*T) GetField() []*FieldDescriptorProto (*T) GetName() string (*T) GetNestedType() []*DescriptorProto (*T) GetOneofDecl() []*OneofDescriptorProto (*T) GetOptions() *MessageOptions (*T) GetReservedName() []string (*T) GetReservedRange() []*DescriptorProto_ReservedRange (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*DescriptorProto).GetNestedType() []*DescriptorProto func (*FileDescriptorProto).GetMessageType() []*DescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToDescriptorProto(message protoreflect.MessageDescriptor) *DescriptorProto
// Exclusive. Options *ExtensionRangeOptions // Inclusive. Deprecated: Use DescriptorProto_ExtensionRange.ProtoReflect.Descriptor instead. (*T) GetEnd() int32 (*T) GetOptions() *ExtensionRangeOptions (*T) GetStart() int32 (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*DescriptorProto).GetExtensionRange() []*DescriptorProto_ExtensionRange
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. // Exclusive. // Inclusive. Deprecated: Use DescriptorProto_ReservedRange.ProtoReflect.Descriptor instead. (*T) GetEnd() int32 (*T) GetStart() int32 (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*DescriptorProto).GetReservedRange() []*DescriptorProto_ReservedRange
Describes an enum type. Name *string Options *EnumOptions Reserved enum value names, which may not be reused. A given name may only be reserved once. 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. Value []*EnumValueDescriptorProto Deprecated: Use EnumDescriptorProto.ProtoReflect.Descriptor instead. (*T) GetName() string (*T) GetOptions() *EnumOptions (*T) GetReservedName() []string (*T) GetReservedRange() []*EnumDescriptorProto_EnumReservedRange (*T) GetValue() []*EnumValueDescriptorProto (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*DescriptorProto).GetEnumType() []*EnumDescriptorProto func (*FileDescriptorProto).GetEnumType() []*EnumDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToEnumDescriptorProto(enum protoreflect.EnumDescriptor) *EnumDescriptorProto
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. // Exclusive. // Inclusive. Deprecated: Use EnumDescriptorProto_EnumReservedRange.ProtoReflect.Descriptor instead. (*T) GetEnd() int32 (*T) GetStart() int32 (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*EnumDescriptorProto).GetReservedRange() []*EnumDescriptorProto_EnumReservedRange
Set this option to true to allow mapping different tag names to the same value. Is this enum deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum, or it will be completely ignored; in the very least, this is a formalization for deprecating enums. The parser stores options it doesn't recognize here. See above. Deprecated: Use EnumOptions.ProtoReflect.Descriptor instead. Deprecated: Use EnumOptions.ProtoReflect.Descriptor.ExtensionRanges instead. (*T) GetAllowAlias() bool (*T) GetDeprecated() bool (*T) GetUninterpretedOption() []*UninterpretedOption (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*EnumDescriptorProto).GetOptions() *EnumOptions
Describes a value within an enum. Name *string Number *int32 Options *EnumValueOptions Deprecated: Use EnumValueDescriptorProto.ProtoReflect.Descriptor instead. (*T) GetName() string (*T) GetNumber() int32 (*T) GetOptions() *EnumValueOptions (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*EnumDescriptorProto).GetValue() []*EnumValueDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToEnumValueDescriptorProto(value protoreflect.EnumValueDescriptor) *EnumValueDescriptorProto
Is this enum value deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum value, or it will be completely ignored; in the very least, this is a formalization for deprecating enum values. The parser stores options it doesn't recognize here. See above. Deprecated: Use EnumValueOptions.ProtoReflect.Descriptor instead. Deprecated: Use EnumValueOptions.ProtoReflect.Descriptor.ExtensionRanges instead. (*T) GetDeprecated() bool (*T) GetUninterpretedOption() []*UninterpretedOption (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*EnumValueDescriptorProto).GetOptions() *EnumValueOptions
The parser stores options it doesn't recognize here. See above. Deprecated: Use ExtensionRangeOptions.ProtoReflect.Descriptor instead. Deprecated: Use ExtensionRangeOptions.ProtoReflect.Descriptor.ExtensionRanges instead. (*T) GetUninterpretedOption() []*UninterpretedOption (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*DescriptorProto_ExtensionRange).GetOptions() *ExtensionRangeOptions
Describes a field within a message. 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? For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name. 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. Label *FieldDescriptorProto_Label Name *string Number *int32 If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. 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`. 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. 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). Deprecated: Use FieldDescriptorProto.ProtoReflect.Descriptor instead. (*T) GetDefaultValue() string (*T) GetExtendee() string (*T) GetJsonName() string (*T) GetLabel() FieldDescriptorProto_Label (*T) GetName() string (*T) GetNumber() int32 (*T) GetOneofIndex() int32 (*T) GetOptions() *FieldOptions (*T) GetProto3Optional() bool (*T) GetType() FieldDescriptorProto_Type (*T) GetTypeName() string (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*DescriptorProto).GetExtension() []*FieldDescriptorProto func (*DescriptorProto).GetField() []*FieldDescriptorProto func (*FileDescriptorProto).GetExtension() []*FieldDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToFieldDescriptorProto(field protoreflect.FieldDescriptor) *FieldDescriptorProto
( T) Descriptor() protoreflect.EnumDescriptor ( T) Enum() *FieldDescriptorProto_Label Deprecated: Use FieldDescriptorProto_Label.Descriptor instead. ( T) Number() protoreflect.EnumNumber ( T) String() string ( T) Type() protoreflect.EnumType Deprecated: Do not use. T : google.golang.org/protobuf/reflect/protoreflect.Enum *T : encoding/json.Unmarshaler T : fmt.Stringer func (*FieldDescriptorProto).GetLabel() FieldDescriptorProto_Label func FieldDescriptorProto_Label.Enum() *FieldDescriptorProto_Label const FieldDescriptorProto_LABEL_OPTIONAL const FieldDescriptorProto_LABEL_REPEATED const FieldDescriptorProto_LABEL_REQUIRED
( T) Descriptor() protoreflect.EnumDescriptor ( T) Enum() *FieldDescriptorProto_Type Deprecated: Use FieldDescriptorProto_Type.Descriptor instead. ( T) Number() protoreflect.EnumNumber ( T) String() string ( T) Type() protoreflect.EnumType Deprecated: Do not use. T : google.golang.org/protobuf/reflect/protoreflect.Enum *T : encoding/json.Unmarshaler T : fmt.Stringer func (*FieldDescriptorProto).GetType() FieldDescriptorProto_Type func FieldDescriptorProto_Type.Enum() *FieldDescriptorProto_Type const FieldDescriptorProto_TYPE_BOOL const FieldDescriptorProto_TYPE_BYTES const FieldDescriptorProto_TYPE_DOUBLE const FieldDescriptorProto_TYPE_ENUM const FieldDescriptorProto_TYPE_FIXED32 const FieldDescriptorProto_TYPE_FIXED64 const FieldDescriptorProto_TYPE_FLOAT const FieldDescriptorProto_TYPE_GROUP const FieldDescriptorProto_TYPE_INT32 const FieldDescriptorProto_TYPE_INT64 const FieldDescriptorProto_TYPE_MESSAGE const FieldDescriptorProto_TYPE_SFIXED32 const FieldDescriptorProto_TYPE_SFIXED64 const FieldDescriptorProto_TYPE_SINT32 const FieldDescriptorProto_TYPE_SINT64 const FieldDescriptorProto_TYPE_STRING const FieldDescriptorProto_TYPE_UINT32 const FieldDescriptorProto_TYPE_UINT64
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! 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. 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. 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. 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. The parser stores options it doesn't recognize here. See above. For Google-internal migration only. Do not use. Deprecated: Use FieldOptions.ProtoReflect.Descriptor instead. Deprecated: Use FieldOptions.ProtoReflect.Descriptor.ExtensionRanges instead. (*T) GetCtype() FieldOptions_CType (*T) GetDeprecated() bool (*T) GetJstype() FieldOptions_JSType (*T) GetLazy() bool (*T) GetPacked() bool (*T) GetUninterpretedOption() []*UninterpretedOption (*T) GetWeak() bool (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*FieldDescriptorProto).GetOptions() *FieldOptions
( T) Descriptor() protoreflect.EnumDescriptor ( T) Enum() *FieldOptions_CType Deprecated: Use FieldOptions_CType.Descriptor instead. ( T) Number() protoreflect.EnumNumber ( T) String() string ( T) Type() protoreflect.EnumType Deprecated: Do not use. T : google.golang.org/protobuf/reflect/protoreflect.Enum *T : encoding/json.Unmarshaler T : fmt.Stringer func (*FieldOptions).GetCtype() FieldOptions_CType func FieldOptions_CType.Enum() *FieldOptions_CType const Default_FieldOptions_Ctype const FieldOptions_CORD const FieldOptions_STRING const FieldOptions_STRING_PIECE
( T) Descriptor() protoreflect.EnumDescriptor ( T) Enum() *FieldOptions_JSType Deprecated: Use FieldOptions_JSType.Descriptor instead. ( T) Number() protoreflect.EnumNumber ( T) String() string ( T) Type() protoreflect.EnumType Deprecated: Do not use. T : google.golang.org/protobuf/reflect/protoreflect.Enum *T : encoding/json.Unmarshaler T : fmt.Stringer func (*FieldOptions).GetJstype() FieldOptions_JSType func FieldOptions_JSType.Enum() *FieldOptions_JSType const Default_FieldOptions_Jstype const FieldOptions_JS_NORMAL const FieldOptions_JS_NUMBER const FieldOptions_JS_STRING
Describes a complete .proto file. Names of files imported by this file. EnumType []*EnumDescriptorProto Extension []*FieldDescriptorProto All top-level definitions in this file. // file name, relative to root of source tree Options *FileOptions // e.g. "foo", "foo.bar", etc. Indexes of the public imported files in the dependency list above. Service []*ServiceDescriptorProto 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. The syntax of the proto file. The supported values are "proto2" and "proto3". Indexes of the weak imported files in the dependency list. For Google-internal migration only. Do not use. Deprecated: Use FileDescriptorProto.ProtoReflect.Descriptor instead. (*T) GetDependency() []string (*T) GetEnumType() []*EnumDescriptorProto (*T) GetExtension() []*FieldDescriptorProto (*T) GetMessageType() []*DescriptorProto (*T) GetName() string (*T) GetOptions() *FileOptions (*T) GetPackage() string (*T) GetPublicDependency() []int32 (*T) GetService() []*ServiceDescriptorProto (*T) GetSourceCodeInfo() *SourceCodeInfo (*T) GetSyntax() string (*T) GetWeakDependency() []int32 (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*FileDescriptorSet).GetFile() []*FileDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToFileDescriptorProto(file protoreflect.FileDescriptor) *FileDescriptorProto func google.golang.org/protobuf/reflect/protodesc.NewFile(fd *FileDescriptorProto, r protodesc.Resolver) (protoreflect.FileDescriptor, error) func google.golang.org/protobuf/reflect/protodesc.FileOptions.New(fd *FileDescriptorProto, r protodesc.Resolver) (protoreflect.FileDescriptor, error)
The protocol compiler can output a FileDescriptorSet containing the .proto files it parses. File []*FileDescriptorProto Deprecated: Use FileDescriptorSet.ProtoReflect.Descriptor instead. (*T) GetFile() []*FileDescriptorProto (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func google.golang.org/protobuf/reflect/protodesc.NewFiles(fd *FileDescriptorSet) (*protoregistry.Files, error) func google.golang.org/protobuf/reflect/protodesc.FileOptions.NewFiles(fds *FileDescriptorSet) (*protoregistry.Files, error)
Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++. 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. Namespace for generated classes; defaults to the package. 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. 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. This option does nothing. Deprecated: Do not use. JavaGenericServices *bool 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. 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). 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. 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. Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default. OptimizeFor *FileOptions_OptimizeMode Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty. PhpGenericServices *bool 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. 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. PyGenericServices *bool 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. 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. The parser stores options it doesn't recognize here. See the documentation for the "Options" section above. Deprecated: Use FileOptions.ProtoReflect.Descriptor instead. Deprecated: Use FileOptions.ProtoReflect.Descriptor.ExtensionRanges instead. (*T) GetCcEnableArenas() bool (*T) GetCcGenericServices() bool (*T) GetCsharpNamespace() string (*T) GetDeprecated() bool (*T) GetGoPackage() string Deprecated: Do not use. (*T) GetJavaGenericServices() bool (*T) GetJavaMultipleFiles() bool (*T) GetJavaOuterClassname() string (*T) GetJavaPackage() string (*T) GetJavaStringCheckUtf8() bool (*T) GetObjcClassPrefix() string (*T) GetOptimizeFor() FileOptions_OptimizeMode (*T) GetPhpClassPrefix() string (*T) GetPhpGenericServices() bool (*T) GetPhpMetadataNamespace() string (*T) GetPhpNamespace() string (*T) GetPyGenericServices() bool (*T) GetRubyPackage() string (*T) GetSwiftPrefix() string (*T) GetUninterpretedOption() []*UninterpretedOption (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*FileDescriptorProto).GetOptions() *FileOptions
Generated classes can be optimized for speed or code size. ( T) Descriptor() protoreflect.EnumDescriptor ( T) Enum() *FileOptions_OptimizeMode Deprecated: Use FileOptions_OptimizeMode.Descriptor instead. ( T) Number() protoreflect.EnumNumber ( T) String() string ( T) Type() protoreflect.EnumType Deprecated: Do not use. T : google.golang.org/protobuf/reflect/protoreflect.Enum *T : encoding/json.Unmarshaler T : fmt.Stringer func (*FileOptions).GetOptimizeFor() FileOptions_OptimizeMode func FileOptions_OptimizeMode.Enum() *FileOptions_OptimizeMode const Default_FileOptions_OptimizeFor const FileOptions_CODE_SIZE const FileOptions_LITE_RUNTIME const FileOptions_SPEED
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. An Annotation connects some span of text in generated code to an element of its generating .proto file. Deprecated: Use GeneratedCodeInfo.ProtoReflect.Descriptor instead. (*T) GetAnnotation() []*GeneratedCodeInfo_Annotation (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer
Identifies the starting offset in bytes in the generated code that relates to the identified object. Identifies the ending offset in bytes in the generated code that relates to the identified offset. The end offset should be one past the last relevant byte (so the length of the text = end - begin). Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path. Identifies the filesystem path to the original source .proto. Deprecated: Use GeneratedCodeInfo_Annotation.ProtoReflect.Descriptor instead. (*T) GetBegin() int32 (*T) GetEnd() int32 (*T) GetPath() []int32 (*T) GetSourceFile() string (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*GeneratedCodeInfo).GetAnnotation() []*GeneratedCodeInfo_Annotation
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. 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. 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. 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". The parser stores options it doesn't recognize here. See above. Deprecated: Use MessageOptions.ProtoReflect.Descriptor instead. Deprecated: Use MessageOptions.ProtoReflect.Descriptor.ExtensionRanges instead. (*T) GetDeprecated() bool (*T) GetMapEntry() bool (*T) GetMessageSetWireFormat() bool (*T) GetNoStandardDescriptorAccessor() bool (*T) GetUninterpretedOption() []*UninterpretedOption (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*DescriptorProto).GetOptions() *MessageOptions
Describes a method of a service. Identifies if client streams multiple client messages Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type. Name *string Options *MethodOptions OutputType *string Identifies if server streams multiple server messages Deprecated: Use MethodDescriptorProto.ProtoReflect.Descriptor instead. (*T) GetClientStreaming() bool (*T) GetInputType() string (*T) GetName() string (*T) GetOptions() *MethodOptions (*T) GetOutputType() string (*T) GetServerStreaming() bool (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*ServiceDescriptorProto).GetMethod() []*MethodDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToMethodDescriptorProto(method protoreflect.MethodDescriptor) *MethodDescriptorProto
Is this method deprecated? Depending on the target platform, this can emit Deprecated annotations for the method, or it will be completely ignored; in the very least, this is a formalization for deprecating methods. IdempotencyLevel *MethodOptions_IdempotencyLevel The parser stores options it doesn't recognize here. See above. Deprecated: Use MethodOptions.ProtoReflect.Descriptor instead. Deprecated: Use MethodOptions.ProtoReflect.Descriptor.ExtensionRanges instead. (*T) GetDeprecated() bool (*T) GetIdempotencyLevel() MethodOptions_IdempotencyLevel (*T) GetUninterpretedOption() []*UninterpretedOption (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*MethodDescriptorProto).GetOptions() *MethodOptions
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. ( T) Descriptor() protoreflect.EnumDescriptor ( T) Enum() *MethodOptions_IdempotencyLevel Deprecated: Use MethodOptions_IdempotencyLevel.Descriptor instead. ( T) Number() protoreflect.EnumNumber ( T) String() string ( T) Type() protoreflect.EnumType Deprecated: Do not use. T : google.golang.org/protobuf/reflect/protoreflect.Enum *T : encoding/json.Unmarshaler T : fmt.Stringer func (*MethodOptions).GetIdempotencyLevel() MethodOptions_IdempotencyLevel func MethodOptions_IdempotencyLevel.Enum() *MethodOptions_IdempotencyLevel const Default_MethodOptions_IdempotencyLevel const MethodOptions_IDEMPOTENCY_UNKNOWN const MethodOptions_IDEMPOTENT const MethodOptions_NO_SIDE_EFFECTS
Describes a oneof. Name *string Options *OneofOptions Deprecated: Use OneofDescriptorProto.ProtoReflect.Descriptor instead. (*T) GetName() string (*T) GetOptions() *OneofOptions (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*DescriptorProto).GetOneofDecl() []*OneofDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToOneofDescriptorProto(oneof protoreflect.OneofDescriptor) *OneofDescriptorProto
The parser stores options it doesn't recognize here. See above. Deprecated: Use OneofOptions.ProtoReflect.Descriptor instead. Deprecated: Use OneofOptions.ProtoReflect.Descriptor.ExtensionRanges instead. (*T) GetUninterpretedOption() []*UninterpretedOption (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*OneofDescriptorProto).GetOptions() *OneofOptions
Describes a service. Method []*MethodDescriptorProto Name *string Options *ServiceOptions Deprecated: Use ServiceDescriptorProto.ProtoReflect.Descriptor instead. (*T) GetMethod() []*MethodDescriptorProto (*T) GetName() string (*T) GetOptions() *ServiceOptions (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*FileDescriptorProto).GetService() []*ServiceDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToServiceDescriptorProto(service protoreflect.ServiceDescriptor) *ServiceDescriptorProto
Is this service deprecated? Depending on the target platform, this can emit Deprecated annotations for the service, or it will be completely ignored; in the very least, this is a formalization for deprecating services. The parser stores options it doesn't recognize here. See above. Deprecated: Use ServiceOptions.ProtoReflect.Descriptor instead. Deprecated: Use ServiceOptions.ProtoReflect.Descriptor.ExtensionRanges instead. (*T) GetDeprecated() bool (*T) GetUninterpretedOption() []*UninterpretedOption (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*ServiceDescriptorProto).GetOptions() *ServiceOptions
Encapsulates information about the original source file from which a FileDescriptorProto was generated. A Location identifies a piece of source code in a .proto file which corresponds to a particular definition. This information is intended to be useful to IDEs, code indexers, documentation generators, and similar tools. For example, say we have a file like: message Foo { optional string foo = 1; } Let's look at just the field definition: optional string foo = 1; ^ ^^ ^^ ^ ^^^ a bc de f ghi We have the following locations: span path represents [a,i) [ 4, 0, 2, 0 ] The whole field definition. [a,b) [ 4, 0, 2, 0, 4 ] The label (optional). [c,d) [ 4, 0, 2, 0, 5 ] The type (string). [e,f) [ 4, 0, 2, 0, 1 ] The name (foo). [g,h) [ 4, 0, 2, 0, 3 ] The number (1). Notes: - A location may refer to a repeated field itself (i.e. not to any particular index within it). This is used whenever a set of elements are logically enclosed in a single code segment. For example, an entire extend block (possibly containing multiple extension definitions) will have an outer location whose path refers to the "extensions" repeated field without an index. - Multiple locations may have the same path. This happens when a single logical declaration is spread out across multiple places. The most obvious example is the "extend" block again -- there may be multiple extend blocks in the same scope, each of which will have the same path. - A location's span is not always a subset of its parent's span. For example, the "extendee" of an extension declaration appears at the beginning of the "extend" block and is shared by all extensions within the block. - Just because a location's span is a subset of some other location's span does not mean that it is a descendant. For example, a "group" defines both a type and a field in a single declaration. Thus, the locations corresponding to the type and field and their components will overlap. - Code which tries to interpret locations should probably be designed to ignore those that it doesn't understand, as more types of locations could be recorded in the future. Deprecated: Use SourceCodeInfo.ProtoReflect.Descriptor instead. (*T) GetLocation() []*SourceCodeInfo_Location (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*FileDescriptorProto).GetSourceCodeInfo() *SourceCodeInfo
If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration. A series of line comments appearing on consecutive lines, with no other tokens appearing on those lines, will be treated as a single comment. leading_detached_comments will keep paragraphs of comments that appear before (but not connected to) the current element. Each paragraph, separated by empty lines, will be one comment element in the repeated field. Only the comment content is provided; comment markers (e.g. //) are stripped out. For block comments, leading whitespace and an asterisk will be stripped from the beginning of each line other than the first. Newlines are included in the output. Examples: optional int32 foo = 1; // Comment attached to foo. // Comment attached to bar. optional int32 bar = 2; optional string baz = 3; // Comment attached to baz. // Another line attached to baz. // Comment attached to qux. // // Another line attached to qux. optional double qux = 4; // Detached comment for corge. This is not leading or trailing comments // to qux or corge because there are blank lines separating it from // both. // Detached comment for corge paragraph 2. optional string corge = 5; /* Block comment attached * to corge. Leading asterisks * will be removed. */ /* Block comment attached to * grault. */ optional int32 grault = 6; // ignored detached comments. LeadingDetachedComments []string Identifies which part of the FileDescriptorProto was defined at this location. Each element is a field number or an index. They form a path from the root FileDescriptorProto to the place where the definition. For example, this path: [ 4, 3, 2, 7, 1 ] refers to: file.message_type(3) // 4, 3 .field(7) // 2, 7 .name() // 1 This is because FileDescriptorProto.message_type has field number 4: repeated DescriptorProto message_type = 4; and DescriptorProto.field has field number 2: repeated FieldDescriptorProto field = 2; and FieldDescriptorProto.name has field number 1: optional string name = 1; Thus, the above path gives the location of a field name. If we removed the last element: [ 4, 3, 2, 7 ] this path refers to the whole field declaration (from the beginning of the label to the terminating semicolon). Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column. These are packed into a single field for efficiency. Note that line and column numbers are zero-based -- typically you will want to add 1 to each before displaying to a user. TrailingComments *string Deprecated: Use SourceCodeInfo_Location.ProtoReflect.Descriptor instead. (*T) GetLeadingComments() string (*T) GetLeadingDetachedComments() []string (*T) GetPath() []int32 (*T) GetSpan() []int32 (*T) GetTrailingComments() string (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*SourceCodeInfo).GetLocation() []*SourceCodeInfo_Location
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. AggregateValue *string DoubleValue *float64 The value of the uninterpreted option, in whatever type the tokenizer identified it as during parsing. Exactly one of these should be set. Name []*UninterpretedOption_NamePart NegativeIntValue *int64 PositiveIntValue *uint64 StringValue []byte Deprecated: Use UninterpretedOption.ProtoReflect.Descriptor instead. (*T) GetAggregateValue() string (*T) GetDoubleValue() float64 (*T) GetIdentifierValue() string (*T) GetName() []*UninterpretedOption_NamePart (*T) GetNegativeIntValue() int64 (*T) GetPositiveIntValue() uint64 (*T) GetStringValue() []byte (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*EnumOptions).GetUninterpretedOption() []*UninterpretedOption func (*EnumValueOptions).GetUninterpretedOption() []*UninterpretedOption func (*ExtensionRangeOptions).GetUninterpretedOption() []*UninterpretedOption func (*FieldOptions).GetUninterpretedOption() []*UninterpretedOption func (*FileOptions).GetUninterpretedOption() []*UninterpretedOption func (*MessageOptions).GetUninterpretedOption() []*UninterpretedOption func (*MethodOptions).GetUninterpretedOption() []*UninterpretedOption func (*OneofOptions).GetUninterpretedOption() []*UninterpretedOption func (*ServiceOptions).GetUninterpretedOption() []*UninterpretedOption
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], ["qux", false] } represents "foo.(bar.baz).qux". IsExtension *bool NamePart *string Deprecated: Use UninterpretedOption_NamePart.ProtoReflect.Descriptor instead. (*T) GetIsExtension() bool (*T) GetNamePart() string (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : fmt.Stringer func (*UninterpretedOption).GetName() []*UninterpretedOption_NamePart
Package-Level Functions (total 3, none are exported)
Package-Level Variables (total 29, in which 13 are exported)
Enum value maps for FieldDescriptorProto_Label.
Enum value maps for FieldDescriptorProto_Label.
Enum value maps for FieldDescriptorProto_Type.
Enum value maps for FieldDescriptorProto_Type.
Enum value maps for FieldOptions_CType.
Enum value maps for FieldOptions_CType.
Enum value maps for FieldOptions_JSType.
Enum value maps for FieldOptions_JSType.
Enum value maps for FileOptions_OptimizeMode.
Enum value maps for FileOptions_OptimizeMode.
Enum value maps for MethodOptions_IdempotencyLevel.
Enum value maps for MethodOptions_IdempotencyLevel.
Package-Level Constants (total 57, all are exported)
Default values for EnumOptions fields.
Default values for EnumValueOptions fields.
Default values for FieldOptions fields.
Default values for FieldOptions fields.
Default values for FieldOptions fields.
Default values for FieldOptions fields.
Default values for FieldOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for MessageOptions fields.
Default values for MessageOptions fields.
Default values for MessageOptions fields.
Default values for MethodDescriptorProto fields.
Default values for MethodDescriptorProto fields.
Default values for MethodOptions fields.
Default values for MethodOptions fields.
Default values for ServiceOptions fields.
0 is reserved for errors. Order is weird for historical reasons.
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.
Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if negative values are likely.
Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if negative values are likely.
const FieldDescriptorProto_TYPE_MESSAGE FieldDescriptorProto_Type = 11 // Length-delimited aggregate.
const FieldDescriptorProto_TYPE_SINT32 FieldDescriptorProto_Type = 17 // Uses ZigZag encoding.
const FieldDescriptorProto_TYPE_SINT64 FieldDescriptorProto_Type = 18 // Uses ZigZag encoding.
Use the default type.
Use JavaScript numbers.
Use JavaScript strings.
Default mode.
etc.
const FileOptions_LITE_RUNTIME FileOptions_OptimizeMode = 3 // Generate code using MessageLite and the lite runtime.
const FileOptions_SPEED FileOptions_OptimizeMode = 1 // Generate complete code for parsing, serialization,
const MethodOptions_IDEMPOTENT MethodOptions_IdempotencyLevel = 2 // idempotent, but may have side effects