Skip to main content

Interface: $Properties

Properties of an EnumValueOptions.

Extended by​

Properties​

debugRedact?​

optional debugRedact?: boolean | null

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?​

optional deprecated?: boolean | null

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?​

optional uninterpretedOption?: $Properties[] | null

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