Optional data: PartialMessage<CodeGeneratorRequest>Optional compilerThe version number of protocol compiler.
from field: optional google.protobuf.compiler.Version compiler_version = 3;
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.
from field: repeated string file_to_generate = 1;
Optional parameterThe generator parameter passed on the command-line.
from field: optional string parameter = 2;
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.
from field: repeated google.protobuf.FileDescriptorProto proto_file = 15;
Static Readonly fieldsStatic Readonly runtimeStatic Readonly typeCreate a deep copy.
Compare with a message of the same type.
Parse from binary data, merging fields.
Repeated fields are appended. Map entries are added, overwriting existing keys.
If a message field is already present, it will be merged with the new data.
Optional options: Partial<BinaryReadOptions>Parse a message from a JSON value.
Optional options: Partial<JsonReadOptions>Parse a message from a JSON string.
Optional options: Partial<JsonReadOptions>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.
Serialize the message to binary data.
Optional options: Partial<BinaryWriteOptions>Protected toJSONOverride for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).
Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.
This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.
Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().
Optional options: Partial<JsonWriteOptions>Serialize the message to a JSON string.
Optional options: Partial<JsonWriteStringOptions>Static equalsStatic fromOptional options: Partial<BinaryReadOptions>Static fromOptional options: Partial<JsonReadOptions>Static fromOptional options: Partial<JsonReadOptions>Generated using TypeDoc
An encoded CodeGeneratorRequest is written to the plugin's stdin.
Generated
from message google.protobuf.compiler.CodeGeneratorRequest