Optional data: PartialMessage<FieldDescriptorProto>Optional defaultFor 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.
from field: optional string default_value = 7;
Optional extendeeFor extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
from field: optional string extendee = 2;
Optional jsonJSON 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.
from field: optional string json_name = 10;
Optional labelfrom field: optional google.protobuf.FieldDescriptorProto.Label label = 4;
Optional namefrom field: optional string name = 1;
Optional numberfrom field: optional int32 number = 3;
Optional oneofIf set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
from field: optional int32 oneof_index = 9;
Optional optionsfrom field: optional google.protobuf.FieldOptions options = 8;
Optional proto3If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type.
When proto3_optional is true, this field must be belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs.
For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof.
Proto2 optional fields do not set this flag, because they already indicate
optional with LABEL_OPTIONAL.
from field: optional bool proto3_optional = 17;
Optional typeIf 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.
from field: optional google.protobuf.FieldDescriptorProto.Type type = 5;
Optional typeFor 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).
from field: optional string type_name = 6;
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 field within a message.
Generated
from message google.protobuf.FieldDescriptorProto