-
- -
- MCompilerConfig
-
-
- -
- MExtenableMessagesGenOptions
-
-
- -
- MFileFilter
-
-
- -
- MGeneratorScriptsGenOptions
-
-
- -
- MGrpcCoroutinesGenOptions
-
-
- -
- MGrpcStubExtsGenOptions
-
-
- -
- MInsertionsGenOptions
-
-
- -
- MInsertionsGenOptions.Entry
-
-
- -
- MMockServicesGenOptions
-
-
- -
- MProtoBuildersGenOptions
-
-
-
- -
- EInsertionPoint
+ EInsertionPoint
@@ -638,3435 +234,6 @@ Table of Contents
-
-
google/protobuf/any.proto
Top
-
Any
- `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);
}
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 := ptypes.MarshalAny(foo)
...
foo := &pb.Foo{}
if err := ptypes.UnmarshalAny(any, 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"
}
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | type_url |
- string |
- |
- A URL/resource name that uniquely identifies the type of the serialized
-protocol buffer message. 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.
-
-Schemes other than `http`, `https` (or the empty scheme) might be
-used with implementation specific semantics. |
-
-
-
- | value |
- bytes |
- |
- Must be a valid serialized protocol buffer of the above specified type. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
google/protobuf/api.proto
Top
-
Api
- 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.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- |
- The fully qualified name of this interface, including package name
-followed by the interface's simple name. |
-
-
-
- | methods |
- Method |
- repeated |
- The methods of this interface, in unspecified order. |
-
-
-
- | options |
- Option |
- repeated |
- Any metadata attached to the interface. |
-
-
-
- | version |
- string |
- |
- 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<major-version>`, 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_context |
- SourceContext |
- |
- Source context for the protocol buffer service represented by this
-message. |
-
-
-
- | mixins |
- Mixin |
- repeated |
- Included interfaces. See [Mixin][]. |
-
-
-
- | syntax |
- Syntax |
- |
- The source syntax of the service. |
-
-
-
-
-
-
-
-
- Method
- Method represents a method of an API interface.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- |
- The simple name of this method. |
-
-
-
- | request_type_url |
- string |
- |
- A URL of the input message type. |
-
-
-
- | request_streaming |
- bool |
- |
- If true, the request is streamed. |
-
-
-
- | response_type_url |
- string |
- |
- The URL of the output message type. |
-
-
-
- | response_streaming |
- bool |
- |
- If true, the response is streamed. |
-
-
-
- | options |
- Option |
- repeated |
- Any metadata attached to the method. |
-
-
-
- | syntax |
- Syntax |
- |
- The source syntax of this method. |
-
-
-
-
-
-
-
-
- Mixin
- 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";
}
...
}
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- |
- The fully qualified name of the interface which is included. |
-
-
-
- | root |
- string |
- |
- If non-empty specifies a path under which inherited HTTP paths
-are rooted. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
google/protobuf/compiler/plugin.proto
Top
-
CodeGeneratorRequest
- An encoded CodeGeneratorRequest is written to the plugin's stdin.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | file_to_generate |
- string |
- repeated |
- The .proto files that were explicitly listed on the command-line. The
-code generator should generate code only for these files. Each file's
-descriptor will be included in proto_file, below. |
-
-
-
- | parameter |
- string |
- optional |
- The generator parameter passed on the command-line. |
-
-
-
- | proto_file |
- google.protobuf.FileDescriptorProto |
- repeated |
- FileDescriptorProtos for all files in files_to_generate and everything
-they import. The files will appear in topological order, so each file
-appears before any file that imports it.
-
-protoc guarantees that all proto_files will be written after
-the fields above, even though this is not technically guaranteed by the
-protobuf wire format. This theoretically could allow a plugin to stream
-in the FileDescriptorProtos and handle them one by one rather than read
-the entire set into memory at once. However, as of this writing, this
-is not similarly optimized on protoc's end -- it will store all fields in
-memory at once before sending them to the plugin.
-
-Type names of fields and extensions in the FileDescriptorProto are always
-fully qualified. |
-
-
-
- | compiler_version |
- Version |
- optional |
- The version number of protocol compiler. |
-
-
-
-
-
-
-
-
- CodeGeneratorResponse
- The plugin writes an encoded CodeGeneratorResponse to stdout.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | error |
- string |
- optional |
- Error message. If non-empty, code generation failed. The plugin process
-should exit with status code zero even if it reports an error in this way.
-
-This should be used to indicate errors in .proto files which prevent the
-code generator from generating correct code. Errors which indicate a
-problem in protoc itself -- such as the input CodeGeneratorRequest being
-unparseable -- should be reported by writing a message to stderr and
-exiting with a non-zero status code. |
-
-
-
- | file |
- CodeGeneratorResponse.File |
- repeated |
- |
-
-
-
-
-
-
-
-
- CodeGeneratorResponse.File
- Represents a single generated file.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- optional |
- The file name, relative to the output directory. The name must not
-contain "." or ".." components and must be relative, not be absolute (so,
-the file cannot lie outside the output directory). "/" must be used as
-the path separator, not "\".
-
-If the name is omitted, the content will be appended to the previous
-file. This allows the generator to break large files into small chunks,
-and allows the generated text to be streamed back to protoc so that large
-files need not reside completely in memory at one time. Note that as of
-this writing protoc does not optimize for this -- it will read the entire
-CodeGeneratorResponse before writing files to disk. |
-
-
-
- | insertion_point |
- string |
- optional |
- If non-empty, indicates that the named file should already exist, and the
-content here is to be inserted into that file at a defined insertion
-point. This feature allows a code generator to extend the output
-produced by another code generator. The original generator may provide
-insertion points by placing special annotations in the file that look
-like:
- @@protoc_insertion_point(NAME)
-The annotation can have arbitrary text before and after it on the line,
-which allows it to be placed in a comment. NAME should be replaced with
-an identifier naming the point -- this is what other generators will use
-as the insertion_point. Code inserted at this point will be placed
-immediately above the line containing the insertion point (thus multiple
-insertions to the same point will come out in the order they were added).
-The double-@ is intended to make it unlikely that the generated code
-could contain things that look like insertion points by accident.
-
-For example, the C++ code generator places the following line in the
-.pb.h files that it generates:
- // @@protoc_insertion_point(namespace_scope)
-This line appears within the scope of the file's package namespace, but
-outside of any particular class. Another plugin can then specify the
-insertion_point "namespace_scope" to generate additional classes or
-other declarations that should be placed in this scope.
-
-Note that if the line containing the insertion point begins with
-whitespace, the same whitespace will be added to every line of the
-inserted text. This is useful for languages like Python, where
-indentation matters. In these languages, the insertion point comment
-should be indented the same amount as any inserted code will need to be
-in order to work correctly in that context.
-
-The code generator that generates the initial file and the one which
-inserts into it must both run as part of a single invocation of protoc.
-Code generators are executed in the order in which they appear on the
-command line.
-
-If |insertion_point| is present, |name| must also be present. |
-
-
-
- | content |
- string |
- optional |
- The file contents. |
-
-
-
-
-
-
-
-
- Version
- The version number of protocol compiler.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | major |
- int32 |
- optional |
- |
-
-
-
- | minor |
- int32 |
- optional |
- |
-
-
-
- | patch |
- int32 |
- optional |
- |
-
-
-
- | suffix |
- string |
- optional |
- A suffix for alpha, beta or rc release, e.g., "alpha-1", "rc2". It should
-be empty for mainline stable releases. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
google/protobuf/descriptor.proto
Top
-
DescriptorProto
- Describes a message type.
-
-
-
-
-
-
-
- DescriptorProto.ExtensionRange
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | start |
- int32 |
- optional |
- |
-
-
-
- | end |
- int32 |
- optional |
- |
-
-
-
- | options |
- ExtensionRangeOptions |
- optional |
- |
-
-
-
-
-
-
-
-
- DescriptorProto.ReservedRange
- Range of reserved tag numbers. Reserved tag numbers may not be used by
fields or extension ranges in the same message. Reserved ranges may
not overlap.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | start |
- int32 |
- optional |
- Inclusive. |
-
-
-
- | end |
- int32 |
- optional |
- Exclusive. |
-
-
-
-
-
-
-
-
- EnumDescriptorProto
- Describes an enum type.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- optional |
- |
-
-
-
- | value |
- EnumValueDescriptorProto |
- repeated |
- |
-
-
-
- | options |
- EnumOptions |
- optional |
- |
-
-
-
- | reserved_range |
- EnumDescriptorProto.EnumReservedRange |
- repeated |
- Range of reserved numeric values. Reserved numeric values may not be used
-by enum values in the same enum declaration. Reserved ranges may not
-overlap. |
-
-
-
- | reserved_name |
- string |
- repeated |
- Reserved enum value names, which may not be reused. A given name may only
-be reserved once. |
-
-
-
-
-
-
-
-
- EnumDescriptorProto.EnumReservedRange
- 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.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | start |
- int32 |
- optional |
- Inclusive. |
-
-
-
- | end |
- int32 |
- optional |
- Inclusive. |
-
-
-
-
-
-
-
-
- EnumOptions
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | allow_alias |
- bool |
- optional |
- Set this option to true to allow mapping different tag names to the same
-value. |
-
-
-
- | deprecated |
- bool |
- optional |
- Is this enum deprecated?
-Depending on the target platform, this can emit Deprecated annotations
-for the enum, or it will be completely ignored; in the very least, this
-is a formalization for deprecating enums. Default: false |
-
-
-
- | uninterpreted_option |
- UninterpretedOption |
- repeated |
- The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
- EnumValueDescriptorProto
- Describes a value within an enum.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- optional |
- |
-
-
-
- | number |
- int32 |
- optional |
- |
-
-
-
- | options |
- EnumValueOptions |
- optional |
- |
-
-
-
-
-
-
-
-
- EnumValueOptions
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | deprecated |
- bool |
- optional |
- Is this enum value deprecated?
-Depending on the target platform, this can emit Deprecated annotations
-for the enum value, or it will be completely ignored; in the very least,
-this is a formalization for deprecating enum values. Default: false |
-
-
-
- | uninterpreted_option |
- UninterpretedOption |
- repeated |
- The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
- ExtensionRangeOptions
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | uninterpreted_option |
- UninterpretedOption |
- repeated |
- The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
- FieldDescriptorProto
- Describes a field within a message.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- optional |
- |
-
-
-
- | number |
- int32 |
- optional |
- |
-
-
-
- | label |
- FieldDescriptorProto.Label |
- optional |
- |
-
-
-
- | type |
- FieldDescriptorProto.Type |
- optional |
- If type_name is set, this need not be set. If both this and type_name
-are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP. |
-
-
-
- | type_name |
- string |
- optional |
- For message and enum types, this is the name of the type. If the name
-starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
-rules are used to find the type (i.e. first the nested types within this
-message are searched, then within the parent, on up to the root
-namespace). |
-
-
-
- | extendee |
- string |
- optional |
- For extensions, this is the name of the type being extended. It is
-resolved in the same manner as type_name. |
-
-
-
- | default_value |
- string |
- optional |
- For numeric types, contains the original text representation of the value.
-For booleans, "true" or "false".
-For strings, contains the default text contents (not escaped in any way).
-For bytes, contains the C escaped value. All bytes >= 128 are escaped.
-TODO(kenton): Base-64 encode? |
-
-
-
- | oneof_index |
- int32 |
- optional |
- If set, gives the index of a oneof in the containing type's oneof_decl
-list. This field is a member of that oneof. |
-
-
-
- | json_name |
- string |
- optional |
- JSON name of this field. The value is set by protocol compiler. If the
-user has set a "json_name" option on this field, that option's value
-will be used. Otherwise, it's deduced from the field's name by converting
-it to camelCase. |
-
-
-
- | options |
- FieldOptions |
- optional |
- |
-
-
-
-
-
-
-
-
- FieldOptions
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | ctype |
- FieldOptions.CType |
- optional |
- The ctype option instructs the C++ code generator to use a different
-representation of the field than it normally would. See the specific
-options below. This option is not yet implemented in the open source
-release -- sorry, we'll try to include it in a future version! Default: STRING |
-
-
-
- | packed |
- bool |
- optional |
- The packed option can be enabled for repeated primitive fields to enable
-a more efficient representation on the wire. Rather than repeatedly
-writing the tag and type for each element, the entire array is encoded as
-a single length-delimited blob. In proto3, only explicit setting it to
-false will avoid using packed encoding. |
-
-
-
- | jstype |
- FieldOptions.JSType |
- optional |
- The jstype option determines the JavaScript type used for values of the
-field. The option is permitted only for 64 bit integral and fixed types
-(int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
-is represented as JavaScript string, which avoids loss of precision that
-can happen when a large value is converted to a floating point JavaScript.
-Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
-use the JavaScript "number" type. The behavior of the default option
-JS_NORMAL is implementation dependent.
-
-This option is an enum to permit additional types to be added, e.g.
-goog.math.Integer. Default: JS_NORMAL |
-
-
-
- | lazy |
- bool |
- optional |
- Should this field be parsed lazily? Lazy applies only to message-type
-fields. It means that when the outer message is initially parsed, the
-inner message's contents will not be parsed but instead stored in encoded
-form. The inner message will actually be parsed when it is first accessed.
-
-This is only a hint. Implementations are free to choose whether to use
-eager or lazy parsing regardless of the value of this option. However,
-setting this option true suggests that the protocol author believes that
-using lazy parsing on this field is worth the additional bookkeeping
-overhead typically needed to implement it.
-
-This option does not affect the public interface of any generated code;
-all method signatures remain the same. Furthermore, thread-safety of the
-interface is not affected by this option; const methods remain safe to
-call from multiple threads concurrently, while non-const methods continue
-to require exclusive access.
-
-
-Note that implementations may choose not to check required fields within
-a lazy sub-message. That is, calling IsInitialized() on the outer message
-may return true even if the inner message has missing required fields.
-This is necessary because otherwise the inner message would have to be
-parsed in order to perform the check, defeating the purpose of lazy
-parsing. An implementation which chooses not to check required fields
-must be consistent about it. That is, for any particular sub-message, the
-implementation must either *always* check its required fields, or *never*
-check its required fields, regardless of whether or not the message has
-been parsed. Default: false |
-
-
-
- | deprecated |
- bool |
- optional |
- Is this field deprecated?
-Depending on the target platform, this can emit Deprecated annotations
-for accessors, or it will be completely ignored; in the very least, this
-is a formalization for deprecating fields. Default: false |
-
-
-
- | weak |
- bool |
- optional |
- For Google-internal migration only. Do not use. Default: false |
-
-
-
- | uninterpreted_option |
- UninterpretedOption |
- repeated |
- The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
- FileDescriptorProto
- Describes a complete .proto file.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- optional |
- file name, relative to root of source tree |
-
-
-
- | package |
- string |
- optional |
- e.g. "foo", "foo.bar", etc. |
-
-
-
- | dependency |
- string |
- repeated |
- Names of files imported by this file. |
-
-
-
- | public_dependency |
- int32 |
- repeated |
- Indexes of the public imported files in the dependency list above. |
-
-
-
- | weak_dependency |
- int32 |
- repeated |
- Indexes of the weak imported files in the dependency list.
-For Google-internal migration only. Do not use. |
-
-
-
- | message_type |
- DescriptorProto |
- repeated |
- All top-level definitions in this file. |
-
-
-
- | enum_type |
- EnumDescriptorProto |
- repeated |
- |
-
-
-
- | service |
- ServiceDescriptorProto |
- repeated |
- |
-
-
-
- | extension |
- FieldDescriptorProto |
- repeated |
- |
-
-
-
- | options |
- FileOptions |
- optional |
- |
-
-
-
- | source_code_info |
- SourceCodeInfo |
- optional |
- This field contains optional information about the original source code.
-You may safely remove this entire field without harming runtime
-functionality of the descriptors -- the information is needed only by
-development tools. |
-
-
-
- | syntax |
- string |
- optional |
- The syntax of the proto file.
-The supported values are "proto2" and "proto3". |
-
-
-
-
-
-
-
-
- FileDescriptorSet
- The protocol compiler can output a FileDescriptorSet containing the .proto
files it parses.
-
-
-
-
-
-
-
- FileOptions
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | java_package |
- string |
- optional |
- Sets the Java package where classes generated from this .proto will be
-placed. By default, the proto package is used, but this is often
-inappropriate because proto packages do not normally start with backwards
-domain names. |
-
-
-
- | java_outer_classname |
- string |
- optional |
- If set, all the classes from the .proto file are wrapped in a single
-outer class with the given name. This applies to both Proto1
-(equivalent to the old "--one_java_file" option) and Proto2 (where
-a .proto always translates to a single class, but you may want to
-explicitly choose the class name). |
-
-
-
- | java_multiple_files |
- bool |
- optional |
- If set true, then the Java code generator will generate a separate .java
-file for each top-level message, enum, and service defined in the .proto
-file. Thus, these types will *not* be nested inside the outer class
-named by java_outer_classname. However, the outer class will still be
-generated to contain the file's getDescriptor() method as well as any
-top-level extensions defined in the file. Default: false |
-
-
-
- | java_generate_equals_and_hash |
- bool |
- optional |
- This option does nothing. |
-
-
-
- | java_string_check_utf8 |
- bool |
- optional |
- If set true, then the Java2 code generator will generate code that
-throws an exception whenever an attempt is made to assign a non-UTF-8
-byte sequence to a string field.
-Message reflection will do the same.
-However, an extension field still accepts non-UTF-8 byte sequences.
-This option has no effect on when used with the lite runtime. Default: false |
-
-
-
- | optimize_for |
- FileOptions.OptimizeMode |
- optional |
- Default: SPEED |
-
-
-
- | go_package |
- string |
- optional |
- Sets the Go package where structs generated from this .proto will be
-placed. If omitted, the Go package will be derived from the following:
- - The basename of the package import path, if provided.
- - Otherwise, the package statement in the .proto file, if present.
- - Otherwise, the basename of the .proto file, without extension. |
-
-
-
- | cc_generic_services |
- bool |
- optional |
- Should generic services be generated in each language? "Generic" services
-are not specific to any particular RPC system. They are generated by the
-main code generators in each language (without additional plugins).
-Generic services were the only kind of service generation supported by
-early versions of google.protobuf.
-
-Generic services are now considered deprecated in favor of using plugins
-that generate code specific to your particular RPC system. Therefore,
-these default to false. Old code which depends on generic services should
-explicitly set them to true. Default: false |
-
-
-
- | java_generic_services |
- bool |
- optional |
- Default: false |
-
-
-
- | py_generic_services |
- bool |
- optional |
- Default: false |
-
-
-
- | php_generic_services |
- bool |
- optional |
- Default: false |
-
-
-
- | deprecated |
- bool |
- optional |
- Is this file deprecated?
-Depending on the target platform, this can emit Deprecated annotations
-for everything in the file, or it will be completely ignored; in the very
-least, this is a formalization for deprecating files. Default: false |
-
-
-
- | cc_enable_arenas |
- bool |
- optional |
- Enables the use of arenas for the proto messages in this file. This applies
-only to generated classes for C++. Default: false |
-
-
-
- | objc_class_prefix |
- string |
- optional |
- Sets the objective c class prefix which is prepended to all objective c
-generated classes from this .proto. There is no default. |
-
-
-
- | csharp_namespace |
- string |
- optional |
- Namespace for generated classes; defaults to the package. |
-
-
-
- | swift_prefix |
- string |
- optional |
- By default Swift generators will take the proto package and CamelCase it
-replacing '.' with underscore and use that to prefix the types/symbols
-defined. When this options is provided, they will use this value instead
-to prefix the types/symbols defined. |
-
-
-
- | php_class_prefix |
- string |
- optional |
- Sets the php class prefix which is prepended to all php generated classes
-from this .proto. Default is empty. |
-
-
-
- | php_namespace |
- string |
- optional |
- Use this option to change the namespace of php generated classes. Default
-is empty. When this option is empty, the package name will be used for
-determining the namespace. |
-
-
-
- | php_metadata_namespace |
- string |
- optional |
- Use this option to change the namespace of php generated metadata classes.
-Default is empty. When this option is empty, the proto file name will be used
-for determining the namespace. |
-
-
-
- | ruby_package |
- string |
- optional |
- Use this option to change the package of ruby generated classes. Default
-is empty. When this option is not set, the package name will be used for
-determining the ruby package. |
-
-
-
- | uninterpreted_option |
- UninterpretedOption |
- repeated |
- The parser stores options it doesn't recognize here.
-See the documentation for the "Options" section above. |
-
-
-
-
-
-
-
-
- GeneratedCodeInfo
- Describes the relationship between generated code and its original source
file. A GeneratedCodeInfo message is associated with only one generated
source file, but may contain references to different source .proto files.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | annotation |
- GeneratedCodeInfo.Annotation |
- repeated |
- An Annotation connects some span of text in generated code to an element
-of its generating .proto file. |
-
-
-
-
-
-
-
-
- GeneratedCodeInfo.Annotation
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | path |
- int32 |
- repeated |
- Identifies the element in the original source .proto file. This field
-is formatted the same as SourceCodeInfo.Location.path. |
-
-
-
- | source_file |
- string |
- optional |
- Identifies the filesystem path to the original source .proto. |
-
-
-
- | begin |
- int32 |
- optional |
- Identifies the starting offset in bytes in the generated code
-that relates to the identified object. |
-
-
-
- | end |
- int32 |
- optional |
- Identifies the ending offset in bytes in the generated code that
-relates to the identified offset. The end offset should be one past
-the last relevant byte (so the length of the text = end - begin). |
-
-
-
-
-
-
-
-
- MessageOptions
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | message_set_wire_format |
- bool |
- optional |
- Set true to use the old proto1 MessageSet wire format for extensions.
-This is provided for backwards-compatibility with the MessageSet wire
-format. You should not use this for any other reason: It's less
-efficient, has fewer features, and is more complicated.
-
-The message must be defined exactly as follows:
- message Foo {
- option message_set_wire_format = true;
- extensions 4 to max;
- }
-Note that the message cannot have any defined fields; MessageSets only
-have extensions.
-
-All extensions of your type must be singular messages; e.g. they cannot
-be int32s, enums, or repeated messages.
-
-Because this is an option, the above two restrictions are not enforced by
-the protocol compiler. Default: false |
-
-
-
- | no_standard_descriptor_accessor |
- bool |
- optional |
- Disables the generation of the standard "descriptor()" accessor, which can
-conflict with a field of the same name. This is meant to make migration
-from proto1 easier; new code should avoid fields named "descriptor". Default: false |
-
-
-
- | deprecated |
- bool |
- optional |
- Is this message deprecated?
-Depending on the target platform, this can emit Deprecated annotations
-for the message, or it will be completely ignored; in the very least,
-this is a formalization for deprecating messages. Default: false |
-
-
-
- | map_entry |
- bool |
- optional |
- Whether the message is an automatically generated map entry type for the
-maps field.
-
-For maps fields:
- map<KeyType, ValueType> map_field = 1;
-The parsed descriptor looks like:
- message MapFieldEntry {
- option map_entry = true;
- optional KeyType key = 1;
- optional ValueType value = 2;
- }
- repeated MapFieldEntry map_field = 1;
-
-Implementations may choose not to generate the map_entry=true message, but
-use a native map in the target language to hold the keys and values.
-The reflection APIs in such implementions still need to work as
-if the field is a repeated message field.
-
-NOTE: Do not set the option in .proto files. Always use the maps syntax
-instead. The option should only be implicitly set by the proto compiler
-parser. |
-
-
-
- | uninterpreted_option |
- UninterpretedOption |
- repeated |
- The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
- MethodDescriptorProto
- Describes a method of a service.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- optional |
- |
-
-
-
- | input_type |
- string |
- optional |
- Input and output type names. These are resolved in the same way as
-FieldDescriptorProto.type_name, but must refer to a message type. |
-
-
-
- | output_type |
- string |
- optional |
- |
-
-
-
- | options |
- MethodOptions |
- optional |
- |
-
-
-
- | client_streaming |
- bool |
- optional |
- Identifies if client streams multiple client messages Default: false |
-
-
-
- | server_streaming |
- bool |
- optional |
- Identifies if server streams multiple server messages Default: false |
-
-
-
-
-
-
-
-
- MethodOptions
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | deprecated |
- bool |
- optional |
- Is this method deprecated?
-Depending on the target platform, this can emit Deprecated annotations
-for the method, or it will be completely ignored; in the very least,
-this is a formalization for deprecating methods. Default: false |
-
-
-
- | idempotency_level |
- MethodOptions.IdempotencyLevel |
- optional |
- Default: IDEMPOTENCY_UNKNOWN |
-
-
-
- | uninterpreted_option |
- UninterpretedOption |
- repeated |
- The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
- OneofDescriptorProto
- Describes a oneof.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- optional |
- |
-
-
-
- | options |
- OneofOptions |
- optional |
- |
-
-
-
-
-
-
-
-
- OneofOptions
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | uninterpreted_option |
- UninterpretedOption |
- repeated |
- The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
- ServiceDescriptorProto
- Describes a service.
-
-
-
-
-
-
-
- ServiceOptions
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | deprecated |
- bool |
- optional |
- Is this service deprecated?
-Depending on the target platform, this can emit Deprecated annotations
-for the service, or it will be completely ignored; in the very least,
-this is a formalization for deprecating services. Default: false |
-
-
-
- | uninterpreted_option |
- UninterpretedOption |
- repeated |
- The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
- SourceCodeInfo
- Encapsulates information about the original source file from which a
FileDescriptorProto was generated.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | location |
- SourceCodeInfo.Location |
- repeated |
- A Location identifies a piece of source code in a .proto file which
-corresponds to a particular definition. This information is intended
-to be useful to IDEs, code indexers, documentation generators, and similar
-tools.
-
-For example, say we have a file like:
- message Foo {
- optional string foo = 1;
- }
-Let's look at just the field definition:
- optional string foo = 1;
- ^ ^^ ^^ ^ ^^^
- a bc de f ghi
-We have the following locations:
- span path represents
- [a,i) [ 4, 0, 2, 0 ] The whole field definition.
- [a,b) [ 4, 0, 2, 0, 4 ] The label (optional).
- [c,d) [ 4, 0, 2, 0, 5 ] The type (string).
- [e,f) [ 4, 0, 2, 0, 1 ] The name (foo).
- [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
-
-Notes:
-- A location may refer to a repeated field itself (i.e. not to any
- particular index within it). This is used whenever a set of elements are
- logically enclosed in a single code segment. For example, an entire
- extend block (possibly containing multiple extension definitions) will
- have an outer location whose path refers to the "extensions" repeated
- field without an index.
-- Multiple locations may have the same path. This happens when a single
- logical declaration is spread out across multiple places. The most
- obvious example is the "extend" block again -- there may be multiple
- extend blocks in the same scope, each of which will have the same path.
-- A location's span is not always a subset of its parent's span. For
- example, the "extendee" of an extension declaration appears at the
- beginning of the "extend" block and is shared by all extensions within
- the block.
-- Just because a location's span is a subset of some other location's span
- does not mean that it is a descendent. For example, a "group" defines
- both a type and a field in a single declaration. Thus, the locations
- corresponding to the type and field and their components will overlap.
-- Code which tries to interpret locations should probably be designed to
- ignore those that it doesn't understand, as more types of locations could
- be recorded in the future. |
-
-
-
-
-
-
-
-
- SourceCodeInfo.Location
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | path |
- int32 |
- repeated |
- Identifies which part of the FileDescriptorProto was defined at this
-location.
-
-Each element is a field number or an index. They form a path from
-the root FileDescriptorProto to the place where the definition. For
-example, this path:
- [ 4, 3, 2, 7, 1 ]
-refers to:
- file.message_type(3) // 4, 3
- .field(7) // 2, 7
- .name() // 1
-This is because FileDescriptorProto.message_type has field number 4:
- repeated DescriptorProto message_type = 4;
-and DescriptorProto.field has field number 2:
- repeated FieldDescriptorProto field = 2;
-and FieldDescriptorProto.name has field number 1:
- optional string name = 1;
-
-Thus, the above path gives the location of a field name. If we removed
-the last element:
- [ 4, 3, 2, 7 ]
-this path refers to the whole field declaration (from the beginning
-of the label to the terminating semicolon). |
-
-
-
- | span |
- int32 |
- repeated |
- Always has exactly three or four elements: start line, start column,
-end line (optional, otherwise assumed same as start line), end column.
-These are packed into a single field for efficiency. Note that line
-and column numbers are zero-based -- typically you will want to add
-1 to each before displaying to a user. |
-
-
-
- | leading_comments |
- string |
- optional |
- If this SourceCodeInfo represents a complete declaration, these are any
-comments appearing before and after the declaration which appear to be
-attached to the declaration.
-
-A series of line comments appearing on consecutive lines, with no other
-tokens appearing on those lines, will be treated as a single comment.
-
-leading_detached_comments will keep paragraphs of comments that appear
-before (but not connected to) the current element. Each paragraph,
-separated by empty lines, will be one comment element in the repeated
-field.
-
-Only the comment content is provided; comment markers (e.g. //) are
-stripped out. For block comments, leading whitespace and an asterisk
-will be stripped from the beginning of each line other than the first.
-Newlines are included in the output.
-
-Examples:
-
- optional int32 foo = 1; // Comment attached to foo.
- // Comment attached to bar.
- optional int32 bar = 2;
-
- optional string baz = 3;
- // Comment attached to baz.
- // Another line attached to baz.
-
- // Comment attached to qux.
- //
- // Another line attached to qux.
- optional double qux = 4;
-
- // Detached comment for corge. This is not leading or trailing comments
- // to qux or corge because there are blank lines separating it from
- // both.
-
- // Detached comment for corge paragraph 2.
-
- optional string corge = 5;
- /* Block comment attached
- * to corge. Leading asterisks
- * will be removed. */
- /* Block comment attached to
- * grault. */
- optional int32 grault = 6;
-
- // ignored detached comments. |
-
-
-
- | trailing_comments |
- string |
- optional |
- |
-
-
-
- | leading_detached_comments |
- string |
- repeated |
- |
-
-
-
-
-
-
-
-
- UninterpretedOption
- A message representing a option the parser does not recognize. This only
appears in options protos created by the compiler::Parser class.
DescriptorPool resolves these when building Descriptor objects. Therefore,
options protos in descriptor objects (e.g. returned by Descriptor::options(),
or produced by Descriptor::CopyTo()) will never have UninterpretedOptions
in them.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- UninterpretedOption.NamePart |
- repeated |
- |
-
-
-
- | identifier_value |
- string |
- optional |
- The value of the uninterpreted option, in whatever type the tokenizer
-identified it as during parsing. Exactly one of these should be set. |
-
-
-
- | positive_int_value |
- uint64 |
- optional |
- |
-
-
-
- | negative_int_value |
- int64 |
- optional |
- |
-
-
-
- | double_value |
- double |
- optional |
- |
-
-
-
- | string_value |
- bytes |
- optional |
- |
-
-
-
- | aggregate_value |
- string |
- optional |
- |
-
-
-
-
-
-
-
-
- UninterpretedOption.NamePart
- The name of the uninterpreted option. Each string represents a segment in
a dot-separated name. is_extension is true iff a segment represents an
extension (denoted with parentheses in options specs in .proto files).
E.g.,{ ["foo", false], ["bar.baz", true], ["qux", false] } represents
"foo.(bar.baz).qux".
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name_part |
- string |
- required |
- |
-
-
-
- | is_extension |
- bool |
- required |
- |
-
-
-
-
-
-
-
-
-
-
- FieldDescriptorProto.Label
-
-
-
- | Name | Number | Description |
-
-
-
-
- | LABEL_OPTIONAL |
- 1 |
- 0 is reserved for errors |
-
-
-
- | LABEL_REQUIRED |
- 2 |
- |
-
-
-
- | LABEL_REPEATED |
- 3 |
- |
-
-
-
-
-
- FieldDescriptorProto.Type
-
-
-
- | Name | Number | Description |
-
-
-
-
- | TYPE_DOUBLE |
- 1 |
- 0 is reserved for errors.
-Order is weird for historical reasons. |
-
-
-
- | TYPE_FLOAT |
- 2 |
- |
-
-
-
- | TYPE_INT64 |
- 3 |
- Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if
-negative values are likely. |
-
-
-
- | TYPE_UINT64 |
- 4 |
- |
-
-
-
- | TYPE_INT32 |
- 5 |
- Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if
-negative values are likely. |
-
-
-
- | TYPE_FIXED64 |
- 6 |
- |
-
-
-
- | TYPE_FIXED32 |
- 7 |
- |
-
-
-
- | TYPE_BOOL |
- 8 |
- |
-
-
-
- | TYPE_STRING |
- 9 |
- |
-
-
-
- | TYPE_GROUP |
- 10 |
- Tag-delimited aggregate.
-Group type is deprecated and not supported in proto3. However, Proto3
-implementations should still be able to parse the group wire format and
-treat group fields as unknown fields. |
-
-
-
- | TYPE_MESSAGE |
- 11 |
- Length-delimited aggregate. |
-
-
-
- | TYPE_BYTES |
- 12 |
- New in version 2. |
-
-
-
- | TYPE_UINT32 |
- 13 |
- |
-
-
-
- | TYPE_ENUM |
- 14 |
- |
-
-
-
- | TYPE_SFIXED32 |
- 15 |
- |
-
-
-
- | TYPE_SFIXED64 |
- 16 |
- |
-
-
-
- | TYPE_SINT32 |
- 17 |
- Uses ZigZag encoding. |
-
-
-
- | TYPE_SINT64 |
- 18 |
- Uses ZigZag encoding. |
-
-
-
-
-
- FieldOptions.CType
-
-
-
- | Name | Number | Description |
-
-
-
-
- | STRING |
- 0 |
- Default mode. |
-
-
-
- | CORD |
- 1 |
- |
-
-
-
- | STRING_PIECE |
- 2 |
- |
-
-
-
-
-
- FieldOptions.JSType
-
-
-
- | Name | Number | Description |
-
-
-
-
- | JS_NORMAL |
- 0 |
- Use the default type. |
-
-
-
- | JS_STRING |
- 1 |
- Use JavaScript strings. |
-
-
-
- | JS_NUMBER |
- 2 |
- Use JavaScript numbers. |
-
-
-
-
-
- FileOptions.OptimizeMode
- Generated classes can be optimized for speed or code size.
-
-
- | Name | Number | Description |
-
-
-
-
- | SPEED |
- 1 |
- Generate complete code for parsing, serialization, |
-
-
-
- | CODE_SIZE |
- 2 |
- etc.
-
-Use ReflectionOps to implement these methods. |
-
-
-
- | LITE_RUNTIME |
- 3 |
- Generate code using MessageLite and the lite runtime. |
-
-
-
-
-
- MethodOptions.IdempotencyLevel
- 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.
-
-
- | Name | Number | Description |
-
-
-
-
- | IDEMPOTENCY_UNKNOWN |
- 0 |
- |
-
-
-
- | NO_SIDE_EFFECTS |
- 1 |
- implies idempotent |
-
-
-
- | IDEMPOTENT |
- 2 |
- idempotent, but may have side effects |
-
-
-
-
-
-
-
-
-
-
-
-
-
google/protobuf/duration.proto
Top
-
Duration
- 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 (durations.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".
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | seconds |
- int64 |
- |
- 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 |
-
-
-
- | nanos |
- int32 |
- |
- 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. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
google/protobuf/empty.proto
Top
-
Empty
- 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);
}
The JSON representation for `Empty` is empty JSON object `{}`.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
google/protobuf/field_mask.proto
Top
-
FieldMask
- `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, the existing
repeated values in the target resource will be overwritten by the new values.
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 the existing sub-message in the target resource is
overwritten. Given the target message:
f {
b {
d : 1
x : 2
}
c : 1
}
And an update message:
f {
b {
d : 10
}
}
then if the field mask is:
paths: "f.b"
then the result will be:
f {
b {
d : 10
}
c : 1
}
However, if the update mask was:
paths: "f.b.d"
then the result would be:
f {
b {
d : 10
x : 2
}
c : 1
}
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 duplicated or unmappable.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | paths |
- string |
- repeated |
- The set of field mask paths. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
google/protobuf/source_context.proto
Top
-
SourceContext
- `SourceContext` represents information about the source of a
protobuf element, like the file in which it is defined.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | file_name |
- string |
- |
- The path-qualified name of the .proto file that contained the associated
-protobuf element. For example: `"google/protobuf/source_context.proto"`. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
google/protobuf/struct.proto
Top
-
ListValue
- `ListValue` is a wrapper around a repeated field of values.
The JSON representation for `ListValue` is JSON array.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | values |
- Value |
- repeated |
- Repeated field of dynamically typed values. |
-
-
-
-
-
-
-
-
- Struct
- `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.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | fields |
- Struct.FieldsEntry |
- repeated |
- Unordered map of dynamically typed values. |
-
-
-
-
-
-
-
-
- Struct.FieldsEntry
-
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | key |
- string |
- |
- |
-
-
-
- | value |
- Value |
- |
- |
-
-
-
-
-
-
-
-
- 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 that
variants, absence of any variant indicates an error.
The JSON representation for `Value` is JSON value.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | null_value |
- NullValue |
- |
- Represents a null value. |
-
-
-
- | number_value |
- double |
- |
- Represents a double value. |
-
-
-
- | string_value |
- string |
- |
- Represents a string value. |
-
-
-
- | bool_value |
- bool |
- |
- Represents a boolean value. |
-
-
-
- | struct_value |
- Struct |
- |
- Represents a structured value. |
-
-
-
- | list_value |
- ListValue |
- |
- Represents a repeated `Value`. |
-
-
-
-
-
-
-
-
-
-
- NullValue
- `NullValue` is a singleton enumeration to represent the null value for the
`Value` type union.
The JSON representation for `NullValue` is JSON `null`.
-
-
- | Name | Number | Description |
-
-
-
-
- | NULL_VALUE |
- 0 |
- Null value. |
-
-
-
-
-
-
-
-
-
-
-
-
-
google/protobuf/timestamp.proto
Top
-
Timestamp
- A Timestamp represents a point in time independent of any time zone
or calendar, represented as seconds and fractions of seconds at
nanosecond resolution in UTC Epoch time. It is encoded using the
Proleptic Gregorian Calendar which extends the Gregorian calendar
backwards to year one. It is encoded assuming all minutes are 60
seconds long, i.e. leap seconds are "smeared" so that no leap second
table is needed for interpretation. 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.
See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
# 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 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://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
) to obtain a formatter capable of generating timestamps in this format.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | seconds |
- int64 |
- |
- 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. |
-
-
-
- | nanos |
- int32 |
- |
- 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. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
google/protobuf/type.proto
Top
-
Enum
- Enum type definition.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- |
- Enum type name. |
-
-
-
- | enumvalue |
- EnumValue |
- repeated |
- Enum value definitions. |
-
-
-
- | options |
- Option |
- repeated |
- Protocol buffer options. |
-
-
-
- | source_context |
- SourceContext |
- |
- The source context. |
-
-
-
- | syntax |
- Syntax |
- |
- The source syntax. |
-
-
-
-
-
-
-
-
- EnumValue
- Enum value definition.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- |
- Enum value name. |
-
-
-
- | number |
- int32 |
- |
- Enum value number. |
-
-
-
- | options |
- Option |
- repeated |
- Protocol buffer options. |
-
-
-
-
-
-
-
-
- Field
- A single field of a message type.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | kind |
- Field.Kind |
- |
- The field type. |
-
-
-
- | cardinality |
- Field.Cardinality |
- |
- The field cardinality. |
-
-
-
- | number |
- int32 |
- |
- The field number. |
-
-
-
- | name |
- string |
- |
- The field name. |
-
-
-
- | type_url |
- string |
- |
- The field type URL, without the scheme, for message or enumeration
-types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. |
-
-
-
- | oneof_index |
- int32 |
- |
- 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. |
-
-
-
- | packed |
- bool |
- |
- Whether to use alternative packed wire representation. |
-
-
-
- | options |
- Option |
- repeated |
- The protocol buffer options. |
-
-
-
- | json_name |
- string |
- |
- The field JSON name. |
-
-
-
- | default_value |
- string |
- |
- The string value of the default value of this field. Proto2 syntax only. |
-
-
-
-
-
-
-
-
- Option
- A protocol buffer option, which can be attached to a message, field,
enumeration, etc.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- |
- 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"`. |
-
-
-
- | value |
- Any |
- |
- 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. |
-
-
-
-
-
-
-
-
- Type
- A protocol buffer message type.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | name |
- string |
- |
- The fully qualified message name. |
-
-
-
- | fields |
- Field |
- repeated |
- The list of fields. |
-
-
-
- | oneofs |
- string |
- repeated |
- The list of types appearing in `oneof` definitions in this type. |
-
-
-
- | options |
- Option |
- repeated |
- The protocol buffer options. |
-
-
-
- | source_context |
- SourceContext |
- |
- The source context. |
-
-
-
- | syntax |
- Syntax |
- |
- The source syntax. |
-
-
-
-
-
-
-
-
-
-
- Field.Cardinality
- Whether a field is optional, required, or repeated.
-
-
- | Name | Number | Description |
-
-
-
-
- | CARDINALITY_UNKNOWN |
- 0 |
- For fields with unknown cardinality. |
-
-
-
- | CARDINALITY_OPTIONAL |
- 1 |
- For optional fields. |
-
-
-
- | CARDINALITY_REQUIRED |
- 2 |
- For required fields. Proto2 syntax only. |
-
-
-
- | CARDINALITY_REPEATED |
- 3 |
- For repeated fields. |
-
-
-
-
-
- Field.Kind
- Basic field types.
-
-
- | Name | Number | Description |
-
-
-
-
- | TYPE_UNKNOWN |
- 0 |
- Field type unknown. |
-
-
-
- | TYPE_DOUBLE |
- 1 |
- Field type double. |
-
-
-
- | TYPE_FLOAT |
- 2 |
- Field type float. |
-
-
-
- | TYPE_INT64 |
- 3 |
- Field type int64. |
-
-
-
- | TYPE_UINT64 |
- 4 |
- Field type uint64. |
-
-
-
- | TYPE_INT32 |
- 5 |
- Field type int32. |
-
-
-
- | TYPE_FIXED64 |
- 6 |
- Field type fixed64. |
-
-
-
- | TYPE_FIXED32 |
- 7 |
- Field type fixed32. |
-
-
-
- | TYPE_BOOL |
- 8 |
- Field type bool. |
-
-
-
- | TYPE_STRING |
- 9 |
- Field type string. |
-
-
-
- | TYPE_GROUP |
- 10 |
- Field type group. Proto2 syntax only, and deprecated. |
-
-
-
- | TYPE_MESSAGE |
- 11 |
- Field type message. |
-
-
-
- | TYPE_BYTES |
- 12 |
- Field type bytes. |
-
-
-
- | TYPE_UINT32 |
- 13 |
- Field type uint32. |
-
-
-
- | TYPE_ENUM |
- 14 |
- Field type enum. |
-
-
-
- | TYPE_SFIXED32 |
- 15 |
- Field type sfixed32. |
-
-
-
- | TYPE_SFIXED64 |
- 16 |
- Field type sfixed64. |
-
-
-
- | TYPE_SINT32 |
- 17 |
- Field type sint32. |
-
-
-
- | TYPE_SINT64 |
- 18 |
- Field type sint64. |
-
-
-
-
-
- Syntax
- The syntax in which a protocol buffer element is defined.
-
-
- | Name | Number | Description |
-
-
-
-
- | SYNTAX_PROTO2 |
- 0 |
- Syntax `proto2`. |
-
-
-
- | SYNTAX_PROTO3 |
- 1 |
- Syntax `proto3`. |
-
-
-
-
-
-
-
-
-
-
-
-
-
google/protobuf/wrappers.proto
Top
-
BoolValue
- Wrapper message for `bool`.
The JSON representation for `BoolValue` is JSON `true` and `false`.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | value |
- bool |
- |
- The bool value. |
-
-
-
-
-
-
-
-
- BytesValue
- Wrapper message for `bytes`.
The JSON representation for `BytesValue` is JSON string.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | value |
- bytes |
- |
- The bytes value. |
-
-
-
-
-
-
-
-
- DoubleValue
- Wrapper message for `double`.
The JSON representation for `DoubleValue` is JSON number.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | value |
- double |
- |
- The double value. |
-
-
-
-
-
-
-
-
- FloatValue
- Wrapper message for `float`.
The JSON representation for `FloatValue` is JSON number.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | value |
- float |
- |
- The float value. |
-
-
-
-
-
-
-
-
- Int32Value
- Wrapper message for `int32`.
The JSON representation for `Int32Value` is JSON number.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | value |
- int32 |
- |
- The int32 value. |
-
-
-
-
-
-
-
-
- Int64Value
- Wrapper message for `int64`.
The JSON representation for `Int64Value` is JSON string.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | value |
- int64 |
- |
- The int64 value. |
-
-
-
-
-
-
-
-
- StringValue
- Wrapper message for `string`.
The JSON representation for `StringValue` is JSON string.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | value |
- string |
- |
- The string value. |
-
-
-
-
-
-
-
-
- UInt32Value
- Wrapper message for `uint32`.
The JSON representation for `UInt32Value` is JSON number.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | value |
- uint32 |
- |
- The uint32 value. |
-
-
-
-
-
-
-
-
- UInt64Value
- Wrapper message for `uint64`.
The JSON representation for `UInt64Value` is JSON string.
-
-
-
-
- | Field | Type | Label | Description |
-
-
-
-
- | value |
- uint64 |
- |
- The uint64 value. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
krotoplus/compiler/config.proto
Top
diff --git a/docs/markdown/kroto-plus-config.md b/docs/markdown/kroto-plus-config.md
index 646edaa..d97079d 100644
--- a/docs/markdown/kroto-plus-config.md
+++ b/docs/markdown/kroto-plus-config.md
@@ -3,146 +3,6 @@
## Table of Contents
-- [google/protobuf/any.proto](#google/protobuf/any.proto)
- - [Any](#google.protobuf.Any)
-
-
-
-
-
-- [google/protobuf/api.proto](#google/protobuf/api.proto)
- - [Api](#google.protobuf.Api)
- - [Method](#google.protobuf.Method)
- - [Mixin](#google.protobuf.Mixin)
-
-
-
-
-
-- [google/protobuf/compiler/plugin.proto](#google/protobuf/compiler/plugin.proto)
- - [CodeGeneratorRequest](#google.protobuf.compiler.CodeGeneratorRequest)
- - [CodeGeneratorResponse](#google.protobuf.compiler.CodeGeneratorResponse)
- - [CodeGeneratorResponse.File](#google.protobuf.compiler.CodeGeneratorResponse.File)
- - [Version](#google.protobuf.compiler.Version)
-
-
-
-
-
-- [google/protobuf/descriptor.proto](#google/protobuf/descriptor.proto)
- - [DescriptorProto](#google.protobuf.DescriptorProto)
- - [DescriptorProto.ExtensionRange](#google.protobuf.DescriptorProto.ExtensionRange)
- - [DescriptorProto.ReservedRange](#google.protobuf.DescriptorProto.ReservedRange)
- - [EnumDescriptorProto](#google.protobuf.EnumDescriptorProto)
- - [EnumDescriptorProto.EnumReservedRange](#google.protobuf.EnumDescriptorProto.EnumReservedRange)
- - [EnumOptions](#google.protobuf.EnumOptions)
- - [EnumValueDescriptorProto](#google.protobuf.EnumValueDescriptorProto)
- - [EnumValueOptions](#google.protobuf.EnumValueOptions)
- - [ExtensionRangeOptions](#google.protobuf.ExtensionRangeOptions)
- - [FieldDescriptorProto](#google.protobuf.FieldDescriptorProto)
- - [FieldOptions](#google.protobuf.FieldOptions)
- - [FileDescriptorProto](#google.protobuf.FileDescriptorProto)
- - [FileDescriptorSet](#google.protobuf.FileDescriptorSet)
- - [FileOptions](#google.protobuf.FileOptions)
- - [GeneratedCodeInfo](#google.protobuf.GeneratedCodeInfo)
- - [GeneratedCodeInfo.Annotation](#google.protobuf.GeneratedCodeInfo.Annotation)
- - [MessageOptions](#google.protobuf.MessageOptions)
- - [MethodDescriptorProto](#google.protobuf.MethodDescriptorProto)
- - [MethodOptions](#google.protobuf.MethodOptions)
- - [OneofDescriptorProto](#google.protobuf.OneofDescriptorProto)
- - [OneofOptions](#google.protobuf.OneofOptions)
- - [ServiceDescriptorProto](#google.protobuf.ServiceDescriptorProto)
- - [ServiceOptions](#google.protobuf.ServiceOptions)
- - [SourceCodeInfo](#google.protobuf.SourceCodeInfo)
- - [SourceCodeInfo.Location](#google.protobuf.SourceCodeInfo.Location)
- - [UninterpretedOption](#google.protobuf.UninterpretedOption)
- - [UninterpretedOption.NamePart](#google.protobuf.UninterpretedOption.NamePart)
-
- - [FieldDescriptorProto.Label](#google.protobuf.FieldDescriptorProto.Label)
- - [FieldDescriptorProto.Type](#google.protobuf.FieldDescriptorProto.Type)
- - [FieldOptions.CType](#google.protobuf.FieldOptions.CType)
- - [FieldOptions.JSType](#google.protobuf.FieldOptions.JSType)
- - [FileOptions.OptimizeMode](#google.protobuf.FileOptions.OptimizeMode)
- - [MethodOptions.IdempotencyLevel](#google.protobuf.MethodOptions.IdempotencyLevel)
-
-
-
-
-- [google/protobuf/duration.proto](#google/protobuf/duration.proto)
- - [Duration](#google.protobuf.Duration)
-
-
-
-
-
-- [google/protobuf/empty.proto](#google/protobuf/empty.proto)
- - [Empty](#google.protobuf.Empty)
-
-
-
-
-
-- [google/protobuf/field_mask.proto](#google/protobuf/field_mask.proto)
- - [FieldMask](#google.protobuf.FieldMask)
-
-
-
-
-
-- [google/protobuf/source_context.proto](#google/protobuf/source_context.proto)
- - [SourceContext](#google.protobuf.SourceContext)
-
-
-
-
-
-- [google/protobuf/struct.proto](#google/protobuf/struct.proto)
- - [ListValue](#google.protobuf.ListValue)
- - [Struct](#google.protobuf.Struct)
- - [Struct.FieldsEntry](#google.protobuf.Struct.FieldsEntry)
- - [Value](#google.protobuf.Value)
-
- - [NullValue](#google.protobuf.NullValue)
-
-
-
-
-- [google/protobuf/timestamp.proto](#google/protobuf/timestamp.proto)
- - [Timestamp](#google.protobuf.Timestamp)
-
-
-
-
-
-- [google/protobuf/type.proto](#google/protobuf/type.proto)
- - [Enum](#google.protobuf.Enum)
- - [EnumValue](#google.protobuf.EnumValue)
- - [Field](#google.protobuf.Field)
- - [Option](#google.protobuf.Option)
- - [Type](#google.protobuf.Type)
-
- - [Field.Cardinality](#google.protobuf.Field.Cardinality)
- - [Field.Kind](#google.protobuf.Field.Kind)
- - [Syntax](#google.protobuf.Syntax)
-
-
-
-
-- [google/protobuf/wrappers.proto](#google/protobuf/wrappers.proto)
- - [BoolValue](#google.protobuf.BoolValue)
- - [BytesValue](#google.protobuf.BytesValue)
- - [DoubleValue](#google.protobuf.DoubleValue)
- - [FloatValue](#google.protobuf.FloatValue)
- - [Int32Value](#google.protobuf.Int32Value)
- - [Int64Value](#google.protobuf.Int64Value)
- - [StringValue](#google.protobuf.StringValue)
- - [UInt32Value](#google.protobuf.UInt32Value)
- - [UInt64Value](#google.protobuf.UInt64Value)
-
-
-
-
-
- [krotoplus/compiler/config.proto](#krotoplus/compiler/config.proto)
- [CompilerConfig](#krotoplus.compiler.CompilerConfig)
- [ExtenableMessagesGenOptions](#krotoplus.compiler.ExtenableMessagesGenOptions)
@@ -164,2023 +24,6 @@
-
-Top
-
-## google/protobuf/any.proto
-
-
-
-
-
-### Any
-`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);
- }
-
- 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 := ptypes.MarshalAny(foo)
- ...
- foo := &pb.Foo{}
- if err := ptypes.UnmarshalAny(any, 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": <string>,
- "lastName": <string>
- }
-
-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"
- }
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| type_url | [string](#string) | | A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. 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.
-
-Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. |
-| value | [bytes](#bytes) | | Must be a valid serialized protocol buffer of the above specified type. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Top
-
-## google/protobuf/api.proto
-
-
-
-
-
-### Api
-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.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The fully qualified name of this interface, including package name followed by the interface's simple name. |
-| methods | [Method](#google.protobuf.Method) | repeated | The methods of this interface, in unspecified order. |
-| options | [Option](#google.protobuf.Option) | repeated | Any metadata attached to the interface. |
-| version | [string](#string) | | 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<major-version>`, 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_context | [SourceContext](#google.protobuf.SourceContext) | | Source context for the protocol buffer service represented by this message. |
-| mixins | [Mixin](#google.protobuf.Mixin) | repeated | Included interfaces. See [Mixin][]. |
-| syntax | [Syntax](#google.protobuf.Syntax) | | The source syntax of the service. |
-
-
-
-
-
-
-
-
-### Method
-Method represents a method of an API interface.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The simple name of this method. |
-| request_type_url | [string](#string) | | A URL of the input message type. |
-| request_streaming | [bool](#bool) | | If true, the request is streamed. |
-| response_type_url | [string](#string) | | The URL of the output message type. |
-| response_streaming | [bool](#bool) | | If true, the response is streamed. |
-| options | [Option](#google.protobuf.Option) | repeated | Any metadata attached to the method. |
-| syntax | [Syntax](#google.protobuf.Syntax) | | The source syntax of this method. |
-
-
-
-
-
-
-
-
-### Mixin
-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";
- }
- ...
- }
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The fully qualified name of the interface which is included. |
-| root | [string](#string) | | If non-empty specifies a path under which inherited HTTP paths are rooted. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Top
-
-## google/protobuf/compiler/plugin.proto
-
-
-
-
-
-### CodeGeneratorRequest
-An encoded CodeGeneratorRequest is written to the plugin's stdin.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| file_to_generate | [string](#string) | repeated | The .proto files that were explicitly listed on the command-line. The code generator should generate code only for these files. Each file's descriptor will be included in proto_file, below. |
-| parameter | [string](#string) | optional | The generator parameter passed on the command-line. |
-| proto_file | [google.protobuf.FileDescriptorProto](#google.protobuf.FileDescriptorProto) | repeated | FileDescriptorProtos for all files in files_to_generate and everything they import. The files will appear in topological order, so each file appears before any file that imports it.
-
-protoc guarantees that all proto_files will be written after the fields above, even though this is not technically guaranteed by the protobuf wire format. This theoretically could allow a plugin to stream in the FileDescriptorProtos and handle them one by one rather than read the entire set into memory at once. However, as of this writing, this is not similarly optimized on protoc's end -- it will store all fields in memory at once before sending them to the plugin.
-
-Type names of fields and extensions in the FileDescriptorProto are always fully qualified. |
-| compiler_version | [Version](#google.protobuf.compiler.Version) | optional | The version number of protocol compiler. |
-
-
-
-
-
-
-
-
-### CodeGeneratorResponse
-The plugin writes an encoded CodeGeneratorResponse to stdout.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| error | [string](#string) | optional | Error message. If non-empty, code generation failed. The plugin process should exit with status code zero even if it reports an error in this way.
-
-This should be used to indicate errors in .proto files which prevent the code generator from generating correct code. Errors which indicate a problem in protoc itself -- such as the input CodeGeneratorRequest being unparseable -- should be reported by writing a message to stderr and exiting with a non-zero status code. |
-| file | [CodeGeneratorResponse.File](#google.protobuf.compiler.CodeGeneratorResponse.File) | repeated | |
-
-
-
-
-
-
-
-
-### CodeGeneratorResponse.File
-Represents a single generated file.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | optional | The file name, relative to the output directory. The name must not contain "." or ".." components and must be relative, not be absolute (so, the file cannot lie outside the output directory). "/" must be used as the path separator, not "\".
-
-If the name is omitted, the content will be appended to the previous file. This allows the generator to break large files into small chunks, and allows the generated text to be streamed back to protoc so that large files need not reside completely in memory at one time. Note that as of this writing protoc does not optimize for this -- it will read the entire CodeGeneratorResponse before writing files to disk. |
-| insertion_point | [string](#string) | optional | If non-empty, indicates that the named file should already exist, and the content here is to be inserted into that file at a defined insertion point. This feature allows a code generator to extend the output produced by another code generator. The original generator may provide insertion points by placing special annotations in the file that look like: @@protoc_insertion_point(NAME) The annotation can have arbitrary text before and after it on the line, which allows it to be placed in a comment. NAME should be replaced with an identifier naming the point -- this is what other generators will use as the insertion_point. Code inserted at this point will be placed immediately above the line containing the insertion point (thus multiple insertions to the same point will come out in the order they were added). The double-@ is intended to make it unlikely that the generated code could contain things that look like insertion points by accident.
-
-For example, the C++ code generator places the following line in the .pb.h files that it generates: // @@protoc_insertion_point(namespace_scope) This line appears within the scope of the file's package namespace, but outside of any particular class. Another plugin can then specify the insertion_point "namespace_scope" to generate additional classes or other declarations that should be placed in this scope.
-
-Note that if the line containing the insertion point begins with whitespace, the same whitespace will be added to every line of the inserted text. This is useful for languages like Python, where indentation matters. In these languages, the insertion point comment should be indented the same amount as any inserted code will need to be in order to work correctly in that context.
-
-The code generator that generates the initial file and the one which inserts into it must both run as part of a single invocation of protoc. Code generators are executed in the order in which they appear on the command line.
-
-If |insertion_point| is present, |name| must also be present. |
-| content | [string](#string) | optional | The file contents. |
-
-
-
-
-
-
-
-
-### Version
-The version number of protocol compiler.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| major | [int32](#int32) | optional | |
-| minor | [int32](#int32) | optional | |
-| patch | [int32](#int32) | optional | |
-| suffix | [string](#string) | optional | A suffix for alpha, beta or rc release, e.g., "alpha-1", "rc2". It should be empty for mainline stable releases. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Top
-
-## google/protobuf/descriptor.proto
-
-
-
-
-
-### DescriptorProto
-Describes a message type.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | optional | |
-| field | [FieldDescriptorProto](#google.protobuf.FieldDescriptorProto) | repeated | |
-| extension | [FieldDescriptorProto](#google.protobuf.FieldDescriptorProto) | repeated | |
-| nested_type | [DescriptorProto](#google.protobuf.DescriptorProto) | repeated | |
-| enum_type | [EnumDescriptorProto](#google.protobuf.EnumDescriptorProto) | repeated | |
-| extension_range | [DescriptorProto.ExtensionRange](#google.protobuf.DescriptorProto.ExtensionRange) | repeated | |
-| oneof_decl | [OneofDescriptorProto](#google.protobuf.OneofDescriptorProto) | repeated | |
-| options | [MessageOptions](#google.protobuf.MessageOptions) | optional | |
-| reserved_range | [DescriptorProto.ReservedRange](#google.protobuf.DescriptorProto.ReservedRange) | repeated | |
-| reserved_name | [string](#string) | repeated | Reserved field names, which may not be used by fields in the same message. A given name may only be reserved once. |
-
-
-
-
-
-
-
-
-### DescriptorProto.ExtensionRange
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| start | [int32](#int32) | optional | |
-| end | [int32](#int32) | optional | |
-| options | [ExtensionRangeOptions](#google.protobuf.ExtensionRangeOptions) | optional | |
-
-
-
-
-
-
-
-
-### DescriptorProto.ReservedRange
-Range of reserved tag numbers. Reserved tag numbers may not be used by
-fields or extension ranges in the same message. Reserved ranges may
-not overlap.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| start | [int32](#int32) | optional | Inclusive. |
-| end | [int32](#int32) | optional | Exclusive. |
-
-
-
-
-
-
-
-
-### EnumDescriptorProto
-Describes an enum type.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | optional | |
-| value | [EnumValueDescriptorProto](#google.protobuf.EnumValueDescriptorProto) | repeated | |
-| options | [EnumOptions](#google.protobuf.EnumOptions) | optional | |
-| reserved_range | [EnumDescriptorProto.EnumReservedRange](#google.protobuf.EnumDescriptorProto.EnumReservedRange) | repeated | Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap. |
-| reserved_name | [string](#string) | repeated | Reserved enum value names, which may not be reused. A given name may only be reserved once. |
-
-
-
-
-
-
-
-
-### EnumDescriptorProto.EnumReservedRange
-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.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| start | [int32](#int32) | optional | Inclusive. |
-| end | [int32](#int32) | optional | Inclusive. |
-
-
-
-
-
-
-
-
-### EnumOptions
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| allow_alias | [bool](#bool) | optional | Set this option to true to allow mapping different tag names to the same value. |
-| deprecated | [bool](#bool) | optional | Is this enum deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum, or it will be completely ignored; in the very least, this is a formalization for deprecating enums. Default: false |
-| uninterpreted_option | [UninterpretedOption](#google.protobuf.UninterpretedOption) | repeated | The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
-### EnumValueDescriptorProto
-Describes a value within an enum.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | optional | |
-| number | [int32](#int32) | optional | |
-| options | [EnumValueOptions](#google.protobuf.EnumValueOptions) | optional | |
-
-
-
-
-
-
-
-
-### EnumValueOptions
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| deprecated | [bool](#bool) | optional | Is this enum value deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum value, or it will be completely ignored; in the very least, this is a formalization for deprecating enum values. Default: false |
-| uninterpreted_option | [UninterpretedOption](#google.protobuf.UninterpretedOption) | repeated | The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
-### ExtensionRangeOptions
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| uninterpreted_option | [UninterpretedOption](#google.protobuf.UninterpretedOption) | repeated | The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
-### FieldDescriptorProto
-Describes a field within a message.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | optional | |
-| number | [int32](#int32) | optional | |
-| label | [FieldDescriptorProto.Label](#google.protobuf.FieldDescriptorProto.Label) | optional | |
-| type | [FieldDescriptorProto.Type](#google.protobuf.FieldDescriptorProto.Type) | optional | If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP. |
-| type_name | [string](#string) | optional | For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace). |
-| extendee | [string](#string) | optional | For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name. |
-| default_value | [string](#string) | optional | For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. TODO(kenton): Base-64 encode? |
-| oneof_index | [int32](#int32) | optional | If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. |
-| json_name | [string](#string) | optional | JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase. |
-| options | [FieldOptions](#google.protobuf.FieldOptions) | optional | |
-
-
-
-
-
-
-
-
-### FieldOptions
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| ctype | [FieldOptions.CType](#google.protobuf.FieldOptions.CType) | optional | The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is not yet implemented in the open source release -- sorry, we'll try to include it in a future version! Default: STRING |
-| packed | [bool](#bool) | optional | The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. Rather than repeatedly writing the tag and type for each element, the entire array is encoded as a single length-delimited blob. In proto3, only explicit setting it to false will avoid using packed encoding. |
-| jstype | [FieldOptions.JSType](#google.protobuf.FieldOptions.JSType) | optional | The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent.
-
-This option is an enum to permit additional types to be added, e.g. goog.math.Integer. Default: JS_NORMAL |
-| lazy | [bool](#bool) | optional | Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed.
-
-This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it.
-
-This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access.
-
-Note that implementations may choose not to check required fields within a lazy sub-message. That is, calling IsInitialized() on the outer message may return true even if the inner message has missing required fields. This is necessary because otherwise the inner message would have to be parsed in order to perform the check, defeating the purpose of lazy parsing. An implementation which chooses not to check required fields must be consistent about it. That is, for any particular sub-message, the implementation must either *always* check its required fields, or *never* check its required fields, regardless of whether or not the message has been parsed. Default: false |
-| deprecated | [bool](#bool) | optional | Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields. Default: false |
-| weak | [bool](#bool) | optional | For Google-internal migration only. Do not use. Default: false |
-| uninterpreted_option | [UninterpretedOption](#google.protobuf.UninterpretedOption) | repeated | The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
-### FileDescriptorProto
-Describes a complete .proto file.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | optional | file name, relative to root of source tree |
-| package | [string](#string) | optional | e.g. "foo", "foo.bar", etc. |
-| dependency | [string](#string) | repeated | Names of files imported by this file. |
-| public_dependency | [int32](#int32) | repeated | Indexes of the public imported files in the dependency list above. |
-| weak_dependency | [int32](#int32) | repeated | Indexes of the weak imported files in the dependency list. For Google-internal migration only. Do not use. |
-| message_type | [DescriptorProto](#google.protobuf.DescriptorProto) | repeated | All top-level definitions in this file. |
-| enum_type | [EnumDescriptorProto](#google.protobuf.EnumDescriptorProto) | repeated | |
-| service | [ServiceDescriptorProto](#google.protobuf.ServiceDescriptorProto) | repeated | |
-| extension | [FieldDescriptorProto](#google.protobuf.FieldDescriptorProto) | repeated | |
-| options | [FileOptions](#google.protobuf.FileOptions) | optional | |
-| source_code_info | [SourceCodeInfo](#google.protobuf.SourceCodeInfo) | optional | This field contains optional information about the original source code. You may safely remove this entire field without harming runtime functionality of the descriptors -- the information is needed only by development tools. |
-| syntax | [string](#string) | optional | The syntax of the proto file. The supported values are "proto2" and "proto3". |
-
-
-
-
-
-
-
-
-### FileDescriptorSet
-The protocol compiler can output a FileDescriptorSet containing the .proto
-files it parses.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| file | [FileDescriptorProto](#google.protobuf.FileDescriptorProto) | repeated | |
-
-
-
-
-
-
-
-
-### FileOptions
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| java_package | [string](#string) | optional | Sets the Java package where classes generated from this .proto will be placed. By default, the proto package is used, but this is often inappropriate because proto packages do not normally start with backwards domain names. |
-| java_outer_classname | [string](#string) | optional | If set, all the classes from the .proto file are wrapped in a single outer class with the given name. This applies to both Proto1 (equivalent to the old "--one_java_file" option) and Proto2 (where a .proto always translates to a single class, but you may want to explicitly choose the class name). |
-| java_multiple_files | [bool](#bool) | optional | If set true, then the Java code generator will generate a separate .java file for each top-level message, enum, and service defined in the .proto file. Thus, these types will *not* be nested inside the outer class named by java_outer_classname. However, the outer class will still be generated to contain the file's getDescriptor() method as well as any top-level extensions defined in the file. Default: false |
-| java_generate_equals_and_hash | [bool](#bool) | optional | This option does nothing. |
-| java_string_check_utf8 | [bool](#bool) | optional | If set true, then the Java2 code generator will generate code that throws an exception whenever an attempt is made to assign a non-UTF-8 byte sequence to a string field. Message reflection will do the same. However, an extension field still accepts non-UTF-8 byte sequences. This option has no effect on when used with the lite runtime. Default: false |
-| optimize_for | [FileOptions.OptimizeMode](#google.protobuf.FileOptions.OptimizeMode) | optional | Default: SPEED |
-| go_package | [string](#string) | optional | Sets the Go package where structs generated from this .proto will be placed. If omitted, the Go package will be derived from the following: - The basename of the package import path, if provided. - Otherwise, the package statement in the .proto file, if present. - Otherwise, the basename of the .proto file, without extension. |
-| cc_generic_services | [bool](#bool) | optional | Should generic services be generated in each language? "Generic" services are not specific to any particular RPC system. They are generated by the main code generators in each language (without additional plugins). Generic services were the only kind of service generation supported by early versions of google.protobuf.
-
-Generic services are now considered deprecated in favor of using plugins that generate code specific to your particular RPC system. Therefore, these default to false. Old code which depends on generic services should explicitly set them to true. Default: false |
-| java_generic_services | [bool](#bool) | optional | Default: false |
-| py_generic_services | [bool](#bool) | optional | Default: false |
-| php_generic_services | [bool](#bool) | optional | Default: false |
-| deprecated | [bool](#bool) | optional | Is this file deprecated? Depending on the target platform, this can emit Deprecated annotations for everything in the file, or it will be completely ignored; in the very least, this is a formalization for deprecating files. Default: false |
-| cc_enable_arenas | [bool](#bool) | optional | Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++. Default: false |
-| objc_class_prefix | [string](#string) | optional | Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default. |
-| csharp_namespace | [string](#string) | optional | Namespace for generated classes; defaults to the package. |
-| swift_prefix | [string](#string) | optional | By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. When this options is provided, they will use this value instead to prefix the types/symbols defined. |
-| php_class_prefix | [string](#string) | optional | Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty. |
-| php_namespace | [string](#string) | optional | Use this option to change the namespace of php generated classes. Default is empty. When this option is empty, the package name will be used for determining the namespace. |
-| php_metadata_namespace | [string](#string) | optional | Use this option to change the namespace of php generated metadata classes. Default is empty. When this option is empty, the proto file name will be used for determining the namespace. |
-| ruby_package | [string](#string) | optional | Use this option to change the package of ruby generated classes. Default is empty. When this option is not set, the package name will be used for determining the ruby package. |
-| uninterpreted_option | [UninterpretedOption](#google.protobuf.UninterpretedOption) | repeated | The parser stores options it doesn't recognize here. See the documentation for the "Options" section above. |
-
-
-
-
-
-
-
-
-### GeneratedCodeInfo
-Describes the relationship between generated code and its original source
-file. A GeneratedCodeInfo message is associated with only one generated
-source file, but may contain references to different source .proto files.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| annotation | [GeneratedCodeInfo.Annotation](#google.protobuf.GeneratedCodeInfo.Annotation) | repeated | An Annotation connects some span of text in generated code to an element of its generating .proto file. |
-
-
-
-
-
-
-
-
-### GeneratedCodeInfo.Annotation
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| path | [int32](#int32) | repeated | Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path. |
-| source_file | [string](#string) | optional | Identifies the filesystem path to the original source .proto. |
-| begin | [int32](#int32) | optional | Identifies the starting offset in bytes in the generated code that relates to the identified object. |
-| end | [int32](#int32) | optional | Identifies the ending offset in bytes in the generated code that relates to the identified offset. The end offset should be one past the last relevant byte (so the length of the text = end - begin). |
-
-
-
-
-
-
-
-
-### MessageOptions
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| message_set_wire_format | [bool](#bool) | optional | Set true to use the old proto1 MessageSet wire format for extensions. This is provided for backwards-compatibility with the MessageSet wire format. You should not use this for any other reason: It's less efficient, has fewer features, and is more complicated.
-
-The message must be defined exactly as follows: message Foo { option message_set_wire_format = true; extensions 4 to max; } Note that the message cannot have any defined fields; MessageSets only have extensions.
-
-All extensions of your type must be singular messages; e.g. they cannot be int32s, enums, or repeated messages.
-
-Because this is an option, the above two restrictions are not enforced by the protocol compiler. Default: false |
-| no_standard_descriptor_accessor | [bool](#bool) | optional | Disables the generation of the standard "descriptor()" accessor, which can conflict with a field of the same name. This is meant to make migration from proto1 easier; new code should avoid fields named "descriptor". Default: false |
-| deprecated | [bool](#bool) | optional | Is this message deprecated? Depending on the target platform, this can emit Deprecated annotations for the message, or it will be completely ignored; in the very least, this is a formalization for deprecating messages. Default: false |
-| map_entry | [bool](#bool) | optional | Whether the message is an automatically generated map entry type for the maps field.
-
-For maps fields: map<KeyType, ValueType> map_field = 1; The parsed descriptor looks like: message MapFieldEntry { option map_entry = true; optional KeyType key = 1; optional ValueType value = 2; } repeated MapFieldEntry map_field = 1;
-
-Implementations may choose not to generate the map_entry=true message, but use a native map in the target language to hold the keys and values. The reflection APIs in such implementions still need to work as if the field is a repeated message field.
-
-NOTE: Do not set the option in .proto files. Always use the maps syntax instead. The option should only be implicitly set by the proto compiler parser. |
-| uninterpreted_option | [UninterpretedOption](#google.protobuf.UninterpretedOption) | repeated | The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
-### MethodDescriptorProto
-Describes a method of a service.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | optional | |
-| input_type | [string](#string) | optional | Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type. |
-| output_type | [string](#string) | optional | |
-| options | [MethodOptions](#google.protobuf.MethodOptions) | optional | |
-| client_streaming | [bool](#bool) | optional | Identifies if client streams multiple client messages Default: false |
-| server_streaming | [bool](#bool) | optional | Identifies if server streams multiple server messages Default: false |
-
-
-
-
-
-
-
-
-### MethodOptions
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| deprecated | [bool](#bool) | optional | Is this method deprecated? Depending on the target platform, this can emit Deprecated annotations for the method, or it will be completely ignored; in the very least, this is a formalization for deprecating methods. Default: false |
-| idempotency_level | [MethodOptions.IdempotencyLevel](#google.protobuf.MethodOptions.IdempotencyLevel) | optional | Default: IDEMPOTENCY_UNKNOWN |
-| uninterpreted_option | [UninterpretedOption](#google.protobuf.UninterpretedOption) | repeated | The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
-### OneofDescriptorProto
-Describes a oneof.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | optional | |
-| options | [OneofOptions](#google.protobuf.OneofOptions) | optional | |
-
-
-
-
-
-
-
-
-### OneofOptions
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| uninterpreted_option | [UninterpretedOption](#google.protobuf.UninterpretedOption) | repeated | The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
-### ServiceDescriptorProto
-Describes a service.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | optional | |
-| method | [MethodDescriptorProto](#google.protobuf.MethodDescriptorProto) | repeated | |
-| options | [ServiceOptions](#google.protobuf.ServiceOptions) | optional | |
-
-
-
-
-
-
-
-
-### ServiceOptions
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| deprecated | [bool](#bool) | optional | Is this service deprecated? Depending on the target platform, this can emit Deprecated annotations for the service, or it will be completely ignored; in the very least, this is a formalization for deprecating services. Default: false |
-| uninterpreted_option | [UninterpretedOption](#google.protobuf.UninterpretedOption) | repeated | The parser stores options it doesn't recognize here. See above. |
-
-
-
-
-
-
-
-
-### SourceCodeInfo
-Encapsulates information about the original source file from which a
-FileDescriptorProto was generated.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| location | [SourceCodeInfo.Location](#google.protobuf.SourceCodeInfo.Location) | repeated | A Location identifies a piece of source code in a .proto file which corresponds to a particular definition. This information is intended to be useful to IDEs, code indexers, documentation generators, and similar tools.
-
-For example, say we have a file like: message Foo { optional string foo = 1; } Let's look at just the field definition: optional string foo = 1; ^ ^^ ^^ ^ ^^^ a bc de f ghi We have the following locations: span path represents [a,i) [ 4, 0, 2, 0 ] The whole field definition. [a,b) [ 4, 0, 2, 0, 4 ] The label (optional). [c,d) [ 4, 0, 2, 0, 5 ] The type (string). [e,f) [ 4, 0, 2, 0, 1 ] The name (foo). [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
-
-Notes: - A location may refer to a repeated field itself (i.e. not to any particular index within it). This is used whenever a set of elements are logically enclosed in a single code segment. For example, an entire extend block (possibly containing multiple extension definitions) will have an outer location whose path refers to the "extensions" repeated field without an index. - Multiple locations may have the same path. This happens when a single logical declaration is spread out across multiple places. The most obvious example is the "extend" block again -- there may be multiple extend blocks in the same scope, each of which will have the same path. - A location's span is not always a subset of its parent's span. For example, the "extendee" of an extension declaration appears at the beginning of the "extend" block and is shared by all extensions within the block. - Just because a location's span is a subset of some other location's span does not mean that it is a descendent. For example, a "group" defines both a type and a field in a single declaration. Thus, the locations corresponding to the type and field and their components will overlap. - Code which tries to interpret locations should probably be designed to ignore those that it doesn't understand, as more types of locations could be recorded in the future. |
-
-
-
-
-
-
-
-
-### SourceCodeInfo.Location
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| path | [int32](#int32) | repeated | Identifies which part of the FileDescriptorProto was defined at this location.
-
-Each element is a field number or an index. They form a path from the root FileDescriptorProto to the place where the definition. For example, this path: [ 4, 3, 2, 7, 1 ] refers to: file.message_type(3) // 4, 3 .field(7) // 2, 7 .name() // 1 This is because FileDescriptorProto.message_type has field number 4: repeated DescriptorProto message_type = 4; and DescriptorProto.field has field number 2: repeated FieldDescriptorProto field = 2; and FieldDescriptorProto.name has field number 1: optional string name = 1;
-
-Thus, the above path gives the location of a field name. If we removed the last element: [ 4, 3, 2, 7 ] this path refers to the whole field declaration (from the beginning of the label to the terminating semicolon). |
-| span | [int32](#int32) | repeated | Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column. These are packed into a single field for efficiency. Note that line and column numbers are zero-based -- typically you will want to add 1 to each before displaying to a user. |
-| leading_comments | [string](#string) | optional | If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration.
-
-A series of line comments appearing on consecutive lines, with no other tokens appearing on those lines, will be treated as a single comment.
-
-leading_detached_comments will keep paragraphs of comments that appear before (but not connected to) the current element. Each paragraph, separated by empty lines, will be one comment element in the repeated field.
-
-Only the comment content is provided; comment markers (e.g. //) are stripped out. For block comments, leading whitespace and an asterisk will be stripped from the beginning of each line other than the first. Newlines are included in the output.
-
-Examples:
-
- optional int32 foo = 1; // Comment attached to foo. // Comment attached to bar. optional int32 bar = 2;
-
- optional string baz = 3; // Comment attached to baz. // Another line attached to baz.
-
- // Comment attached to qux. // // Another line attached to qux. optional double qux = 4;
-
- // Detached comment for corge. This is not leading or trailing comments // to qux or corge because there are blank lines separating it from // both.
-
- // Detached comment for corge paragraph 2.
-
- optional string corge = 5; /* Block comment attached * to corge. Leading asterisks * will be removed. */ /* Block comment attached to * grault. */ optional int32 grault = 6;
-
- // ignored detached comments. |
-| trailing_comments | [string](#string) | optional | |
-| leading_detached_comments | [string](#string) | repeated | |
-
-
-
-
-
-
-
-
-### UninterpretedOption
-A message representing a option the parser does not recognize. This only
-appears in options protos created by the compiler::Parser class.
-DescriptorPool resolves these when building Descriptor objects. Therefore,
-options protos in descriptor objects (e.g. returned by Descriptor::options(),
-or produced by Descriptor::CopyTo()) will never have UninterpretedOptions
-in them.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [UninterpretedOption.NamePart](#google.protobuf.UninterpretedOption.NamePart) | repeated | |
-| identifier_value | [string](#string) | optional | The value of the uninterpreted option, in whatever type the tokenizer identified it as during parsing. Exactly one of these should be set. |
-| positive_int_value | [uint64](#uint64) | optional | |
-| negative_int_value | [int64](#int64) | optional | |
-| double_value | [double](#double) | optional | |
-| string_value | [bytes](#bytes) | optional | |
-| aggregate_value | [string](#string) | optional | |
-
-
-
-
-
-
-
-
-### UninterpretedOption.NamePart
-The name of the uninterpreted option. Each string represents a segment in
-a dot-separated name. is_extension is true iff a segment represents an
-extension (denoted with parentheses in options specs in .proto files).
-E.g.,{ ["foo", false], ["bar.baz", true], ["qux", false] } represents
-"foo.(bar.baz).qux".
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name_part | [string](#string) | required | |
-| is_extension | [bool](#bool) | required | |
-
-
-
-
-
-
-
-
-
-
-### FieldDescriptorProto.Label
-
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| LABEL_OPTIONAL | 1 | 0 is reserved for errors |
-| LABEL_REQUIRED | 2 | |
-| LABEL_REPEATED | 3 | |
-
-
-
-
-
-### FieldDescriptorProto.Type
-
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_DOUBLE | 1 | 0 is reserved for errors. Order is weird for historical reasons. |
-| TYPE_FLOAT | 2 | |
-| TYPE_INT64 | 3 | Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if negative values are likely. |
-| TYPE_UINT64 | 4 | |
-| TYPE_INT32 | 5 | Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if negative values are likely. |
-| TYPE_FIXED64 | 6 | |
-| TYPE_FIXED32 | 7 | |
-| TYPE_BOOL | 8 | |
-| TYPE_STRING | 9 | |
-| TYPE_GROUP | 10 | Tag-delimited aggregate. Group type is deprecated and not supported in proto3. However, Proto3 implementations should still be able to parse the group wire format and treat group fields as unknown fields. |
-| TYPE_MESSAGE | 11 | Length-delimited aggregate. |
-| TYPE_BYTES | 12 | New in version 2. |
-| TYPE_UINT32 | 13 | |
-| TYPE_ENUM | 14 | |
-| TYPE_SFIXED32 | 15 | |
-| TYPE_SFIXED64 | 16 | |
-| TYPE_SINT32 | 17 | Uses ZigZag encoding. |
-| TYPE_SINT64 | 18 | Uses ZigZag encoding. |
-
-
-
-
-
-### FieldOptions.CType
-
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STRING | 0 | Default mode. |
-| CORD | 1 | |
-| STRING_PIECE | 2 | |
-
-
-
-
-
-### FieldOptions.JSType
-
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| JS_NORMAL | 0 | Use the default type. |
-| JS_STRING | 1 | Use JavaScript strings. |
-| JS_NUMBER | 2 | Use JavaScript numbers. |
-
-
-
-
-
-### FileOptions.OptimizeMode
-Generated classes can be optimized for speed or code size.
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| SPEED | 1 | Generate complete code for parsing, serialization, |
-| CODE_SIZE | 2 | etc.
-
-Use ReflectionOps to implement these methods. |
-| LITE_RUNTIME | 3 | Generate code using MessageLite and the lite runtime. |
-
-
-
-
-
-### MethodOptions.IdempotencyLevel
-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.
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| IDEMPOTENCY_UNKNOWN | 0 | |
-| NO_SIDE_EFFECTS | 1 | implies idempotent |
-| IDEMPOTENT | 2 | idempotent, but may have side effects |
-
-
-
-
-
-
-
-
-
-
-
-Top
-
-## google/protobuf/duration.proto
-
-
-
-
-
-### Duration
-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 (durations.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".
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| seconds | [int64](#int64) | | 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 |
-| nanos | [int32](#int32) | | 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. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Top
-
-## google/protobuf/empty.proto
-
-
-
-
-
-### Empty
-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);
- }
-
-The JSON representation for `Empty` is empty JSON object `{}`.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Top
-
-## google/protobuf/field_mask.proto
-
-
-
-
-
-### FieldMask
-`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, the existing
-repeated values in the target resource will be overwritten by the new values.
-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 the existing sub-message in the target resource is
-overwritten. Given the target message:
-
- f {
- b {
- d : 1
- x : 2
- }
- c : 1
- }
-
-And an update message:
-
- f {
- b {
- d : 10
- }
- }
-
-then if the field mask is:
-
- paths: "f.b"
-
-then the result will be:
-
- f {
- b {
- d : 10
- }
- c : 1
- }
-
-However, if the update mask was:
-
- paths: "f.b.d"
-
-then the result would be:
-
- f {
- b {
- d : 10
- x : 2
- }
- c : 1
- }
-
-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 duplicated or unmappable.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| paths | [string](#string) | repeated | The set of field mask paths. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Top
-
-## google/protobuf/source_context.proto
-
-
-
-
-
-### SourceContext
-`SourceContext` represents information about the source of a
-protobuf element, like the file in which it is defined.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| file_name | [string](#string) | | The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Top
-
-## google/protobuf/struct.proto
-
-
-
-
-
-### ListValue
-`ListValue` is a wrapper around a repeated field of values.
-
-The JSON representation for `ListValue` is JSON array.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| values | [Value](#google.protobuf.Value) | repeated | Repeated field of dynamically typed values. |
-
-
-
-
-
-
-
-
-### Struct
-`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.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| fields | [Struct.FieldsEntry](#google.protobuf.Struct.FieldsEntry) | repeated | Unordered map of dynamically typed values. |
-
-
-
-
-
-
-
-
-### Struct.FieldsEntry
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [Value](#google.protobuf.Value) | | |
-
-
-
-
-
-
-
-
-### 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 that
-variants, absence of any variant indicates an error.
-
-The JSON representation for `Value` is JSON value.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| null_value | [NullValue](#google.protobuf.NullValue) | | Represents a null value. |
-| number_value | [double](#double) | | Represents a double value. |
-| string_value | [string](#string) | | Represents a string value. |
-| bool_value | [bool](#bool) | | Represents a boolean value. |
-| struct_value | [Struct](#google.protobuf.Struct) | | Represents a structured value. |
-| list_value | [ListValue](#google.protobuf.ListValue) | | Represents a repeated `Value`. |
-
-
-
-
-
-
-
-
-
-
-### NullValue
-`NullValue` is a singleton enumeration to represent the null value for the
-`Value` type union.
-
- The JSON representation for `NullValue` is JSON `null`.
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| NULL_VALUE | 0 | Null value. |
-
-
-
-
-
-
-
-
-
-
-
-Top
-
-## google/protobuf/timestamp.proto
-
-
-
-
-
-### Timestamp
-A Timestamp represents a point in time independent of any time zone
-or calendar, represented as seconds and fractions of seconds at
-nanosecond resolution in UTC Epoch time. It is encoded using the
-Proleptic Gregorian Calendar which extends the Gregorian calendar
-backwards to year one. It is encoded assuming all minutes are 60
-seconds long, i.e. leap seconds are "smeared" so that no leap second
-table is needed for interpretation. 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.
-See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
-
-# 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 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://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
-) to obtain a formatter capable of generating timestamps in this format.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| seconds | [int64](#int64) | | 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. |
-| nanos | [int32](#int32) | | 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. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Top
-
-## google/protobuf/type.proto
-
-
-
-
-
-### Enum
-Enum type definition.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Enum type name. |
-| enumvalue | [EnumValue](#google.protobuf.EnumValue) | repeated | Enum value definitions. |
-| options | [Option](#google.protobuf.Option) | repeated | Protocol buffer options. |
-| source_context | [SourceContext](#google.protobuf.SourceContext) | | The source context. |
-| syntax | [Syntax](#google.protobuf.Syntax) | | The source syntax. |
-
-
-
-
-
-
-
-
-### EnumValue
-Enum value definition.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Enum value name. |
-| number | [int32](#int32) | | Enum value number. |
-| options | [Option](#google.protobuf.Option) | repeated | Protocol buffer options. |
-
-
-
-
-
-
-
-
-### Field
-A single field of a message type.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| kind | [Field.Kind](#google.protobuf.Field.Kind) | | The field type. |
-| cardinality | [Field.Cardinality](#google.protobuf.Field.Cardinality) | | The field cardinality. |
-| number | [int32](#int32) | | The field number. |
-| name | [string](#string) | | The field name. |
-| type_url | [string](#string) | | The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. |
-| oneof_index | [int32](#int32) | | 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. |
-| packed | [bool](#bool) | | Whether to use alternative packed wire representation. |
-| options | [Option](#google.protobuf.Option) | repeated | The protocol buffer options. |
-| json_name | [string](#string) | | The field JSON name. |
-| default_value | [string](#string) | | The string value of the default value of this field. Proto2 syntax only. |
-
-
-
-
-
-
-
-
-### Option
-A protocol buffer option, which can be attached to a message, field,
-enumeration, etc.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | 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"`. |
-| value | [Any](#google.protobuf.Any) | | 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. |
-
-
-
-
-
-
-
-
-### Type
-A protocol buffer message type.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The fully qualified message name. |
-| fields | [Field](#google.protobuf.Field) | repeated | The list of fields. |
-| oneofs | [string](#string) | repeated | The list of types appearing in `oneof` definitions in this type. |
-| options | [Option](#google.protobuf.Option) | repeated | The protocol buffer options. |
-| source_context | [SourceContext](#google.protobuf.SourceContext) | | The source context. |
-| syntax | [Syntax](#google.protobuf.Syntax) | | The source syntax. |
-
-
-
-
-
-
-
-
-
-
-### Field.Cardinality
-Whether a field is optional, required, or repeated.
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| CARDINALITY_UNKNOWN | 0 | For fields with unknown cardinality. |
-| CARDINALITY_OPTIONAL | 1 | For optional fields. |
-| CARDINALITY_REQUIRED | 2 | For required fields. Proto2 syntax only. |
-| CARDINALITY_REPEATED | 3 | For repeated fields. |
-
-
-
-
-
-### Field.Kind
-Basic field types.
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNKNOWN | 0 | Field type unknown. |
-| TYPE_DOUBLE | 1 | Field type double. |
-| TYPE_FLOAT | 2 | Field type float. |
-| TYPE_INT64 | 3 | Field type int64. |
-| TYPE_UINT64 | 4 | Field type uint64. |
-| TYPE_INT32 | 5 | Field type int32. |
-| TYPE_FIXED64 | 6 | Field type fixed64. |
-| TYPE_FIXED32 | 7 | Field type fixed32. |
-| TYPE_BOOL | 8 | Field type bool. |
-| TYPE_STRING | 9 | Field type string. |
-| TYPE_GROUP | 10 | Field type group. Proto2 syntax only, and deprecated. |
-| TYPE_MESSAGE | 11 | Field type message. |
-| TYPE_BYTES | 12 | Field type bytes. |
-| TYPE_UINT32 | 13 | Field type uint32. |
-| TYPE_ENUM | 14 | Field type enum. |
-| TYPE_SFIXED32 | 15 | Field type sfixed32. |
-| TYPE_SFIXED64 | 16 | Field type sfixed64. |
-| TYPE_SINT32 | 17 | Field type sint32. |
-| TYPE_SINT64 | 18 | Field type sint64. |
-
-
-
-
-
-### Syntax
-The syntax in which a protocol buffer element is defined.
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| SYNTAX_PROTO2 | 0 | Syntax `proto2`. |
-| SYNTAX_PROTO3 | 1 | Syntax `proto3`. |
-
-
-
-
-
-
-
-
-
-
-
-Top
-
-## google/protobuf/wrappers.proto
-
-
-
-
-
-### BoolValue
-Wrapper message for `bool`.
-
-The JSON representation for `BoolValue` is JSON `true` and `false`.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| value | [bool](#bool) | | The bool value. |
-
-
-
-
-
-
-
-
-### BytesValue
-Wrapper message for `bytes`.
-
-The JSON representation for `BytesValue` is JSON string.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| value | [bytes](#bytes) | | The bytes value. |
-
-
-
-
-
-
-
-
-### DoubleValue
-Wrapper message for `double`.
-
-The JSON representation for `DoubleValue` is JSON number.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| value | [double](#double) | | The double value. |
-
-
-
-
-
-
-
-
-### FloatValue
-Wrapper message for `float`.
-
-The JSON representation for `FloatValue` is JSON number.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| value | [float](#float) | | The float value. |
-
-
-
-
-
-
-
-
-### Int32Value
-Wrapper message for `int32`.
-
-The JSON representation for `Int32Value` is JSON number.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| value | [int32](#int32) | | The int32 value. |
-
-
-
-
-
-
-
-
-### Int64Value
-Wrapper message for `int64`.
-
-The JSON representation for `Int64Value` is JSON string.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| value | [int64](#int64) | | The int64 value. |
-
-
-
-
-
-
-
-
-### StringValue
-Wrapper message for `string`.
-
-The JSON representation for `StringValue` is JSON string.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| value | [string](#string) | | The string value. |
-
-
-
-
-
-
-
-
-### UInt32Value
-Wrapper message for `uint32`.
-
-The JSON representation for `UInt32Value` is JSON number.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| value | [uint32](#uint32) | | The uint32 value. |
-
-
-
-
-
-
-
-
-### UInt64Value
-Wrapper message for `uint64`.
-
-The JSON representation for `UInt64Value` is JSON string.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| value | [uint64](#uint64) | | The uint64 value. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Top
diff --git a/example-project/build.gradle b/example-project/build.gradle
index ed58aa2..31366ed 100644
--- a/example-project/build.gradle
+++ b/example-project/build.gradle
@@ -5,7 +5,7 @@ buildscript {
"grpc": '1.15.1',
"kotlin": '1.3.11',
"coroutines": '1.1.0',
- "krotoplus": '0.2.2-SNAPSHOT'
+ "krotoplus": '0.2.2-RC1'
]
}
diff --git a/protoc-gen-kroto-plus/docs/build.gradle b/protoc-gen-kroto-plus/docs/build.gradle
index 3458c60..e82ea76 100644
--- a/protoc-gen-kroto-plus/docs/build.gradle
+++ b/protoc-gen-kroto-plus/docs/build.gradle
@@ -3,15 +3,20 @@ apply plugin: 'com.google.protobuf'
def isGoLangPresent = hasGolang()
sourceSets{
- html { compileClasspath = configurations.compileOnly }
- markdown { compileClasspath = configurations.compileOnly }
+ def protoSrcs = "${project(":protoc-gen-kroto-plus").projectDir}/src/main/proto"
+
+ html {
+ proto{ srcDir protoSrcs }
+ compileClasspath = configurations.compileOnly
+ }
+ markdown {
+ proto{ srcDir protoSrcs }
+ compileClasspath = configurations.compileOnly
+ }
}
dependencies{
compileOnly "com.google.protobuf:protobuf-java:${versions.protobuf}"
-
- htmlProtobuf project(":protoc-gen-kroto-plus")
- markdownProtobuf project(":protoc-gen-kroto-plus")
}