Ä. google/protobuf/any.protogoogle.protobuf"6 Any type_url ( RtypeUrl value (RvalueBv com.google.protobufBAnyProtoPZ,google.golang.org/protobuf/types/known/anypb¢GPBªGoogle.Protobuf.WellKnownTypesJÝ, ¡ Ì 2Á Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. "C "C #, #, $) $) %" %" &! $&! '; %'; ü ¡î `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } ¼ A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. W I Must be a valid serialized protocol buffer of the above specified type. bproto3 ¾ $google/protobuf/source_context.protogoogle.protobuf", SourceContext file_name ( RfileNameBŠ com.google.protobufBSourceContextProtoPZ6google.golang.org/protobuf/types/known/sourcecontextpb¢GPBªGoogle.Protobuf.WellKnownTypesJÁ / Ì 2Á Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ", ", #3 #3 $" $" %! $%! &; %&; 'M 'M ƒ +/w `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. + £ .• The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. . . .bproto3 ûI google/protobuf/type.protogoogle.protobufgoogle/protobuf/any.proto$google/protobuf/source_context.proto"§ Type name ( Rname. fields (2.google.protobuf.FieldRfields oneofs ( Roneofs1 options (2.google.protobuf.OptionRoptionsE source_context (2.google.protobuf.SourceContextR sourceContext/ syntax (2.google.protobuf.SyntaxRsyntax edition ( Redition"´ Field/ kind (2.google.protobuf.Field.KindRkindD cardinality (2".google.protobuf.Field.CardinalityRcardinality number (Rnumber name ( Rname type_url ( RtypeUrl oneof_index (R oneofIndex packed (Rpacked1 options (2.google.protobuf.OptionRoptions json_name ( RjsonName# default_value ( RdefaultValue"È Kind TYPE_UNKNOWN TYPE_DOUBLE TYPE_FLOAT TYPE_INT64 TYPE_UINT64 TYPE_INT32 TYPE_FIXED64 TYPE_FIXED32 TYPE_BOOL TYPE_STRING TYPE_GROUP TYPE_MESSAGE TYPE_BYTES TYPE_UINT32 TYPE_ENUM TYPE_SFIXED32 TYPE_SFIXED64 TYPE_SINT32 TYPE_SINT64"t Cardinality CARDINALITY_UNKNOWN CARDINALITY_OPTIONAL CARDINALITY_REQUIRED CARDINALITY_REPEATED"™ Enum name ( Rname8 enumvalue (2.google.protobuf.EnumValueR enumvalue1 options (2.google.protobuf.OptionRoptionsE source_context (2.google.protobuf.SourceContextR sourceContext/ syntax (2.google.protobuf.SyntaxRsyntax edition ( Redition"j EnumValue name ( Rname number (Rnumber1 options (2.google.protobuf.OptionRoptions"H Option name ( Rname* value (2.google.protobuf.AnyRvalue*C Syntax SYNTAX_PROTO2 SYNTAX_PROTO3 SYNTAX_EDITIONSB{ com.google.protobufB TypeProtoPZ-google.golang.org/protobuf/types/known/typepbø¢GPBªGoogle.Protobuf.WellKnownTypesJ; À Ì 2Á Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. "# #. % % &, &, '* '* (" (" )! $)! *; %*; +D +D - .=! A protocol buffer message type. . 0 0# The fully qualified message name. 0 0 0 " 2 The list of fields. 2 2 2 2 O 4B The list of types appearing in `oneof` definitions in this type. 4 4 4 4 + 6 The protocol buffer options. 6 6 6 6 " 8# The source context. 8 8 8!" ! : The source syntax. : : : T <G The source edition string, only valid when syntax is SYNTAX_EDITIONS. < < < 0 @# A single field of a message type. @ " Bi Basic field types. B $ D Field type unknown. D D # F Field type double. F F " H Field type float. H H " J Field type int64. J J # L Field type uint64. L L " N Field type int32. N N $ P Field type fixed64. P P $ R Field type fixed32. R R ! T Field type bool. T T # V Field type string. V V F X7 Field type group. Proto2 syntax only, and deprecated. X X $ Z Field type message. Z Z " \ Field type bytes. \ \ # ^ Field type uint32. ^ ^ ! ` Field type enum. ` ` % b Field type sfixed32. b b % d Field type sfixed64. d d # f Field type sint32. f f # h Field type sint64. h h C lu5 Whether a field is optional, required, or repeated. l 5 n& For fields with unknown cardinality. n n % p For optional fields. p p 9 r* For required fields. Proto2 syntax only. r r % t For repeated fields. t t x The field type. x x x % z The field cardinality. z z z | The field number. | | | ~ The field name. ~ ~ ~ — ˆ The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. ¥ „– 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. „ „ „ F †8 Whether to use alternative packed wire representation. † † † , ˆ The protocol buffer options. ˆ ˆ ˆ ˆ $ Š The field JSON name. Š Š Š X ŒJ The string value of the default value of this field. Proto2 syntax only. Œ Œ Œ % Enum type definition. ’ Enum type name. ’ ’ ’ ' ”# Enum value definitions. ” ” ” ”!" ( – Protocol buffer options. – – – – # ˜# The source context. ˜ ˜ ˜!" " š The source syntax. š š š U œG The source edition string, only valid when syntax is SYNTAX_EDITIONS. œ œ œ & § Enum value definition. ¢ Enum value name. ¢ ¢ ¢ " ¤ Enum value number. ¤ ¤ ¤ ( ¦ Protocol buffer options. ¦ ¦ ¦ ¦ g «¶Y A protocol buffer option, which can be attached to a message, field, enumeration, etc. « ü °í 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"`. ° ° ° µ‘ 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. µ µ µ I ¹À; The syntax in which a protocol buffer element is defined. ¹ » Syntax `proto2`. » » ½ Syntax `proto3`. ½ ½ " ¿ Syntax `editions`. ¿ ¿bproto3 šC google/protobuf/api.protogoogle.protobuf$google/protobuf/source_context.protogoogle/protobuf/type.proto"Á Api name ( Rname1 methods (2.google.protobuf.MethodRmethods1 options (2.google.protobuf.OptionRoptions version ( RversionE source_context (2.google.protobuf.SourceContextR sourceContext. mixins (2.google.protobuf.MixinRmixins/ syntax (2.google.protobuf.SyntaxRsyntax"² Method name ( Rname( request_type_url ( RrequestTypeUrl+ request_streaming (RrequestStreaming* response_type_url ( RresponseTypeUrl- response_streaming (RresponseStreaming1 options (2.google.protobuf.OptionRoptions/ syntax (2.google.protobuf.SyntaxRsyntax"/ Mixin name ( Rname root ( RrootBv com.google.protobufBApiProtoPZ,google.golang.org/protobuf/types/known/apipb¢GPBªGoogle.Protobuf.WellKnownTypesJÿ; Î Ì 2Á Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ". #$ %, %, &) &) '" '" (! $(! ); %); *C *C « 5_ž 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. 5 { 8n The fully qualified name of this interface, including package name followed by the interface's simple name. 8 8 8 C ;6 The methods of this interface, in unspecified order. ; ; ; ; 6 >) Any metadata attached to the interface. > > > > Tó 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](http://semver.org) 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. T T T [ X#N Source context for the protocol buffer service represented by this message. X X X!" 2 [% Included interfaces. See [Mixin][]. [ [ [ [ 0 ^# The source syntax of the service. ^ ^ ^ = bw1 Method represents a method of an API interface. b . d! The simple name of this method. d d d / g" A URL of the input message type. g g g 0 j# If true, the request is streamed. j j j 2 m% The URL of the output message type. m m m 1 p$ If true, the response is streamed. p p p 3 s& Any metadata attached to the method. s s s s 0 v# The source syntax of this method. v v v É ÇÎº 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 inherting 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"; } ... } Ç L É> The fully qualified name of the interface which is included. É É É [ ÍM If non-empty specifies a path under which inherited HTTP paths are rooted. Í Í Íbproto3 õ google/protobuf/descriptor.protogoogle.protobuf"M FileDescriptorSet8 file (2$.google.protobuf.FileDescriptorProtoRfile"þ FileDescriptorProto name ( Rname package ( Rpackage dependency ( R dependency+ public_dependency (RpublicDependency' weak_dependency (RweakDependencyC message_type (2 .google.protobuf.DescriptorProtoRmessageTypeA enum_type (2$.google.protobuf.EnumDescriptorProtoRenumTypeA service (2'.google.protobuf.ServiceDescriptorProtoRserviceC extension (2%.google.protobuf.FieldDescriptorProtoR extension6 options (2.google.protobuf.FileOptionsRoptionsI source_code_info (2.google.protobuf.SourceCodeInfoRsourceCodeInfo syntax ( Rsyntax edition ( Redition"¹ DescriptorProto name ( Rname; field (2%.google.protobuf.FieldDescriptorProtoRfieldC extension (2%.google.protobuf.FieldDescriptorProtoR extensionA nested_type (2 .google.protobuf.DescriptorProtoR nestedTypeA enum_type (2$.google.protobuf.EnumDescriptorProtoRenumTypeX extension_range (2/.google.protobuf.DescriptorProto.ExtensionRangeRextensionRangeD oneof_decl (2%.google.protobuf.OneofDescriptorProtoR oneofDecl9 options (2.google.protobuf.MessageOptionsRoptionsU reserved_range (2..google.protobuf.DescriptorProto.ReservedRangeR reservedRange# reserved_name ( RreservedNamez ExtensionRange start (Rstart end (Rend@ options (2&.google.protobuf.ExtensionRangeOptionsRoptions7 ReservedRange start (Rstart end (Rend"Ç ExtensionRangeOptionsX uninterpreted_optionç (2$.google.protobuf.UninterpretedOptionRuninterpretedOptionY declaration (22.google.protobuf.ExtensionRangeOptions.DeclarationBˆRdeclaration7 features2 (2.google.protobuf.FeatureSetRfeaturesh verification (28.google.protobuf.ExtensionRangeOptions.VerificationState: UNVERIFIEDRverification” Declaration number (Rnumber full_name ( RfullName type ( Rtype reserved (Rreserved repeated (RrepeatedJ"4 VerificationState DECLARATION UNVERIFIED* è€€€€"Á FieldDescriptorProto name ( Rname number (RnumberA label (2+.google.protobuf.FieldDescriptorProto.LabelRlabel> type (2*.google.protobuf.FieldDescriptorProto.TypeRtype type_name ( RtypeName extendee ( Rextendee# default_value ( RdefaultValue oneof_index (R oneofIndex json_name ( RjsonName7 options (2.google.protobuf.FieldOptionsRoptions' proto3_optional (Rproto3Optional"¶ Type TYPE_DOUBLE TYPE_FLOAT TYPE_INT64 TYPE_UINT64 TYPE_INT32 TYPE_FIXED64 TYPE_FIXED32 TYPE_BOOL TYPE_STRING TYPE_GROUP TYPE_MESSAGE TYPE_BYTES TYPE_UINT32 TYPE_ENUM TYPE_SFIXED32 TYPE_SFIXED64 TYPE_SINT32 TYPE_SINT64"C Label LABEL_OPTIONAL LABEL_REQUIRED LABEL_REPEATED"c OneofDescriptorProto name ( Rname7 options (2.google.protobuf.OneofOptionsRoptions"ã EnumDescriptorProto name ( Rname? value (2).google.protobuf.EnumValueDescriptorProtoRvalue6 options (2.google.protobuf.EnumOptionsRoptions] reserved_range (26.google.protobuf.EnumDescriptorProto.EnumReservedRangeR reservedRange# reserved_name ( RreservedName; EnumReservedRange start (Rstart end (Rend"ƒ EnumValueDescriptorProto name ( Rname number (Rnumber; options (2!.google.protobuf.EnumValueOptionsRoptions"§ ServiceDescriptorProto name ( Rname> method (2&.google.protobuf.MethodDescriptorProtoRmethod9 options (2.google.protobuf.ServiceOptionsRoptions"‰ MethodDescriptorProto name ( Rname input_type ( R inputType output_type ( R outputType8 options (2.google.protobuf.MethodOptionsRoptions0 client_streaming (:falseRclientStreaming0 server_streaming (:falseRserverStreaming"Ê FileOptions! java_package ( RjavaPackage0 java_outer_classname ( RjavaOuterClassname5 java_multiple_files (:falseRjavaMultipleFilesD java_generate_equals_and_hash (BRjavaGenerateEqualsAndHash: java_string_check_utf8 (:falseRjavaStringCheckUtf8S optimize_for (2).google.protobuf.FileOptions.OptimizeMode:SPEEDRoptimizeFor go_package ( R goPackage5 cc_generic_services (:falseRccGenericServices9 java_generic_services (:falseRjavaGenericServices5 py_generic_services (:falseRpyGenericServices7 php_generic_services* (:falseRphpGenericServices% deprecated (:falseR deprecated. cc_enable_arenas (:trueRccEnableArenas* objc_class_prefix$ ( RobjcClassPrefix) csharp_namespace% ( RcsharpNamespace! swift_prefix' ( RswiftPrefix( php_class_prefix( ( RphpClassPrefix# php_namespace) ( RphpNamespace4 php_metadata_namespace, ( RphpMetadataNamespace! ruby_package- ( RrubyPackage7 features2 (2.google.protobuf.FeatureSetRfeaturesX uninterpreted_optionç (2$.google.protobuf.UninterpretedOptionRuninterpretedOption": OptimizeMode SPEED CODE_SIZE LITE_RUNTIME* è€€€€J&'"ô MessageOptions< message_set_wire_format (:falseRmessageSetWireFormatL no_standard_descriptor_accessor (:falseRnoStandardDescriptorAccessor% deprecated (:falseR deprecated map_entry (RmapEntryV &deprecated_legacy_json_field_conflicts (BR"deprecatedLegacyJsonFieldConflicts7 features (2.google.protobuf.FeatureSetRfeaturesX uninterpreted_optionç (2$.google.protobuf.UninterpretedOptionRuninterpretedOption* è€€€€JJJJ J "“ FieldOptionsA ctype (2#.google.protobuf.FieldOptions.CType:STRINGRctype packed (RpackedG jstype (2$.google.protobuf.FieldOptions.JSType: JS_NORMALRjstype lazy (:falseRlazy. unverified_lazy (:falseRunverifiedLazy% deprecated (:falseR deprecated weak (:falseRweak( debug_redact (:falseRdebugRedactK retention (2-.google.protobuf.FieldOptions.OptionRetentionR retentionH targets (2..google.protobuf.FieldOptions.OptionTargetTypeRtargetsW edition_defaults (2,.google.protobuf.FieldOptions.EditionDefaultReditionDefaults7 features (2.google.protobuf.FeatureSetRfeaturesX uninterpreted_optionç (2$.google.protobuf.UninterpretedOptionRuninterpretedOption@ EditionDefault edition ( Redition value ( Rvalue"/ CType STRING CORD STRING_PIECE"5 JSType JS_NORMAL JS_STRING JS_NUMBER"U OptionRetention RETENTION_UNKNOWN RETENTION_RUNTIME RETENTION_SOURCE"Œ OptionTargetType TARGET_TYPE_UNKNOWN TARGET_TYPE_FILE TARGET_TYPE_EXTENSION_RANGE TARGET_TYPE_MESSAGE TARGET_TYPE_FIELD TARGET_TYPE_ONEOF TARGET_TYPE_ENUM TARGET_TYPE_ENUM_ENTRY TARGET_TYPE_SERVICE TARGET_TYPE_METHOD * è€€€€JJ"¬ OneofOptions7 features (2.google.protobuf.FeatureSetRfeaturesX uninterpreted_optionç (2$.google.protobuf.UninterpretedOptionRuninterpretedOption* è€€€€"Ñ EnumOptions allow_alias (R allowAlias% deprecated (:falseR deprecatedV &deprecated_legacy_json_field_conflicts (BR"deprecatedLegacyJsonFieldConflicts7 features (2.google.protobuf.FeatureSetRfeaturesX uninterpreted_optionç (2$.google.protobuf.UninterpretedOptionRuninterpretedOption* è€€€€J" EnumValueOptions% deprecated (:falseR deprecated7 features (2.google.protobuf.FeatureSetRfeatures( debug_redact (:falseRdebugRedactX uninterpreted_optionç (2$.google.protobuf.UninterpretedOptionRuninterpretedOption* è€€€€"Õ ServiceOptions7 features" (2.google.protobuf.FeatureSetRfeatures% deprecated! (:falseR deprecatedX uninterpreted_optionç (2$.google.protobuf.UninterpretedOptionRuninterpretedOption* è€€€€"™ MethodOptions% deprecated! (:falseR deprecatedq idempotency_level" (2/.google.protobuf.MethodOptions.IdempotencyLevel:IDEMPOTENCY_UNKNOWNRidempotencyLevel7 features# (2.google.protobuf.FeatureSetRfeaturesX uninterpreted_optionç (2$.google.protobuf.UninterpretedOptionRuninterpretedOption"P IdempotencyLevel IDEMPOTENCY_UNKNOWN NO_SIDE_EFFECTS IDEMPOTENT* è€€€€"š UninterpretedOptionA name (2-.google.protobuf.UninterpretedOption.NamePartRname) identifier_value ( RidentifierValue, positive_int_value (RpositiveIntValue, negative_int_value (RnegativeIntValue! double_value (RdoubleValue! string_value (RstringValue' aggregate_value ( RaggregateValueJ NamePart name_part ( RnamePart! is_extension (RisExtension" FeatureSetn field_presence (2).google.protobuf.FeatureSet.FieldPresenceBˆ˜˜¢ 2023EXPLICITR fieldPresence[ enum_type (2$.google.protobuf.FeatureSet.EnumTypeBˆ˜˜¢ 2023OPENRenumType… repeated_field_encoding (21.google.protobuf.FeatureSet.RepeatedFieldEncodingBˆ˜˜¢ 2023PACKEDRrepeatedFieldEncodingˆ string_field_validation (21.google.protobuf.FeatureSet.StringFieldValidationBˆ˜˜¢ 2023 MANDATORYRstringFieldValidation{ message_encoding (2+.google.protobuf.FeatureSet.MessageEncodingB#ˆ˜˜¢ 2023LENGTH_PREFIXEDRmessageEncodinge json_format (2&.google.protobuf.FeatureSet.JsonFormatBˆ˜˜˜¢ 2023ALLOWR jsonFormatD raw_featuresç (2.google.protobuf.FeatureSetB˜RrawFeatures"\ FieldPresence FIELD_PRESENCE_UNKNOWN EXPLICIT IMPLICIT LEGACY_REQUIRED"7 EnumType ENUM_TYPE_UNKNOWN OPEN CLOSED"V RepeatedFieldEncoding# REPEATED_FIELD_ENCODING_UNKNOWN PACKED EXPANDED"_ StringFieldValidation# STRING_FIELD_VALIDATION_UNKNOWN MANDATORY HINT NONE"S MessageEncoding MESSAGE_ENCODING_UNKNOWN LENGTH_PREFIXED DELIMITED"H JsonFormat JSON_FORMAT_UNKNOWN ALLOW LEGACY_BEST_EFFORT*èé*éê*‹NN"§ SourceCodeInfoD location (2(.google.protobuf.SourceCodeInfo.LocationRlocationÎ Location path (BRpath span (BRspan) leading_comments ( RleadingComments+ trailing_comments ( RtrailingComments: leading_detached_comments ( RleadingDetachedComments"Ð GeneratedCodeInfoM annotation (2-.google.protobuf.GeneratedCodeInfo.AnnotationR annotationë Annotation path (BRpath source_file ( R sourceFile begin (Rbegin end (RendR semantic (26.google.protobuf.GeneratedCodeInfo.Annotation.SemanticRsemantic"( Semantic NONE SET ALIASB~ com.google.protobufBDescriptorProtosHZ-google.golang.org/protobuf/types/descriptorpbø¢GPBªGoogle.Protobuf.ReflectionJ¦Ÿ &„ ª &2Á Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2Û Author: kenton@google.com (Kenton Varda) Based on original Protocol Buffers design by Sanjay Ghemawat, Jeff Dean, and others. The messages in this file describe the definitions found in .proto files. A valid .proto file can be translated directly to a FileDescriptorProto without any other information (e.g. without reading its imports). ( *D *D +, +, ,1 ,1 -7 %-7 .! $.! / / 3 3t descriptor.proto must be optimized for speed because reflection-based algorithms don't work during bootstrapping. j 79^ The protocol compiler can output a FileDescriptorSet containing the .proto files it parses. 7 8( 8 8 8# 8&' / <^# Describes a complete .proto file. < 9 =", file name, relative to root of source tree = = = = * >" e.g. "foo", "foo.bar", etc. > > > > 4 A!' Names of files imported by this file. A A A A Q C(D Indexes of the public imported files in the dependency list above. C C C" C%' z F&m Indexes of the weak imported files in the dependency list. For Google-internal migration only. Do not use. F F F F#% 6 I,) All top-level definitions in this file. I I I' I*+ J- J J J( J+, K. K K! K") K,- L. L L L ) L,- N# N N N N!" ô T/æ 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. T T T* T-. ¥ Z— The syntax of the proto file. The supported values are "proto2", "proto3", and "editions". If `edition` is present, this value must be "editions". Z Z Z Z H ]; The edition of the proto file, which is an opaque string. ] ] ] ] ( a Describes a message type. a b b b b b d* d d d % d() e. e e e ) e,- g+ g g g& g)* h- h h h( h+, jo j k" Inclusive. k k k k l" Exclusive. l l l l n/ n n " n#* n-. p. p p p) p,- r/ r r r * r-. t& t t t! t$% ª y|› 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. y z" Inclusive. z z z z {" Exclusive. { { { { }, } } }' }*+ ƒ €%u Reserved field names, which may not be used by fields in the same message. A given name may only be reserved once. € € € €"$ ƒ¶ ƒ O …:A The parser stores options it doesn't recognize here. See above. … … …3 …69 ‡ž ‡ K ‰; The extension number declared within the extension range. ‰ ‰ ‰ ‰ z "j The fully-qualified name of the extension field. There must be a leading dot in front of the full name. ! ¡ ’ The fully-qualified type name of the extension field. Unlike Metadata.type, Declaration.type must have a leading dot for messages and enums. ’ ’ ’ ’ Î —½ 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. — — — — Š ›z If true, indicates that the extension must be defined as repeated. Otherwise the extension must be defined as optional. › › › › $ " removed is_repeated ± £F¢ 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. £ £ £" £%& £'E £(D = ¦$/ Any features defined in the specific edition. ¦ ¦ ¦ ¦!# @ ©0 The verification state of the extension range. © C «3 All the extensions of the range must be declared. « « ¬ ¬ ¬ š ²E‹ The verification state of the range. TODO(b/278783756): flip the default to DECLARATION once all empty ranges are marked as UNVERIFIED. ² ² ²) ²,- ².D ²9C Z µM Clients can define custom options in extensions of this message. See above. µ µ µ 3 ¹% Describes a field within a message. ¹ ºÙ º S ½C 0 is reserved for errors. Order is weird for historical reasons. ½ ½ ¾ ¾ ¾ w Ág Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if negative values are likely. Á Á Â Â Â w Åg Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if negative values are likely. Å Å Æ Æ Æ Ç Ç Ç È È È É É É â ÎÑ 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. Î Î - Ï" Length-delimited aggregate. Ï Ï # Ò New in version 2. Ò Ò Ó Ó Ó Ô Ô Ô Õ Õ Õ Ö Ö Ö ' ×" Uses ZigZag encoding. × × ' Ø" Uses ZigZag encoding. Ø Ø Ûà Û * Ý 0 is reserved for errors Ý Ý Þ Þ Þ ß ß ß â â â â â ã ã ã ã ã ä ä ä ä ä œ è If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP. è è è è · ï ¨ For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace). ï ï ï ï ~ óp For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name. ó ó ó ó ‘ ù$‚ 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. ù ù ù ù"# „ ý!v 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 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. ƒ ƒ ƒ ƒ …$ … … … …"# ³ œ%¤ If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must be belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with `LABEL_OPTIONAL`. œ œ œ œ"$ " £ Describes a oneof. ¡ ¡ ¡ ¡ ¡ ¢$ ¢ ¢ ¢ ¢"# ' ¦À Describes an enum type. ¦ § § § § § ©. © ©# ©$) ©,- «# « « « «!" ¯ ³¶ž 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. ³ ´" Inclusive. ´ ´ ´ ´ µ" Inclusive. µ µ µ µ ª »0› 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. » » »+ »./ l ¿$^ Reserved enum value names, which may not be reused. A given name may only be reserved once. ¿ ¿ ¿ ¿"# 1 ÃÈ# Describes a value within an enum. Ã Ä Ä Ä Ä Ä Å Å Å Å Å Ç( Ç Ç Ç# Ç&' $ ËÐ Describes a service. Ë Ì Ì Ì Ì Ì Í, Í Í Í!' Í*+ Ï& Ï Ï Ï! Ï$% 0 Óá" Describes a method of a service. Ó Ô Ô Ô Ô Ô — Ø!ˆ Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type. Ø Ø Ø Ø Ù" Ù Ù Ù Ù ! Û% Û Û Û Û#$ E Þ77 Identifies if client streams multiple client messages Þ Þ Þ Þ#$ Þ%6 Þ05 E à77 Identifies if server streams multiple server messages à à à à#$ à%6 à05 ¯ ƒú2N =================================================================== Options 2Ð Each of the definitions above may have "options" attached. These are just annotations which may cause code to be generated slightly differently or may contain hints for code that manipulates protocol messages. Clients may define custom options as extensions of the *Options messages. These extensions may not yet be known at parsing time, so the parser cannot store the values in them. Instead it stores them in a field in the *Options message called uninterpreted_option. This field must have the same name across all *Options messages. We then use this field to populate the extensions when we build a descriptor, at which point all protos have been parsed and so all extensions are known. Extension numbers for custom options may be chosen as follows: * For options which will only be used within a single application or organization, or for experimental options, use field numbers 50000 through 99999. It is up to you to ensure that you do not use the same number for multiple options. * For options which will be published and used publicly by multiple independent entities, e-mail protobuf-global-extension-registry@google.com to reserve extension numbers. Simply provide your project name (e.g. Objective-C plugin) and your project website (if available) -- there's no need to explain how you intend to use them. Usually you only need one extension number. You can declare multiple options with only one extension number by putting them in a sub-message. See the Custom Options section of the docs for examples: https://developers.google.com/protocol-buffers/docs/proto#options If this turns out to be popular, a web service will be set up to automatically assign option numbers. ƒ ô ‰#å 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. ‰ ‰ ‰ ‰!" ñ +â 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. & )* ¦ ˜;— 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. ˜ ˜ ˜# ˜&( ˜): ˜49 ) ›E This option does nothing. › › ›- ›02 ›3D ›4C æ £>× 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. £ £ £& £)+ £,= £7< L ¦«< Generated classes can be optimized for speed or code size. ¦ D §"4 Generate complete code for parsing, serialization, § § G © etc. "/ Use ReflectionOps to implement these methods. © © G ª"7 Generate code using MessageLite and the lite runtime. ª ª ¬; ¬ ¬ ¬$ ¬'( ¬): ¬49 â ³"Ó 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. ³ ³ ³ ³! Ô ¿;Å 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. ¿ ¿ ¿# ¿&( ¿): ¿49 À= À À À% À(* À+< À6; Á; Á Á Á# Á&( Á): Á49 Â< Â Â Â$ Â') Â*; Â5: ó È2ä 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. È È È È È 1 È+0 Ì7q Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++. Ì Ì Ì Ì#% Ì&6 Ì15 ’ Ð)ƒ Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default. Ð Ð Ð# Ð&( I Ó(; Namespace for generated classes; defaults to the package. Ó Ó Ó" Ó%' ‘ Ù$‚ By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. When this options is provided, they will use this value instead to prefix the types/symbols defined. Ù Ù Ù Ù!# ~ Ý(p Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty. Ý Ý Ý" Ý%' ¾ â%¯ 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. â â â â"$ Ê ç.» Use this option to change the namespace of php generated metadata classes. Default is empty. When this option is empty, the proto file name will be used for determining the namespace. ç ç ç( ç+- Â ì$³ Use this option to change the 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. ì ì ì ì!# = ï$/ Any features defined in the specific edition. ï ï ï ï!# | ó:n The parser stores options it doesn't recognize here. See the documentation for the "Options" section above. ó ó ó3 ó69 ‡ ÷z Clients can define custom options in extensions of this message. See the documentation for the "Options" section above. ÷ ÷ ÷ ù ù ù ù üÌ ü Ø >É 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. ' *+ ,= 7< ë ”FÜ 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". ” ” ”/ ”23 ”4E ”?D î š1ß 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. š š š š š0 š*/ œ œ œ œ œ œ œ œ œ œ ³‘ 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. 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. ³ ³ ³ ³ $ µ " javalite_serializable µ µ µ ¶ " javanano_as_lite ¶ ¶ ¶ ê ÂPÛ 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(b/261750190) This is legacy behavior we plan to remove once downstream teams have had time to migrate. Â Â Â6 Â9; Â ·» · ¸! ¸ ¸ ¹ ¹ ¹ º º º ¼Á ¼ ¼ ¼+ ¼./ ¼0Á ½! ¾ ¿ ÀD ÃÇ Ã Ä Ä Ä Å Å Å Æ Æ Æ ÈÎ È È È! È$% È&Î É! Ê! Ë Ì Í: ÐI Ð Ð Ð" Ð%( Ð)H Ð*G Ò" for Protobuf C++ Ò Ò Ò Ó" for Protobuf Java Ó Ó Ó # Õ" For internal testing Õ Õ Õ Ú ÝÞj Encapsulates information about the original source file from which a FileDescriptorProto was generated. 2` =================================================================== Optional source code info Ý ‚ ‰!ó 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. ‰ ‰ ‰ ‰ ŠÝ Š ‰ ¢,ø 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 occurs. For example, this path: [ 4, 3, 2, 7, 1 ] refers to: file.message_type(3) // 4, 3 .field(7) // 2, 7 .name() // 1 This is because FileDescriptorProto.message_type has field number 4: repeated DescriptorProto message_type = 4; and DescriptorProto.field has field number 2: repeated FieldDescriptorProto field = 2; and FieldDescriptorProto.name has field number 1: optional string name = 1; Thus, the above path gives the location of a field name. If we removed the last element: [ 4, 3, 2, 7 ] this path refers to the whole field declaration (from the beginning of the label to the terminating semicolon). ¢ ¢ ¢ ¢ ¢+ ¢* Ò ©,Á Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column. These are packed into a single field for efficiency. Note that line and column numbers are zero-based -- typically you will want to add 1 to each before displaying to a user. © © © © ©+ ©* ¥ Ú)” 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. Ú Ú Ú$ Ú'( Û* Û Û Û% Û() Ü2 Ü Ü Ü- Ü01 î ã„ ß 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. ã x æ%j An Annotation connects some span of text in generated code to an element of its generating .proto file. æ æ æ æ#$ çƒ ç ê, Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path. ê ê ê ê ê+ ê* O í$? Identifies the filesystem path to the original source .proto. í í í í"# w ñg Identifies the starting offset in bytes in the generated code that relates to the identified object. ñ ñ ñ ñ Û öÊ Identifies the ending offset in bytes in the generated code that relates to the identified object. The end offset should be one past the last relevant byte (so the length of the text = end - begin). ö ö ö ö j ú X Represents the identified object's effect on the element in the original .proto file. ú F ü4 There is no effect or the effect is indescribable. ü ü < þ* The element is set or otherwise mutated. þ þ 8 € & An alias to the element is returned. € € ‚ # ‚ ‚ ‚ ‚ !" ×% google/protobuf/duration.protogoogle.protobuf": Duration seconds (Rseconds nanos (RnanosBƒ com.google.protobufB DurationProtoPZ1google.golang.org/protobuf/types/known/durationpbø¢GPBªGoogle.Protobuf.WellKnownTypesJÙ# r Ì 2Á Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. " " #H #H $, $, %. %. &" &" '! $'! (; %(; er 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". e Ü iÎ 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 i i i ƒ qõ 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. q q qbproto3 ÿ google/protobuf/empty.protogoogle.protobuf" EmptyB} com.google.protobufB EmptyProtoPZ.google.golang.org/protobuf/types/known/emptypbø¢GPBªGoogle.Protobuf.WellKnownTypesJ¾ 2 Ì 2Á Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. "E "E #, #, $+ $+ %" %" &! $&! '; %'; ( ( » 2¯ 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); } 2 bproto3 Š= google/protobuf/field_mask.protogoogle.protobuf"! FieldMask paths ( RpathsB… com.google.protobufBFieldMaskProtoPZ2google.golang.org/protobuf/types/known/fieldmaskpbø¢GPBªGoogle.Protobuf.WellKnownTypesJ¡; ô Ì 2Á Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ", ", #/ #/ $" $" %! $%! &; %&; 'I 'I ( ( ², ñô£, `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. In order to reset a field's value to the default, the field must be in the mask and set to the default value in the provided resource. Hence, in order to reset all fields of a resource, provide a default instance of the resource and set all fields in the mask, or do not provide a mask as described below. If a field mask is not present on update, the operation applies to all fields (as if a field mask of all fields has been specified). Note that in the presence of schema evolution, this may mean that fields the client does not know and has therefore not filled into the request will be reset to their default. If this is unwanted behavior, a specific service may require a client to always specify a field mask, producing an error if not. As with get operations, the location of the resource which describes the updated values in the request message depends on the operation kind. In any case, the effect of the field mask is required to be honored by the API. ## 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. ñ , ó The set of field mask paths. ó ó ó óbproto3 þ" google/protobuf/struct.protogoogle.protobuf"˜ Struct; fields (2#.google.protobuf.Struct.FieldsEntryRfieldsQ FieldsEntry key ( Rkey, value (2.google.protobuf.ValueRvalue:8"² Value; null_value (2.google.protobuf.NullValueHR nullValue# number_value (HRnumberValue# string_value ( HRstringValue bool_value (HR boolValue< struct_value (2.google.protobuf.StructHRstructValue; list_value (2.google.protobuf.ListValueHR listValueB kind"; ListValue. values (2.google.protobuf.ValueRvalues* NullValue NULL_VALUEB com.google.protobufBStructProtoPZ/google.golang.org/protobuf/types/known/structpbø¢GPBªGoogle.Protobuf.WellKnownTypesJ™ ^ Ì 2Á Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. " " #F #F $, $, %, %, &" &" '! $'! (; %(; ³ 25¦ `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, `Struct` might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language. The JSON representation for `Struct` is JSON object. 2 9 4 , Unordered map of dynamically typed values. 4 4 4 Ä =M· `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 indicates an error. The JSON representation for `Value` is JSON value. = " ?L The kind of value. ? ' A Represents a null value. A A A ) C Represents a double value. C C C ) E Represents a string value. E E E * G Represents a boolean value. G G G - I Represents a structured value. I I I - K Represents a repeated `Value`. K K K ¨ SV› `NullValue` is a singleton enumeration to represent the null value for the `Value` type union. The JSON representation for `NullValue` is JSON `null`. S U Null value. U U ‚ [^v `ListValue` is a wrapper around a repeated field of values. The JSON representation for `ListValue` is JSON array. [ : ]- Repeated field of dynamically typed values. ] ] ] ]bproto3 Ã1 google/protobuf/timestamp.protogoogle.protobuf"; Timestamp seconds (Rseconds nanos (RnanosB… com.google.protobufBTimestampProtoPZ2google.golang.org/protobuf/types/known/timestamppbø¢GPBªGoogle.Protobuf.WellKnownTypesJÁ/ Ì 2Á Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. " " #I #I $, $, %/ %/ &" &" '! $'! (; %(; Ú „Ë 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](https://developers.google.com/time/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](https://www.ietf.org/rfc/rfc3339.txt) 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](https://www.ietf.org/rfc/rfc3339.txt) 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 proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON 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()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.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()`]( http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() ) to obtain a formatter capable of generating timestamps in this format. „ ˆŽ Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. ˆ ˆ ˆ å ŽÖ Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. Ž Ž Žbproto3 Í# google/protobuf/wrappers.protogoogle.protobuf"# DoubleValue value (Rvalue"" FloatValue value (Rvalue"" Int64Value value (Rvalue"# UInt64Value value (Rvalue"" Int32Value value (Rvalue"# UInt32Value value ( Rvalue"! BoolValue value (Rvalue"# StringValue value ( Rvalue"" BytesValue value (RvalueBƒ com.google.protobufB WrappersProtoPZ1google.golang.org/protobuf/types/known/wrapperspbø¢GPBªGoogle.Protobuf.WellKnownTypesJÄ (z Ù (2Î Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Wrappers for primitive (non-message) types. These types are useful for embedding primitives in the `google.protobuf.Any` type and for places where we need to distinguish between the absence of a primitive typed field and its default value. These wrappers have no meaningful use within repeated fields as they lack the ability to detect presence on individual elements. These wrappers have no meaningful use within a map or a oneof since individual entries of a map or fields of a oneof can already detect presence. * , , -H -H ., ., /. /. 0" 0" 1! $1! 2; %2; g 7:[ Wrapper message for `double`. The JSON representation for `DoubleValue` is JSON number. 7 9 The double value. 9 9 9 e ?BY Wrapper message for `float`. The JSON representation for `FloatValue` is JSON number. ? A The float value. A A A e GJY Wrapper message for `int64`. The JSON representation for `Int64Value` is JSON string. G I The int64 value. I I I g OR[ Wrapper message for `uint64`. The JSON representation for `UInt64Value` is JSON string. O Q The uint64 value. Q Q Q e WZY Wrapper message for `int32`. The JSON representation for `Int32Value` is JSON number. W Y The int32 value. Y Y Y g _b[ Wrapper message for `uint32`. The JSON representation for `UInt32Value` is JSON number. _ a The uint32 value. a a a o gjc Wrapper message for `bool`. The JSON representation for `BoolValue` is JSON `true` and `false`. g i The bool value. i i i g or[ Wrapper message for `string`. The JSON representation for `StringValue` is JSON string. o q The string value. q q q e wzY Wrapper message for `bytes`. The JSON representation for `BytesValue` is JSON string. w y The bytes value. y y ybproto3 "protos/google/protobuf/types.protogoogle.protobufgoogle/protobuf/any.protogoogle/protobuf/api.proto google/protobuf/descriptor.protogoogle/protobuf/duration.protogoogle/protobuf/empty.proto google/protobuf/field_mask.proto$google/protobuf/source_context.protogoogle/protobuf/struct.protogoogle/protobuf/timestamp.protogoogle/protobuf/type.protogoogle/protobuf/wrappers.protoJ• ( # # * ( % * . & ) $ (bproto3