Skip to main content

Class: EnumValueOptions

Represents an EnumValueOptions.

Properties​

debugRedact​

debugRedact: boolean

Indicate that fields annotated with this enum value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.

deprecated​

deprecated: boolean

Is this enum value deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum value, or it will be completely ignored; in the very least, this is a formalization for deprecating enum values.

features?​

optional features?: $Properties | null

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 EnumValueOptions to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): EnumValueOptions & $Properties

Creates a new EnumValueOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

EnumValueOptions & $Properties

EnumValueOptions instance

Call Signature​

static create(properties?): EnumValueOptions

Creates a new EnumValueOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

EnumValueOptions

EnumValueOptions instance

decode()​

static decode(reader, length?): EnumValueOptions & $Properties

Decodes an EnumValueOptions 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​

EnumValueOptions & $Properties

EnumValueOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): EnumValueOptions & $Properties

Decodes an EnumValueOptions message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

EnumValueOptions & $Properties

EnumValueOptions

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 EnumValueOptions message. Does not implicitly google.protobuf.EnumValueOptions.verify|verify messages.

Parameters​

message​

$Properties

EnumValueOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

EnumValueOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): EnumValueOptions

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

EnumValueOptions

EnumValueOptions

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

EnumValueOptions

EnumValueOptions

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object