Class: EnumOptions
Represents an EnumOptions.
Properties
.grpc.gateway.protoc_gen_openapiv2.options.openapiv2Enum
• Optional .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Enum: null | $Properties
EnumOptions .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Enum
allowAlias
• allowAlias: boolean
Set this option to true to allow mapping different tag names to the same value.
deprecated
• deprecated: boolean
Is 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.
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.
TODO Remove this legacy behavior once downstream teams have
had time to migrate.
features
• Optional features: null | $Properties
Any features defined in the specific edition.
uninterpretedOption
• uninterpretedOption: $Properties[]
The parser stores options it doesn't recognize here. See above.
Methods
toJSON
▸ toJSON(): Object
Converts this EnumOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): EnumOptions & $Shape
Creates a new EnumOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
EnumOptions instance
▸ create(properties?): EnumOptions
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): EnumOptions & $Shape
Decodes an EnumOptions 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
EnumOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): EnumOptions & $Shape
Decodes an EnumOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
EnumOptions
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 EnumOptions message. Does not implicitly google.protobuf.EnumOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | EnumOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified EnumOptions message, length delimited. Does not implicitly google.protobuf.EnumOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | EnumOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): EnumOptions
Creates an EnumOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
EnumOptions
toObject
▸ toObject(message, options?): Object
Creates a plain object from an EnumOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | EnumOptions | EnumOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object