Optional
data: PartialMessage<EnumOptions>Optional
allowSet this option to true to allow mapping different tag names to the same value.
from field: optional bool allow_alias = 2;
Optional
deprecatedIs 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.
from field: optional bool deprecated = 3 [default = false];
Optional
deprecatedEnable the legacy handling of JSON field name conflicts. This lowercases
and strips underscored from the fields before comparison in proto3 only.
The new behavior takes json_name
into account and applies to proto2 as
well.
TODO(b/261750190) Remove this legacy behavior once downstream teams have
had time to migrate.
from field: optional bool deprecated_legacy_json_field_conflicts = 6 [deprecated = true];
The parser stores options it doesn't recognize here. See above.
from field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
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
Generated
from message google.protobuf.EnumOptions