Send feedback
Class EnumOptions (3.27.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public sealed class EnumOptions : IExtendableMessage<EnumOptions>, IMessage<EnumOptions>, IEquatable<EnumOptions>, IDeepCloneable<EnumOptions>, IBufferMessage, IMessage
Inheritance
object >
EnumOptions
Namespace
Google.Protobuf.Reflection
Assembly
Google.Protobuf.dll
Constructors
EnumOptions()
EnumOptions(EnumOptions)
public EnumOptions(EnumOptions other)
Fields
AllowAliasFieldNumber
public const int AllowAliasFieldNumber = 2
Field number for the "allow_alias" field.
Field Value
Type Description
int
DeprecatedFieldNumber
public const int DeprecatedFieldNumber = 3
Field number for the "deprecated" field.
Field Value
Type Description
int
DeprecatedLegacyJsonFieldConflictsFieldNumber
public const int DeprecatedLegacyJsonFieldConflictsFieldNumber = 6
Field number for the "deprecated_legacy_json_field_conflicts" field.
Field Value
Type Description
int
FeaturesFieldNumber
public const int FeaturesFieldNumber = 7
Field number for the "features" field.
Field Value
Type Description
int
UninterpretedOptionFieldNumber
public const int UninterpretedOptionFieldNumber = 999
Field number for the "uninterpreted_option" field.
Field Value
Type Description
int
Properties
AllowAlias
public bool AllowAlias { get; set; }
Set this option to true to allow mapping different tag names to the same
value.
Property Value
Type Description
bool
Deprecated
public bool Deprecated { get; set; }
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.
Property Value
Type Description
bool
DeprecatedLegacyJsonFieldConflicts
[Obsolete]
public bool DeprecatedLegacyJsonFieldConflicts { get; set; }
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.
Property Value
Type Description
bool
Descriptor
public static MessageDescriptor Descriptor { get; }
Features
public FeatureSet Features { get; set; }
Any features defined in the specific edition.
HasAllowAlias
public bool HasAllowAlias { get; }
Gets whether the "allow_alias" field is set
Property Value
Type Description
bool
HasDeprecated
public bool HasDeprecated { get; }
Gets whether the "deprecated" field is set
Property Value
Type Description
bool
HasDeprecatedLegacyJsonFieldConflicts
[Obsolete]
public bool HasDeprecatedLegacyJsonFieldConflicts { get; }
Gets whether the "deprecated_legacy_json_field_conflicts" field is set
Property Value
Type Description
bool
Parser
public static MessageParser<EnumOptions> Parser { get; }
UninterpretedOption
public RepeatedField<UninterpretedOption> UninterpretedOption { get; }
The parser stores options it doesn't recognize here. See above.
Methods
CalculateSize()
public int CalculateSize()
Calculates the size of this message in Protocol Buffer wire format, in bytes.
Returns
Type Description
int The number of bytes required to write this message
to a coded output stream.
ClearAllowAlias()
public void ClearAllowAlias()
Clears the value of the "allow_alias" field
ClearDeprecated()
public void ClearDeprecated()
Clears the value of the "deprecated" field
ClearDeprecatedLegacyJsonFieldConflicts()
[Obsolete]
public void ClearDeprecatedLegacyJsonFieldConflicts()
Clears the value of the "deprecated_legacy_json_field_conflicts" field
ClearExtension<TValue>(Extension<EnumOptions, TValue>)
public void ClearExtension<TValue>(Extension<EnumOptions, TValue> extension)
Clears the value of the specified extension
Type Parameter
Name Description
TValue
ClearExtension<TValue>(RepeatedExtension<EnumOptions, TValue>)
public void ClearExtension<TValue>(RepeatedExtension<EnumOptions, TValue> extension)
Clears the value of the specified repeated extension
Type Parameter
Name Description
TValue
Clone()
public EnumOptions Clone()
Creates a deep clone of this object.
Returns
Type Description
EnumOptions A deep clone of this object.
Equals(EnumOptions)
public bool Equals(EnumOptions other)
Returns
Type Description
bool
Equals(object)
public override bool Equals(object other)
Parameter
Name Description
otherobject
Returns
Type Description
bool
Overrides
GetExtension<TValue>(Extension<EnumOptions, TValue>)
public TValue GetExtension<TValue>(Extension<EnumOptions, TValue> extension)
Gets the value of the specified extension
Returns
Type Description
TValue
Type Parameter
Name Description
TValue
GetExtension<TValue>(RepeatedExtension<EnumOptions, TValue>)
public RepeatedField<TValue> GetExtension<TValue>(RepeatedExtension<EnumOptions, TValue> extension)
Type Parameter
Name Description
TValue
GetHashCode()
public override int GetHashCode()
Returns
Type Description
int
Overrides
GetOrInitializeExtension<TValue>(RepeatedExtension<EnumOptions, TValue>)
public RepeatedField<TValue> GetOrInitializeExtension<TValue>(RepeatedExtension<EnumOptions, TValue> extension)
Gets the value of the specified repeated extension, registering it if it hasn't already been registered.
Type Parameter
Name Description
TValue
HasExtension<TValue>(Extension<EnumOptions, TValue>)
public bool HasExtension<TValue>(Extension<EnumOptions, TValue> extension)
Gets whether the value of the specified extension is set
Returns
Type Description
bool
Type Parameter
Name Description
TValue
public void MergeFrom(CodedInputStream input)
Merges the data from the specified coded input stream with the current message.
Remarks
MergeFrom(EnumOptions)
public void MergeFrom(EnumOptions other)
Merges the given message into this one.
Remarks
SetExtension<TValue>(Extension<EnumOptions, TValue>, TValue)
public void SetExtension<TValue>(Extension<EnumOptions, TValue> extension, TValue value)
Sets the value of the specified extension
Type Parameter
Name Description
TValue
ToString()
public override string ToString()
Returns
Type Description
string
Overrides
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Writes the data to the given coded output stream.
Parameter
Name Description
outputCodedOutputStream Coded output stream to write the data to. Must not be null.
Extension Methods
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["`EnumOptions` is a sealed class in the `Google.Protobuf.Reflection` namespace, providing configuration options for Protocol Buffer enums."],["This class implements multiple interfaces including `IExtendableMessage`, `IMessage`, `IEquatable`, `IDeepCloneable`, and `IBufferMessage`, enabling extensibility, message handling, equality checks, deep cloning, and buffered messaging."],["`EnumOptions` has fields such as `AllowAlias`, `Deprecated`, and `UninterpretedOption`, and the class provides properties to access and manipulate them, as well as manage the settings like features and legacy JSON handling."],["The class offers methods to manage extension values, merge data, calculate sizes, and handle input/output streams, with its primary functions aimed at defining and manipulating options for enum types."],["There are multiple versions available to download depending on your project requirements, with the latest being `3.27.1`."]]],[]]
