Protorip

google.protobuf

Messages

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

In its binary encoding, an Any is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the type URL is described on the type_url field.

Protobuf APIs provide utilities to interact with Any values:

  • A 'pack' operation accepts a message and constructs a generic Any wrapper around it.
  • An 'unpack' operation reads the content of an Any message, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declared type_url.
  • An 'is' operation decides whether an Any contains a message of the given type, i.e. whether it can 'unpack' that type.

The JSON format representation of an Any follows one of these cases:

  • For types without special-cased JSON encodings, the JSON format representation of the Any is the same as that of the message, with an additional @type field which contains the type URL.
  • For types with special-cased JSON encodings (typically called 'well-known' types, listed in https://protobuf.dev/programming-guides/json/#any), the JSON format representation has a key @type which contains the type URL and a key value which contains the JSON-serialized value.

The text format representation of an Any is like a message with one field whose name is the type URL in brackets. For example, an Any containing a foo.Bar message may be written [type.googleapis.com/foo.Bar] { a: 2 }.

NameTagTypeLabelDescription
type_url1stringoptional

Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name.

Example: type.googleapis.com/google.protobuf.StringValue

This string must contain at least one / character, and the content after the last / must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them.

The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last / to identify the type. type.googleapis.com/ is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests.

All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): /-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, type.googleapis.com%2FFoo should be rejected.

In the original design of Any, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs.

value2bytesoptional

Holds a Protobuf serialization of the type described by type_url.

Api is a light-weight descriptor for an API Interface.

Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.

NameTagTypeLabelDescription
name1stringoptional

The fully qualified name of this interface, including package name followed by the interface's simple name.

methods2Methodrepeated

The methods of this interface, in unspecified order.

options3Optionrepeated

Any metadata attached to the interface.

version4stringoptional

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here.

The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan.

The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

source_context5SourceContextoptional

Source context for the protocol buffer service represented by this message.

mixins6Mixinrepeated

Included interfaces. See [Mixin][].

syntax7Syntaxoptional

The source syntax of the service.

edition8stringoptional

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

Method represents a method of an API interface.

New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.

NameTagTypeLabelDescription
name1stringoptional

The simple name of this method.

request_type_url2stringoptional

A URL of the input message type.

request_streaming3booloptional

If true, the request is streamed.

response_type_url4stringoptional

The URL of the output message type.

response_streaming5booloptional

If true, the response is streamed.

options6Optionrepeated

Any metadata attached to the method.

syntaxDeprecated7Syntaxoptional

The source syntax of this method.

This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.

editionDeprecated8stringoptional

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows:

  • If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method.

  • Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited.

  • If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the [root][] path if specified.

Example of a simple mixin:

package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } }

package google.storage.v2; service Storage { rpc GetAcl(GetAclRequest) returns (Acl);

// Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } }

Example of a mixin configuration:

apis:

  • name: google.storage.v2.Storage mixins:
  • name: google.acl.v1.AccessControl

The mixin construct implies that all methods in AccessControl are also declared with same name and request/response types in Storage. A documentation generator or annotation processor will see the effective Storage.GetAcl method after inheriting documentation and annotations as follows:

service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... }

Note how the version in the path pattern changed from v1 to v2.

If the root field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example:

apis:

  • name: google.storage.v2.Storage mixins:
  • name: google.acl.v1.AccessControl root: acls

This implies the following inherited HTTP annotation:

service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... }

NameTagTypeLabelDescription
name1stringoptional

The fully qualified name of the interface which is included.

root2stringoptional

If non-empty specifies a path under which inherited HTTP paths are rooted.

Describes a complete .proto file.

NameTagTypeLabelDescription
name1stringoptional

file name, relative to root of source tree

package2stringoptional

e.g. "foo", "foo.bar", etc.

dependency3stringrepeated

Names of files imported by this file.

public_dependency10int32repeated

Indexes of the public imported files in the dependency list above.

weak_dependency11int32repeated

Indexes of the weak imported files in the dependency list. For Google-internal migration only. Do not use.

option_dependency15stringrepeated

Names of files imported by this file purely for the purpose of providing option extensions. These are excluded from the dependency list above.

message_type4DescriptorProtorepeated

All top-level definitions in this file.

enum_type5EnumDescriptorProtorepeated
service6ServiceDescriptorProtorepeated
extension7FieldDescriptorProtorepeated
options8FileOptionsoptional
source_code_info9SourceCodeInfooptional

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.

syntax12stringoptional

The syntax of the proto file. The supported values are "proto2", "proto3", and "editions".

If edition is present, this value must be "editions". WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

edition14Editionoptional

The edition of the proto file. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

Describes a message type.

NameTagTypeLabelDescription
name1stringoptional
field2FieldDescriptorProtorepeated
extension6FieldDescriptorProtorepeated
nested_type3DescriptorProtorepeated
enum_type4EnumDescriptorProtorepeated
extension_range5DescriptorProto.ExtensionRangerepeated
oneof_decl8OneofDescriptorProtorepeated
options7MessageOptionsoptional
reserved_range9DescriptorProto.ReservedRangerepeated
reserved_name10stringrepeated

Reserved field names, which may not be used by fields in the same message. A given name may only be reserved once.

visibility11SymbolVisibilityoptional

Support for export and local keywords on enums.

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.

NameTagTypeLabelDescription
start1int32optional

Inclusive.

end2int32optional

Exclusive.

NameTagTypeLabelDescription
uninterpreted_option999UninterpretedOptionrepeated

The parser stores options it doesn't recognize here. See above.

declaration2ExtensionRangeOptions.Declarationrepeated

For external users: DO NOT USE. We are in the process of open sourcing extension declaration and executing internal cleanups before it can be used externally.

features50FeatureSetoptional

Any features defined in the specific edition.

verification3ExtensionRangeOptions.VerificationStateoptional

The verification state of the range. TODO: flip the default to DECLARATION once all empty ranges are marked as UNVERIFIED.

NameTagTypeLabelDescription
number1int32optional

The extension number declared within the extension range.

full_name2stringoptional

The fully-qualified name of the extension field. There must be a leading dot in front of the full name.

type3stringoptional

The fully-qualified type name of the extension field. Unlike Metadata.type, Declaration.type must have a leading dot for messages and enums.

reserved5booloptional

If true, indicates that the number is reserved in the extension range, and any extension field with the number will fail to compile. Set this when a declared extension field is deleted.

repeated6booloptional

If true, indicates that the extension must be defined as repeated. Otherwise the extension must be defined as optional.

Describes a field within a message.

NameTagTypeLabelDescription
name1stringoptional
number3int32optional
label4FieldDescriptorProto.Labeloptional
type5FieldDescriptorProto.Typeoptional

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.

type_name6stringoptional

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).

extendee2stringoptional

For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.

default_value7stringoptional

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.

oneof_index9int32optional

If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.

json_name10stringoptional

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.

options8FieldOptionsoptional
proto3_optional17booloptional

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 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.

Describes an enum type.

NameTagTypeLabelDescription
name1stringoptional
value2EnumValueDescriptorProtorepeated
options3EnumOptionsoptional
reserved_range4EnumDescriptorProto.EnumReservedRangerepeated

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.

reserved_name5stringrepeated

Reserved enum value names, which may not be reused. A given name may only be reserved once.

visibility6SymbolVisibilityoptional

Support for export and local keywords on enums.

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.

NameTagTypeLabelDescription
start1int32optional

Inclusive.

end2int32optional

Inclusive.

Describes a method of a service.

NameTagTypeLabelDescription
name1stringoptional
input_type2stringoptional

Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type.

output_type3stringoptional
options4MethodOptionsoptional
client_streaming5booloptional

Identifies if client streams multiple client messages

server_streaming6booloptional

Identifies if server streams multiple server messages

NameTagTypeLabelDescription
java_package1stringoptional

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.

java_outer_classname8stringoptional

Controls the name of the wrapper Java class generated for the .proto file. That class will always contain the .proto file's getDescriptor() method as well as any top-level extensions defined in the .proto file. If java_multiple_files is disabled, then all the other classes from the .proto file will be nested inside the single wrapper outer class.

java_multiple_files10booloptional

If enabled, 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 wrapper class named by java_outer_classname. However, the wrapper class will still be generated to contain the file's getDescriptor() method as well as any top-level extensions defined in the file.

java_generate_equals_and_hashDeprecated20booloptional

This option does nothing.

java_string_check_utf827booloptional

A proto2 file can set this to true to opt in to UTF-8 checking for Java, which will throw an exception if invalid UTF-8 is parsed from the wire or assigned to a string field.

TODO: clarify exactly what kinds of field types this option applies to, and update these docs accordingly.

Proto3 files already perform these checks. Setting the option explicitly to false has no effect: it cannot be used to opt proto3 files out of UTF-8 checks.

optimize_for9FileOptions.OptimizeModeoptional
go_package11stringoptional

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.
cc_generic_services16booloptional

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.

java_generic_services17booloptional
py_generic_services18booloptional
deprecated23booloptional

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.

cc_enable_arenas31booloptional

Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

objc_class_prefix36stringoptional

Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.

csharp_namespace37stringoptional

Namespace for generated classes; defaults to the package.

swift_prefix39stringoptional

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_prefix40stringoptional

Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

php_namespace41stringoptional

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.

php_metadata_namespace44stringoptional

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.

ruby_package45stringoptional

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.

features50FeatureSetoptional

Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

uninterpreted_option999UninterpretedOptionrepeated

The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.

NameTagTypeLabelDescription
message_set_wire_format1booloptional

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.

no_standard_descriptor_accessor2booloptional

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".

deprecated3booloptional

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.

map_entry7booloptional

Whether the message is an automatically generated map entry type for the maps field.

For maps fields: map 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.

deprecated_legacy_json_field_conflictsDeprecated11booloptional

Enable the legacy handling of JSON field name conflicts. This lowercases and strips underscored from the fields before comparison in proto3 only. The new behavior takes json_name into account and applies to proto2 as well.

This should only be used as a temporary measure against broken builds due to the change in behavior for JSON field name conflicts.

TODO This is legacy behavior we plan to remove once downstream teams have had time to migrate.

features12FeatureSetoptional

Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

uninterpreted_option999UninterpretedOptionrepeated

The parser stores options it doesn't recognize here. See above.

NameTagTypeLabelDescription
ctype1FieldOptions.CTypeoptional

NOTE: ctype is deprecated. Use features.(pb.cpp).string_type instead. 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 only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated.

packed2booloptional

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. This option is prohibited in Editions, but the repeated_field_encoding feature can be used to control the behavior.

jstype6FieldOptions.JSTypeoptional

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.

lazy5booloptional

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 lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable).

unverified_lazy15booloptional

unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.

deprecated3booloptional

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.

weakDeprecated10booloptional

DEPRECATED. DO NOT USE! For Google-internal migration only. Do not use.

debug_redact16booloptional

Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.

retention17FieldOptions.OptionRetentionoptional
targets19FieldOptions.OptionTargetTyperepeated
edition_defaults20FieldOptions.EditionDefaultrepeated
features21FeatureSetoptional

Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

feature_support22FieldOptions.FeatureSupportoptional
uninterpreted_option999UninterpretedOptionrepeated

The parser stores options it doesn't recognize here. See above.

Information about the support window of a feature.

NameTagTypeLabelDescription
edition_introduced1Editionoptional

The edition that this feature was first available in. In editions earlier than this one, the default assigned to EDITION_LEGACY will be used, and proto files will not be able to override it.

edition_deprecated2Editionoptional

The edition this feature becomes deprecated in. Using this after this edition may trigger warnings.

deprecation_warning3stringoptional

The deprecation warning text if this feature is used after the edition it was marked deprecated in.

edition_removed4Editionoptional

The edition this feature is no longer available in. In editions after this one, the last default assigned will be used, and proto files will not be able to override it.

removal_error5stringoptional

The removal error text if this feature is used after the edition it was removed in.

NameTagTypeLabelDescription
features1FeatureSetoptional

Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

uninterpreted_option999UninterpretedOptionrepeated

The parser stores options it doesn't recognize here. See above.

NameTagTypeLabelDescription
allow_alias2booloptional

Set this option to true to allow mapping different tag names to the same value.

deprecated3booloptional

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.

deprecated_legacy_json_field_conflictsDeprecated6booloptional

Enable the legacy handling of JSON field name conflicts. This lowercases and strips underscored from the fields before comparison in proto3 only. The new behavior takes json_name into account and applies to proto2 as well. TODO Remove this legacy behavior once downstream teams have had time to migrate.

features7FeatureSetoptional

Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

uninterpreted_option999UninterpretedOptionrepeated

The parser stores options it doesn't recognize here. See above.

NameTagTypeLabelDescription
deprecated1booloptional

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.

features2FeatureSetoptional

Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

debug_redact3booloptional

Indicate that fields annotated with this enum value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.

feature_support4FieldOptions.FeatureSupportoptional

Information about the support window of a feature value.

uninterpreted_option999UninterpretedOptionrepeated

The parser stores options it doesn't recognize here. See above.

NameTagTypeLabelDescription
features34FeatureSetoptional

Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

deprecated33booloptional

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.

uninterpreted_option999UninterpretedOptionrepeated

The parser stores options it doesn't recognize here. See above.

NameTagTypeLabelDescription
deprecated33booloptional

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.

idempotency_level34MethodOptions.IdempotencyLeveloptional
features35FeatureSetoptional

Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

uninterpreted_option999UninterpretedOptionrepeated

The parser stores options it doesn't recognize here. See above.

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.

NameTagTypeLabelDescription
name2UninterpretedOption.NamePartrepeated
identifier_value3stringoptional

The value of the uninterpreted option, in whatever type the tokenizer identified it as during parsing. Exactly one of these should be set.

positive_int_value4uint64optional
negative_int_value5int64optional
double_value6doubleoptional
string_value7bytesoptional
aggregate_value8stringoptional

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".

NameTagTypeLabelDescription
name_part1stringoptional
is_extension2booloptional

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.

NameTagTypeLabelDescription
field_presence1FeatureSet.FieldPresenceoptional
enum_type2FeatureSet.EnumTypeoptional
repeated_field_encoding3FeatureSet.RepeatedFieldEncodingoptional
utf8_validation4FeatureSet.Utf8Validationoptional
message_encoding5FeatureSet.MessageEncodingoptional
json_format6FeatureSet.JsonFormatoptional
enforce_naming_style7FeatureSet.EnforceNamingStyleoptional
default_symbol_visibility8FeatureSet.VisibilityFeature.DefaultSymbolVisibilityoptional
enforce_proto_limits9FeatureSet.ProtoLimitsFeature.EnforceProtoLimitsoptional

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.

NameTagTypeLabelDescription
defaults1FeatureSetDefaults.FeatureSetEditionDefaultrepeated
minimum_edition4Editionoptional

The minimum supported edition (inclusive) when this was constructed. Editions before this will not have defaults.

maximum_edition5Editionoptional

The maximum known edition (inclusive) when this was constructed. Editions after this will not have reliable defaults.

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.

NameTagTypeLabelDescription
edition3Editionoptional
overridable_features4FeatureSetoptional

Defaults of features that can be overridden in this edition.

fixed_features5FeatureSetoptional

Defaults of features that can't be overridden in this edition.

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

NameTagTypeLabelDescription
location1SourceCodeInfo.Locationrepeated

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.
NameTagTypeLabelDescription
path1int32repeated

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 appears. 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).

For options, the path refers to the interpreted option in the descriptor. E.g., for a custom option (my_opt) = "foo" on a message using extension number 10101, the path is: [ 4, 3, 7, 10101 ] refers to: file.message_type(3) // 4, 3 .options() // 7 .my_opt() // 10101

Sub-locations corresponding to the interpreted option's corresponding UninterpretedOption are also appended to the interpreted option, which deviates from the actual FileDescriptorProto path. E.g.: [ 4, 3, 7, 10101, 2 ] refers to the option name (my_opt), and: [ 4, 3, 7, 10101, 7 ] refers to the "foo" string value of the option.

span2int32repeated

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_comments3stringoptional

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 moo. // // Another line attached to moo. optional double moo = 4;

// Detached comment for corge. This is not leading or trailing comments // to moo 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_comments4stringoptional
leading_detached_comments6stringrepeated

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.

NameTagTypeLabelDescription
annotation1GeneratedCodeInfo.Annotationrepeated

An Annotation connects some span of text in generated code to an element of its generating .proto file.

NameTagTypeLabelDescription
path1int32repeated

Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path.

source_file2stringoptional

Identifies the filesystem path to the original source .proto.

begin3int32optional

Identifies the starting offset in bytes in the generated code that relates to the identified object.

end4int32optional

Identifies the ending offset in bytes in the generated code that relates to the identified object. The end offset should be one past the last relevant byte (so the length of the text = end - begin).

semantic5GeneratedCodeInfo.Annotation.Semanticoptional

A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.

Examples

Example 1: Compute Duration from two Timestamps in pseudo code.

Timestamp start = ...; Timestamp end = ...; Duration duration = ...;

duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;

if (duration.seconds < 0 && duration.nanos > 0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (duration.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }

Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.

Timestamp start = ...; Duration duration = ...; Timestamp end = ...;

end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;

if (end.nanos < 0) { end.seconds -= 1; end.nanos += 1000000000; } else if (end.nanos >= 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }

Example 3: Compute Duration from datetime.timedelta in Python.

td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)

JSON Mapping

In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".

NameTagTypeLabelDescription
seconds1int64optional

Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos2int32optional

Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 seconds field and a positive or negative nanos field. For durations of one second or more, a non-zero value for the nanos field must be of the same sign as the seconds field. Must be from -999,999,999 to +999,999,999 inclusive.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

No fields.

FieldMask represents a set of symbolic field paths, for example:

paths: "f.a" paths: "f.b.d"

Here f represents a field in some root message, a and b fields in the message found in f, and d a field found in the message in f.b.

Field masks are used to specify a subset of fields that should be returned by a get operation or modified by an update operation. Field masks also have a custom JSON encoding (see below).

Field Masks in Projections

When used in the context of a projection, a response message or sub-message is filtered by the API to only contain those fields as specified in the mask. For example, if the mask in the previous example is applied to a response message as follows:

f { a : 22 b { d : 1 x : 2 } y : 13 } z: 8

The result will not contain specific values for fields x,y and z (their value will be set to the default, and omitted in proto text output):

f { a : 22 b { d : 1 } }

A repeated field is not allowed except at the last position of a paths string.

If a FieldMask object is not present in a get operation, the operation applies to all fields (as if a FieldMask of all fields had been specified).

Note that a field mask does not necessarily apply to the top-level response message. In case of a REST get operation, the field mask applies directly to the response, but in case of a REST list operation, the mask instead applies to each individual message in the returned resource list. In case of a REST custom method, other definitions may be used. Where the mask applies will be clearly documented together with its declaration in the API. In any case, the effect on the returned resource/resources is required behavior for APIs.

Field Masks in Update Operations

A field mask in update operations specifies which fields of the targeted resource are going to be updated. The API is required to only change the values of the fields as specified in the mask and leave the others untouched. If a resource is passed in to describe the updated values, the API ignores the values of all fields not covered by the mask.

If a repeated field is specified for an update operation, new values will be appended to the existing repeated field in the target resource. Note that a repeated field is only allowed in the last position of a paths string.

If a sub-message is specified in the last position of the field mask for an update operation, then new value will be merged into the existing sub-message in the target resource.

For example, given the target message:

f { b { d: 1 x: 2 } c: [1] }

And an update message:

f { b { d: 10 } c: [2] }

then if the field mask is:

paths: ["f.b", "f.c"]

then the result will be:

f { b { d: 10 x: 2 } c: [1, 2] }

An implementation may provide options to override this default behavior for repeated and message fields.

Note that libraries which implement FieldMask resolution have various different behaviors in the face of empty masks or the special "*" mask. When implementing a service you should confirm these cases have the appropriate behavior in the underlying FieldMask library that you desire, and you may need to special case those cases in your application code if the underlying field mask library behavior differs from your intended service semantics.

Update methods implementing https://google.aip.dev/134

  • MUST support the special value * meaning "full replace"
  • MUST treat an omitted field mask as "replace fields which are present".

Other methods implementing https://google.aip.dev/157

  • SHOULD support the special value "*" to mean "get all".
  • MUST treat an omitted field mask to mean "get all", unless otherwise documented.

Considerations for HTTP REST

The HTTP kind of an update operation which uses a field mask must be set to PATCH instead of PUT in order to satisfy HTTP semantics (PUT must only be used for full updates).

JSON Encoding of Field Masks

In JSON, a field mask is encoded as a single string where paths are separated by a comma. Fields name in each path are converted to/from lower-camel naming conventions.

As an example, consider the following message declarations:

message Profile { User user = 1; Photo photo = 2; } message User { string display_name = 1; string address = 2; }

In proto a field mask for Profile may look as such:

mask { paths: "user.display_name" paths: "photo" }

In JSON, the same mask is represented as below:

{ mask: "user.displayName,photo" }

Field Masks and Oneof Fields

Field masks treat fields in oneofs just as regular fields. Consider the following message:

message SampleMessage { oneof test_oneof { string name = 4; SubMessage sub_message = 9; } }

The field mask can be:

mask { paths: "name" }

Or:

mask { paths: "sub_message" }

Note that oneof type names ("test_oneof" in this case) cannot be used in paths.

Field Mask Verification

The implementation of any API method which has a FieldMask type field in the request should verify the included field paths, and return an INVALID_ARGUMENT error if any path is unmappable.

NameTagTypeLabelDescription
paths1stringrepeated

The set of field mask paths.

SourceContext represents information about the source of a protobuf element, like the file in which it is defined.

NameTagTypeLabelDescription
file_name1stringoptional

The path-qualified name of the .proto file that contained the associated protobuf element. For example: "google/protobuf/source_context.proto".

Represents a JSON object.

An unordered key-value map, intending to perfectly capture the semantics of a JSON object. This enables parsing any arbitrary JSON payload as a message field in ProtoJSON format.

This follows RFC 8259 guidelines for interoperable JSON: notably this type cannot represent large Int64 values or NaN/Infinity numbers, since the JSON format generally does not support those values in its number type.

If you do not intend to parse arbitrary JSON into your message, a custom typed message should be preferred instead of using this type.

NameTagTypeLabelDescription
fields1map<string, Value>map

Unordered map of dynamically typed values.

Represents a JSON value.

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant is an invalid state.

NameTagTypeLabelDescription
null_value1NullValueoptional

Represents a JSON null.

number_value2doubleoptional

Represents a JSON number. Must not be NaN, Infinity or -Infinity, since those are not supported in JSON. This also cannot represent large Int64 values, since JSON format generally does not support them in its number type.

string_value3stringoptional

Represents a JSON string.

bool_value4booloptional

Represents a JSON boolean (true or false literal in JSON).

struct_value5Structoptional

Represents a JSON object.

list_value6ListValueoptional

Represents a JSON array.

Represents a JSON array.

NameTagTypeLabelDescription
values1Valuerepeated

Repeated field of dynamically typed values.

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv; gettimeofday(&tv, NULL);

Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

Instant now = Instant.now();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

timestamp = Timestamp() timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A ProtoJSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a ProtoJSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

NameTagTypeLabelDescription
seconds1int64optional

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be between -62135596800 and 253402300799 inclusive (which corresponds to 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).

nanos2int32optional

Non-negative fractions of a second at nanosecond resolution. This field is the nanosecond portion of the duration, not an alternative to seconds. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be between 0 and 999,999,999 inclusive.

A protocol buffer message type.

New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.

NameTagTypeLabelDescription
name1stringoptional

The fully qualified message name.

fields2Fieldrepeated

The list of fields.

oneofs3stringrepeated

The list of types appearing in oneof definitions in this type.

options4Optionrepeated

The protocol buffer options.

source_context5SourceContextoptional

The source context.

syntax6Syntaxoptional

The source syntax.

edition7stringoptional

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

A single field of a message type.

New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.

NameTagTypeLabelDescription
kind1Field.Kindoptional

The field type.

cardinality2Field.Cardinalityoptional

The field cardinality.

number3int32optional

The field number.

name4stringoptional

The field name.

type_url6stringoptional

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

oneof_index7int32optional

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

packed8booloptional

Whether to use alternative packed wire representation.

options9Optionrepeated

The protocol buffer options.

json_name10stringoptional

The field JSON name.

default_value11stringoptional

The string value of the default value of this field. Proto2 syntax only.

Enum type definition.

New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.

NameTagTypeLabelDescription
name1stringoptional

Enum type name.

enumvalue2EnumValuerepeated

Enum value definitions.

options3Optionrepeated

Protocol buffer options.

source_context4SourceContextoptional

The source context.

syntax5Syntaxoptional

The source syntax.

edition6stringoptional

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

Enum value definition.

New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.

NameTagTypeLabelDescription
name1stringoptional

Enum value name.

number2int32optional

Enum value number.

options3Optionrepeated

Protocol buffer options.

A protocol buffer option, which can be attached to a message, field, enumeration, etc.

New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged.

NameTagTypeLabelDescription
name1stringoptional

The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, "map_entry". For custom options, it should be the fully-qualified name. For example, "google.api.http".

value2Anyoptional

The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.

Wrapper message for double.

The JSON representation for DoubleValue is JSON number.

Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.

NameTagTypeLabelDescription
value1doubleoptional

The double value.

Wrapper message for float.

The JSON representation for FloatValue is JSON number.

Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.

NameTagTypeLabelDescription
value1floatoptional

The float value.

Wrapper message for int64.

The JSON representation for Int64Value is JSON string.

Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.

NameTagTypeLabelDescription
value1int64optional

The int64 value.

Wrapper message for uint64.

The JSON representation for UInt64Value is JSON string.

Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.

NameTagTypeLabelDescription
value1uint64optional

The uint64 value.

Wrapper message for int32.

The JSON representation for Int32Value is JSON number.

Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.

NameTagTypeLabelDescription
value1int32optional

The int32 value.

Wrapper message for uint32.

The JSON representation for UInt32Value is JSON number.

Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.

NameTagTypeLabelDescription
value1uint32optional

The uint32 value.

Wrapper message for bool.

The JSON representation for BoolValue is JSON true and false.

Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.

NameTagTypeLabelDescription
value1booloptional

The bool value.

Wrapper message for string.

The JSON representation for StringValue is JSON string.

Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.

NameTagTypeLabelDescription
value1stringoptional

The string value.

Wrapper message for bytes.

The JSON representation for BytesValue is JSON string.

Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.

NameTagTypeLabelDescription
value1bytesoptional

The bytes value.

Enums

NameValueDescription
TYPE_DOUBLE1

0 is reserved for errors. Order is weird for historical reasons.

TYPE_FLOAT2
TYPE_INT643

Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if negative values are likely.

TYPE_UINT644
TYPE_INT325

Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if negative values are likely.

TYPE_FIXED646
TYPE_FIXED327
TYPE_BOOL8
TYPE_STRING9
TYPE_GROUP10

Tag-delimited aggregate. Group type is deprecated and not supported after google.protobuf. However, Proto3 implementations should still be able to parse the group wire format and treat group fields as unknown fields. In Editions, the group wire format can be enabled via the message_encoding feature.

TYPE_MESSAGE11

Length-delimited aggregate.

TYPE_BYTES12

New in version 2.

TYPE_UINT3213
TYPE_ENUM14
TYPE_SFIXED3215
TYPE_SFIXED6416
TYPE_SINT3217

Uses ZigZag encoding.

TYPE_SINT6418

Uses ZigZag encoding.

NameValueDescription
LABEL_OPTIONAL1

0 is reserved for errors

LABEL_REPEATED3
LABEL_REQUIRED2

The required label is only allowed in google.protobuf. In proto3 and Editions it's explicitly prohibited. In Editions, the field_presence feature can be used to get this behavior.

Generated classes can be optimized for speed or code size.

NameValueDescription
SPEED1

Generate complete code for parsing, serialization,

CODE_SIZE2

etc.

LITE_RUNTIME3

Generate code using MessageLite and the lite runtime.

NameValueDescription
STRING0

Default mode.

CORD1

The option [ctype=CORD] may be applied to a non-repeated field of type "bytes". It indicates that in C++, the data should be stored in a Cord instead of a string. For very large strings, this may reduce memory fragmentation. It may also allow better performance when parsing from a Cord, or when parsing with aliasing enabled, as the parsed Cord may then alias the original buffer.

STRING_PIECE2

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.

NameValueDescription
TARGET_TYPE_UNKNOWN0
TARGET_TYPE_FILE1
TARGET_TYPE_EXTENSION_RANGE2
TARGET_TYPE_MESSAGE3
TARGET_TYPE_FIELD4
TARGET_TYPE_ONEOF5
TARGET_TYPE_ENUM6
TARGET_TYPE_ENUM_ENTRY7
TARGET_TYPE_SERVICE8
TARGET_TYPE_METHOD9

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.

NameValueDescription
IDEMPOTENCY_UNKNOWN0
NO_SIDE_EFFECTS1

implies idempotent

IDEMPOTENT2

idempotent, but may have side effects

NameValueDescription
DEFAULT_SYMBOL_VISIBILITY_UNKNOWN0
EXPORT_ALL1

Default pre-EDITION_2024, all UNSET visibility are export.

EXPORT_TOP_LEVEL2

All top-level symbols default to export, nested default to local.

LOCAL_ALL3

All symbols default to local.

STRICT4

All symbols local by default. Nested types cannot be exported. With special case caveat for message { enum {} reserved 1 to max; } This is the recommended setting for new protos.

NameValueDescription
PROTO_LIMITS_UNKNOWN0
LEGACY_NO_EXPLICIT_LIMITS1

Default pre-EDITION_2026: there are no limit enforcement at the protoc level. Practical limits still exist, but they will tend to fail while compiling protoc-generated code, and these limits tend to be language or toolchain specific.

PROTO_LIMITS20262

A set of limits enforced by Edition 2026 by default. For a detailed list of all the limits please consult the Edition 2026 documentation.

Represents the identified object's effect on the element in the original .proto file.

NameValueDescription
NONE0

There is no effect or the effect is indescribable.

SET1

The element is set or otherwise mutated.

ALIAS2

An alias to the element is returned.

The full set of known editions.

NameValueDescription
EDITION_UNKNOWN0

A placeholder for an unknown edition value.

EDITION_LEGACY900

A placeholder edition for specifying default behaviors before a feature was first introduced. This is effectively an "infinite past".

EDITION_PROTO2998

Legacy syntax "editions". These pre-date editions, but behave much like distinct editions. These can't be used to specify the edition of proto files, but feature definitions must supply proto2/proto3 defaults for backwards compatibility.

EDITION_PROTO3999
EDITION_20231000

Editions that have been released. The specific values are arbitrary and should not be depended on, but they will always be time-ordered for easy comparison.

EDITION_20241001
EDITION_20261002
EDITION_UNSTABLE9999

A placeholder edition for developing and testing unscheduled features.

EDITION_1_TEST_ONLY1

Placeholder editions for testing feature resolution. These should not be used or relied on outside of tests.

EDITION_2_TEST_ONLY2
EDITION_99997_TEST_ONLY99997
EDITION_99998_TEST_ONLY99998
EDITION_99999_TEST_ONLY99999
EDITION_MAX2147483647

Placeholder for specifying unbounded edition support. This should only ever be used by plugins that can expect to never require any changes to support a new edition.

Describes the 'visibility' of a symbol with respect to the proto import system. Symbols can only be imported when the visibility rules do not prevent it (ex: local symbols cannot be imported). Visibility modifiers can only set on message and enum as they are the only types available to be referenced from other files.

NameValueDescription
VISIBILITY_UNSET0
VISIBILITY_LOCAL1
VISIBILITY_EXPORT2

Represents a JSON null.

NullValue is a sentinel, using an enum with only one value to represent the null value for the Value type union.

A field of type NullValue with any value other than 0 is considered invalid. Most ProtoJSON serializers will emit a Value with a null_value set as a JSON null regardless of the integer value, and so will round trip to a 0 value.

NameValueDescription
NULL_VALUE0

Null value.

Basic field types.

NameValueDescription
TYPE_UNKNOWN0

Field type unknown.

TYPE_DOUBLE1

Field type double.

TYPE_FLOAT2

Field type float.

TYPE_INT643

Field type int64.

TYPE_UINT644

Field type uint64.

TYPE_INT325

Field type int32.

TYPE_FIXED646

Field type fixed64.

TYPE_FIXED327

Field type fixed32.

TYPE_BOOL8

Field type bool.

TYPE_STRING9

Field type string.

TYPE_GROUP10

Field type group. Proto2 syntax only, and deprecated.

TYPE_MESSAGE11

Field type message.

TYPE_BYTES12

Field type bytes.

TYPE_UINT3213

Field type uint32.

TYPE_ENUM14

Field type enum.

TYPE_SFIXED3215

Field type sfixed32.

TYPE_SFIXED6416

Field type sfixed64.

TYPE_SINT3217

Field type sint32.

TYPE_SINT6418

Field type sint64.

Whether a field is optional, required, or repeated.

NameValueDescription
CARDINALITY_UNKNOWN0

For fields with unknown cardinality.

CARDINALITY_OPTIONAL1

For optional fields.

CARDINALITY_REQUIRED2

For required fields. Proto2 syntax only.

CARDINALITY_REPEATED3

For repeated fields.

The syntax in which a protocol buffer element is defined.

NameValueDescription
SYNTAX_PROTO20

Syntax proto2.

SYNTAX_PROTO31

Syntax proto3.

SYNTAX_EDITIONS2

Syntax editions.