Package : google.protobuf

Top

descriptor.proto

Table of Contents

DescriptorProto

Field Type Label Description
name string optional
field []google.protobuf.FieldDescriptorProto repeated
extension []google.protobuf.FieldDescriptorProto repeated
nestedType []google.protobuf.DescriptorProto repeated
enumType []google.protobuf.EnumDescriptorProto repeated
extensionRange []google.protobuf.DescriptorProto.ExtensionRange repeated
oneofDecl []google.protobuf.OneofDescriptorProto repeated
options google.protobuf.MessageOptions optional
reservedRange []google.protobuf.DescriptorProto.ReservedRange repeated
reservedName []string repeated Reserved field names, which may not be used by fields in the same message. A given name may only be reserved once.

DescriptorProto.ExtensionRange

Field Type Label Description
start int32 optional
end int32 optional
options google.protobuf.ExtensionRangeOptions optional

DescriptorProto.ReservedRange

Field Type Label Description
start int32 optional Inclusive.
end int32 optional Exclusive.

EnumDescriptorProto

Field Type Label Description
name string optional
value []google.protobuf.EnumValueDescriptorProto repeated
options google.protobuf.EnumOptions optional
reservedRange []google.protobuf.EnumDescriptorProto.EnumReservedRange repeated 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.
reservedName []string repeated Reserved enum value names, which may not be reused. A given name may only be reserved once.

EnumDescriptorProto.EnumReservedRange

Field Type Label Description
start int32 optional Inclusive.
end int32 optional Inclusive.

EnumOptions

Field Type Label Description
allowAlias bool optional Set this option to true to allow mapping different tag names to the same value.
deprecated bool optional 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. Default: false
uninterpretedOption []google.protobuf.UninterpretedOption repeated The parser stores options it doesn't recognize here. See above.

EnumValueDescriptorProto

Field Type Label Description
name string optional
number int32 optional
options google.protobuf.EnumValueOptions optional

EnumValueOptions

Field Type Label Description
deprecated bool optional 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. Default: false
uninterpretedOption []google.protobuf.UninterpretedOption repeated The parser stores options it doesn't recognize here. See above.

ExtensionRangeOptions

Field Type Label Description
uninterpretedOption []google.protobuf.UninterpretedOption repeated The parser stores options it doesn't recognize here. See above.

FieldDescriptorProto

Field Type Label Description
name string optional
number int32 optional
label google.protobuf.FieldDescriptorProto.Label optional
type google.protobuf.FieldDescriptorProto.Type 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.
typeName string optional 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).
extendee string optional For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
defaultValue string optional 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?
oneofIndex int32 optional If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
jsonName string optional 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.
options google.protobuf.FieldOptions optional

FieldOptions

Field Type Label Description
ctype google.protobuf.FieldOptions.CType optional 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! Default: STRING
packed bool optional 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.
jstype google.protobuf.FieldOptions.JSType optional 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. Default: JS_NORMAL
lazy bool optional 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. Default: false
deprecated bool optional 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. Default: false
weak bool optional For Google-internal migration only. Do not use. Default: false
uninterpretedOption []google.protobuf.UninterpretedOption repeated The parser stores options it doesn't recognize here. See above.

FileDescriptorProto

Field Type Label Description
name string optional file name, relative to root of source tree
package string optional e.g. “foo”, “foo.bar”, etc.
dependency []string repeated Names of files imported by this file.
publicDependency []int32 repeated Indexes of the public imported files in the dependency list above.
weakDependency []int32 repeated Indexes of the weak imported files in the dependency list. For Google-internal migration only. Do not use.
messageType []google.protobuf.DescriptorProto repeated All top-level definitions in this file.
enumType []google.protobuf.EnumDescriptorProto repeated
service []google.protobuf.ServiceDescriptorProto repeated
extension []google.protobuf.FieldDescriptorProto repeated
options google.protobuf.FileOptions optional
sourceCodeInfo google.protobuf.SourceCodeInfo optional 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.
syntax string optional The syntax of the proto file. The supported values are “proto2” and “proto3”.

FileDescriptorSet

Field Type Label Description
file []google.protobuf.FileDescriptorProto repeated

FileOptions

Field Type Label Description
javaPackage string optional 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.
javaOuterClassname string optional 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).
javaMultipleFiles bool optional 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. Default: false
javaGenerateEqualsAndHash bool optional This option does nothing.
javaStringCheckUtf8 bool optional 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. Default: false
optimizeFor google.protobuf.FileOptions.OptimizeMode optional Default: SPEED
goPackage string optional 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.
ccGenericServices bool optional 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. Default: false
javaGenericServices bool optional Default: false
pyGenericServices bool optional Default: false
phpGenericServices bool optional Default: false
deprecated bool optional 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. Default: false
ccEnableArenas bool optional Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++. Default: false
objcClassPrefix string optional Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.
csharpNamespace string optional Namespace for generated classes; defaults to the package.
swiftPrefix string optional 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.
phpClassPrefix string optional Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.
phpNamespace string optional 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.
phpMetadataNamespace string optional 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.
rubyPackage string optional 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.
uninterpretedOption []google.protobuf.UninterpretedOption repeated The parser stores options it doesn't recognize here. See the documentation for the “Options” section above.

GeneratedCodeInfo

Field Type Label Description
annotation []google.protobuf.GeneratedCodeInfo.Annotation repeated An Annotation connects some span of text in generated code to an element of its generating .proto file.

GeneratedCodeInfo.Annotation

Field Type Label Description
path []int32 repeated Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path.
sourceFile string optional Identifies the filesystem path to the original source .proto.
begin int32 optional Identifies the starting offset in bytes in the generated code that relates to the identified object.
end int32 optional 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).

MessageOptions

Field Type Label Description
messageSetWireFormat bool optional 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. Default: false
noStandardDescriptorAccessor bool optional 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”. Default: false
deprecated bool optional 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. Default: false
mapEntry bool optional 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 implementions 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.
uninterpretedOption []google.protobuf.UninterpretedOption repeated The parser stores options it doesn't recognize here. See above.

MethodDescriptorProto

Field Type Label Description
name string optional
inputType string optional Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type.
outputType string optional
options google.protobuf.MethodOptions optional
clientStreaming bool optional Identifies if client streams multiple client messages Default: false
serverStreaming bool optional Identifies if server streams multiple server messages Default: false

MethodOptions

Field Type Label Description
deprecated bool optional 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. Default: false
idempotencyLevel google.protobuf.MethodOptions.IdempotencyLevel optional Default: IDEMPOTENCY_UNKNOWN
uninterpretedOption []google.protobuf.UninterpretedOption repeated The parser stores options it doesn't recognize here. See above.

OneofDescriptorProto

Field Type Label Description
name string optional
options google.protobuf.OneofOptions optional

OneofOptions

Field Type Label Description
uninterpretedOption []google.protobuf.UninterpretedOption repeated The parser stores options it doesn't recognize here. See above.

ServiceDescriptorProto

Field Type Label Description
name string optional
method []google.protobuf.MethodDescriptorProto repeated
options google.protobuf.ServiceOptions optional

ServiceOptions

Field Type Label Description
deprecated bool optional 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. Default: false
uninterpretedOption []google.protobuf.UninterpretedOption repeated The parser stores options it doesn't recognize here. See above.

SourceCodeInfo

Field Type Label Description
location []google.protobuf.SourceCodeInfo.Location repeated 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 descendent. 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.

SourceCodeInfo.Location

Field Type Label Description
path []int32 repeated 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).
span []int32 repeated 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.
leadingComments string optional 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.
trailingComments string optional
leadingDetachedComments []string repeated

UninterpretedOption

Field Type Label Description
name []google.protobuf.UninterpretedOption.NamePart repeated
identifierValue string optional The value of the uninterpreted option, in whatever type the tokenizer identified it as during parsing. Exactly one of these should be set.
positiveIntValue uint64 optional
negativeIntValue int64 optional
doubleValue double optional
stringValue bytes optional
aggregateValue string optional

UninterpretedOption.NamePart

Field Type Label Description
namePart string required
isExtension bool required

FieldDescriptorProto.Label

Name Number Description
LABEL_OPTIONAL 1 0 is reserved for errors
LABEL_REQUIRED 2
LABEL_REPEATED 3

FieldDescriptorProto.Type

Name Number Description
TYPE_DOUBLE 1 0 is reserved for errors. Order is weird for historical reasons.
TYPE_FLOAT 2
TYPE_INT64 3 Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if negative values are likely.
TYPE_UINT64 4
TYPE_INT32 5 Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if negative values are likely.
TYPE_FIXED64 6
TYPE_FIXED32 7
TYPE_BOOL 8
TYPE_STRING 9
TYPE_GROUP 10 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.
TYPE_MESSAGE 11 Length-delimited aggregate.
TYPE_BYTES 12 New in version 2.
TYPE_UINT32 13
TYPE_ENUM 14
TYPE_SFIXED32 15
TYPE_SFIXED64 16
TYPE_SINT32 17 Uses ZigZag encoding.
TYPE_SINT64 18 Uses ZigZag encoding.

FieldOptions.CType

Name Number Description
STRING 0 Default mode.
CORD 1
STRING_PIECE 2

FieldOptions.JSType

Name Number Description
JS_NORMAL 0 Use the default type.
JS_STRING 1 Use JavaScript strings.
JS_NUMBER 2 Use JavaScript numbers.

FileOptions.OptimizeMode

Name Number Description
SPEED 1 Generate complete code for parsing, serialization,
CODE_SIZE 2 etc.
Use ReflectionOps to implement these methods.
LITE_RUNTIME 3 Generate code using MessageLite and the lite runtime.

MethodOptions.IdempotencyLevel

Name Number Description
IDEMPOTENCY_UNKNOWN 0
NO_SIDE_EFFECTS 1 implies idempotent
IDEMPOTENT 2 idempotent, but may have side effects