Class: MessageOptions

Represents a MessageOptions.

Properties

.grpc.gateway.protoc_gen_openapiv2.options.openapiv2Schema?

optional .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Schema?: $Properties | null

MessageOptions .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Schema

---

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.

---

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.

---

features?

optional features?: $Properties | null

Any features defined in the specific edition.

---

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.

---

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.

---

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".

---

uninterpretedOption

uninterpretedOption: $Properties[]

The parser stores options it doesn't recognize here. See above.

Methods

toJSON()

toJSON(): object

Converts this MessageOptions to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): MessageOptions & $Shape

Creates a new MessageOptions instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

MessageOptions & $Shape

MessageOptions instance

Call Signature

static create(properties?): MessageOptions

Creates a new MessageOptions instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

MessageOptions

MessageOptions instance

---

decode()

static decode(reader, length?): MessageOptions & $Shape

Decodes a MessageOptions message from the specified reader or buffer.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?

number

Message length if known beforehand

Returns

MessageOptions & $Shape

MessageOptions

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): MessageOptions & $Shape

Decodes a MessageOptions message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

MessageOptions & $Shape

MessageOptions

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode()

static encode(message, writer?): Writer

Encodes the specified MessageOptions message. Does not implicitly google.protobuf.MessageOptions.verify|verify messages.

Parameters

message

$Properties

MessageOptions message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified MessageOptions message, length delimited. Does not implicitly google.protobuf.MessageOptions.verify|verify messages.

Parameters

message

$Properties

MessageOptions message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): MessageOptions

Creates a MessageOptions message from a plain object. Also converts values to their respective internal types.

Parameters

object

{[k: string]: any; }

Plain object

Returns

MessageOptions

MessageOptions

---

toObject()

static toObject(message, options?): object

Creates a plain object from a MessageOptions message. Also converts values to other types if specified.

Parameters

message

MessageOptions

MessageOptions

options?

IConversionOptions

Conversion options

Returns

object

Plain object