Optional
data: PartialMessage<FileDescriptorProto>Names of files imported by this file.
from field: repeated string dependency = 3;
Optional
editionThe edition of the proto file, which is an opaque string.
from field: optional string edition = 13;
from field: repeated google.protobuf.EnumDescriptorProto enum_type = 5;
from field: repeated google.protobuf.FieldDescriptorProto extension = 7;
All top-level definitions in this file.
from field: repeated google.protobuf.DescriptorProto message_type = 4;
Optional
namefile name, relative to root of source tree
from field: optional string name = 1;
Optional
optionsfrom field: optional google.protobuf.FileOptions options = 8;
Optional
packagee.g. "foo", "foo.bar", etc.
from field: optional string package = 2;
Indexes of the public imported files in the dependency list above.
from field: repeated int32 public_dependency = 10;
from field: repeated google.protobuf.ServiceDescriptorProto service = 6;
Optional
sourceThis 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.
from field: optional google.protobuf.SourceCodeInfo source_code_info = 9;
Optional
syntaxThe syntax of the proto file. The supported values are "proto2", "proto3", and "editions".
If edition
is present, this value must be "editions".
from field: optional string syntax = 12;
Indexes of the weak imported files in the dependency list. For Google-internal migration only. Do not use.
from field: repeated int32 weak_dependency = 11;
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
Describes a complete .proto file.
Generated
from message google.protobuf.FileDescriptorProto