Class: MessageOptions
google.protobuf.MessageOptions
Represents a MessageOptions.
Implements
Constructors
constructor
• new MessageOptions(properties?): MessageOptions
Constructs a new MessageOptions.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IMessageOptions | Properties to set |
Returns
Properties
deprecated
• deprecated: boolean
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.
Implementation of
deprecatedLegacyJsonFieldConflicts
• deprecatedLegacyJsonFieldConflicts: boolean
Enable 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.
This should only be used as a temporary measure against broken builds due to the change in behavior for JSON field name conflicts.
TODO This is legacy behavior we plan to remove once downstream teams have had time to migrate.
Implementation of
IMessageOptions.deprecatedLegacyJsonFieldConflicts
features
• Optional features: null | IFeatureSet
Any features defined in the specific edition.
Implementation of
mapEntry
• mapEntry: boolean
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.
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 implementations still need to work as if the field is a repeated message field.
Implementation of
messageSetWireFormat
• messageSetWireFormat: boolean
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.
Implementation of
IMessageOptions.messageSetWireFormat
noStandardDescriptorAccessor
• noStandardDescriptorAccessor: boolean
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".
Implementation of
IMessageOptions.noStandardDescriptorAccessor
uninterpretedOption
• uninterpretedOption: IUninterpretedOption[]
The parser stores options it doesn't recognize here. See above.
Implementation of
IMessageOptions.uninterpretedOption
Methods
toJSON
▸ toJSON(): Object
Converts this MessageOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): MessageOptions
Creates a new MessageOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IMessageOptions | Properties to set |
Returns
MessageOptions instance
decode
▸ decode(reader, length?): MessageOptions
Decodes a MessageOptions message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
MessageOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): MessageOptions
Decodes a MessageOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
MessageOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified MessageOptions message. Does not implicitly google.protobuf.MessageOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IMessageOptions | MessageOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified MessageOptions message, length delimited. Does not implicitly google.protobuf.MessageOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IMessageOptions | MessageOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): MessageOptions
Creates a MessageOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
MessageOptions
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for MessageOptions
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a MessageOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | MessageOptions | MessageOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object