google.protobufgithub.com/solo-io/solo-kit/api/external/google/protobuf/descriptor.proto

Package : google.protobuf

Top

github.com/solo-io/solo-kit/api/external/google/protobuf/descriptor.proto

Table of Contents

• DescriptorProto

• DescriptorProto.ExtensionRange

• DescriptorProto.ReservedRange

• EnumDescriptorProto

• EnumOptions

• EnumValueDescriptorProto

• EnumValueOptions

• FieldDescriptorProto

• FieldOptions

• FileDescriptorProto

• FileDescriptorSet

• FileOptions

• GeneratedCodeInfo

• GeneratedCodeInfo.Annotation

• MessageOptions

• MethodDescriptorProto

• MethodOptions

• OneofDescriptorProto

• OneofOptions

• ServiceDescriptorProto

• ServiceOptions

• SourceCodeInfo

• SourceCodeInfo.Location

• UninterpretedOption

• UninterpretedOption.NamePart

• FieldDescriptorProto.Label

• FieldDescriptorProto.Type

• FieldOptions.CType

• FieldOptions.JSType

• FileOptions.OptimizeMode

• MethodOptions.IdempotencyLevel

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.

EnumDescriptorProto

Describes an enum type.

EnumOptions

EnumValueDescriptorProto

Describes a value within an enum.

EnumValueOptions

FieldDescriptorProto

Describes a field within a message.

FieldOptions

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 | | uninterpreted_option | []UninterpretedOption | repeated | The parser stores options it doesn't recognize here. See above. |

FileDescriptorProto

Describes a complete .proto file.

FileDescriptorSet

The protocol compiler can output a FileDescriptorSet containing the .proto files it parses.

FileOptions

• 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. | | cc_generic_services | 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 | | java_generic_services | bool | optional | Default: false | | py_generic_services | 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 | | cc_enable_arenas | bool | optional | Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++. Default: false | | objc_class_prefix | string | optional | Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default. | | csharp_namespace | string | optional | Namespace for generated classes; defaults to the package. | | swift_prefix | 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. | | php_class_prefix | string | optional | Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty. | | uninterpreted_option | []UninterpretedOption | repeated | The parser stores options it doesn't recognize here. See above. |

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

MessageOptions

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 | | no_standard_descriptor_accessor | 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 | | map_entry | 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. | | uninterpreted_option | []UninterpretedOption | repeated | The parser stores options it doesn't recognize here. See above. |

MethodDescriptorProto

Describes a method of a service.

MethodOptions

OneofDescriptorProto

Describes a oneof.

OneofOptions

ServiceDescriptorProto

Describes a service.

ServiceOptions

SourceCodeInfo

Encapsulates information about the original source file from which a FileDescriptorProto was generated.

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

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. | | leading_comments | 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. | | trailing_comments | string | optional | | | leading_detached_comments | []string | repeated | |

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], ["qux", false] } represents "foo.(bar.baz).qux".

FieldDescriptorProto.Label

FieldDescriptorProto.Type

FieldOptions.CType

FieldOptions.JSType

FileOptions.OptimizeMode

Generated classes can be optimized for speed or code size.

Use ReflectionOps to implement these methods. | | LITE_RUNTIME | 3 | Generate code using MessageLite and the lite runtime. |

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.