Class EnumOptions (3.23.0) 

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()

public EnumOptions()

EnumOptions(EnumOptions)

public EnumOptions(EnumOptions other)
Parameter
Name Description
other EnumOptions

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

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(b/261750190) Remove this legacy behavior once downstream teams have had time to migrate.

Property Value
Type Description
bool

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

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; }
Property Value
Type Description
MessageParserEnumOptions

UninterpretedOption

public RepeatedField<UninterpretedOption> UninterpretedOption { get; }

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

Property Value
Type Description
RepeatedFieldUninterpretedOption

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

Parameter
Name Description
extension ExtensionEnumOptions
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

Parameter
Name Description
extension RepeatedExtensionEnumOptions
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)
Parameter
Name Description
other EnumOptions
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
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

Parameter
Name Description
extension ExtensionEnumOptions
Returns
Type Description
TValue
Type Parameter
Name Description
TValue

GetExtension<TValue>(RepeatedExtension<EnumOptions, TValue>)

public RepeatedField<TValue> GetExtension<TValue>(RepeatedExtension<EnumOptions, TValue> extension)

Gets the value of the specified repeated extension or null if the extension isn't registered in this set. For a version of this method that never returns null, use GetOrInitializeExtension<TValue>(RepeatedExtension<T, TValue>)

Parameter
Name Description
extension RepeatedExtensionEnumOptions
Returns
Type Description
RepeatedField
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.

Parameter
Name Description
extension RepeatedExtensionEnumOptions
Returns
Type Description
RepeatedField
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

Parameter
Name Description
extension ExtensionEnumOptions
Returns
Type Description
bool
Type Parameter
Name Description
TValue

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name Description
input CodedInputStream
Remarks

See the user guide for precise merge semantics.

MergeFrom(EnumOptions)

public void MergeFrom(EnumOptions other)

Merges the given message into this one.

Parameter
Name Description
other EnumOptions
Remarks

See the user guide for precise merge semantics.

SetExtension<TValue>(Extension<EnumOptions, TValue>, TValue)

public void SetExtension<TValue>(Extension<EnumOptions, TValue> extension, TValue value)

Sets the value of the specified extension

Parameters
Name Description
extension ExtensionEnumOptions
value TValue
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
output CodedOutputStream

Coded output stream to write the data to. Must not be null.

Extension Methods