Class FieldDescriptorProto (3.23.0) 

public sealed class FieldDescriptorProto : IMessage<FieldDescriptorProto>, IEquatable<FieldDescriptorProto>, IDeepCloneable<FieldDescriptorProto>, IBufferMessage, IMessage

Describes a field within a message.

Inheritance

object > FieldDescriptorProto

Namespace

Google.Protobuf.Reflection

Assembly

Google.Protobuf.dll

Constructors

FieldDescriptorProto()

public FieldDescriptorProto()

FieldDescriptorProto(FieldDescriptorProto)

public FieldDescriptorProto(FieldDescriptorProto other)
Parameter
Name Description
other FieldDescriptorProto

Fields

DefaultValueFieldNumber

public const int DefaultValueFieldNumber = 7

Field number for the "default_value" field.

Field Value
Type Description
int

ExtendeeFieldNumber

public const int ExtendeeFieldNumber = 2

Field number for the "extendee" field.

Field Value
Type Description
int

JsonNameFieldNumber

public const int JsonNameFieldNumber = 10

Field number for the "json_name" field.

Field Value
Type Description
int

LabelFieldNumber

public const int LabelFieldNumber = 4

Field number for the "label" field.

Field Value
Type Description
int

NameFieldNumber

public const int NameFieldNumber = 1

Field number for the "name" field.

Field Value
Type Description
int

NumberFieldNumber

public const int NumberFieldNumber = 3

Field number for the "number" field.

Field Value
Type Description
int

OneofIndexFieldNumber

public const int OneofIndexFieldNumber = 9

Field number for the "oneof_index" field.

Field Value
Type Description
int

OptionsFieldNumber

public const int OptionsFieldNumber = 8

Field number for the "options" field.

Field Value
Type Description
int

Proto3OptionalFieldNumber

public const int Proto3OptionalFieldNumber = 17

Field number for the "proto3_optional" field.

Field Value
Type Description
int

TypeFieldNumber

public const int TypeFieldNumber = 5

Field number for the "type" field.

Field Value
Type Description
int

TypeNameFieldNumber

public const int TypeNameFieldNumber = 6

Field number for the "type_name" field.

Field Value
Type Description
int

Properties

DefaultValue

public string DefaultValue { get; set; }

For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.

Property Value
Type Description
string

Descriptor

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

Extendee

public string Extendee { get; set; }

For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.

Property Value
Type Description
string

HasDefaultValue

public bool HasDefaultValue { get; }

Gets whether the "default_value" field is set

Property Value
Type Description
bool

HasExtendee

public bool HasExtendee { get; }

Gets whether the "extendee" field is set

Property Value
Type Description
bool

HasJsonName

public bool HasJsonName { get; }

Gets whether the "json_name" field is set

Property Value
Type Description
bool

HasLabel

public bool HasLabel { get; }

Gets whether the "label" field is set

Property Value
Type Description
bool

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type Description
bool

HasNumber

public bool HasNumber { get; }

Gets whether the "number" field is set

Property Value
Type Description
bool

HasOneofIndex

public bool HasOneofIndex { get; }

Gets whether the "oneof_index" field is set

Property Value
Type Description
bool

HasProto3Optional

public bool HasProto3Optional { get; }

Gets whether the "proto3_optional" field is set

Property Value
Type Description
bool

HasType

public bool HasType { get; }

Gets whether the "type" field is set

Property Value
Type Description
bool

HasTypeName

public bool HasTypeName { get; }

Gets whether the "type_name" field is set

Property Value
Type Description
bool

JsonName

public string JsonName { get; set; }

JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.

Property Value
Type Description
string

Label

public FieldDescriptorProto.Types.Label Label { get; set; }
Property Value
Type Description
FieldDescriptorProtoTypesLabel

Name

public string Name { get; set; }
Property Value
Type Description
string

Number

public int Number { get; set; }
Property Value
Type Description
int

OneofIndex

public int OneofIndex { get; set; }

If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.

Property Value
Type Description
int

Options

public FieldOptions Options { get; set; }
Property Value
Type Description
FieldOptions

Parser

public static MessageParser<FieldDescriptorProto> Parser { get; }
Property Value
Type Description
MessageParserFieldDescriptorProto

Proto3Optional

public bool Proto3Optional { get; set; }

If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type.

When proto3_optional is true, this field must be belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs.

For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof.

Proto2 optional fields do not set this flag, because they already indicate optional with LABEL_OPTIONAL.

Property Value
Type Description
bool

Type

public FieldDescriptorProto.Types.Type Type { get; set; }

If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.

Property Value
Type Description
FieldDescriptorProtoTypesType

TypeName

public string TypeName { get; set; }

For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).

Property Value
Type Description
string

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.

ClearDefaultValue()

public void ClearDefaultValue()

Clears the value of the "default_value" field

ClearExtendee()

public void ClearExtendee()

Clears the value of the "extendee" field

ClearJsonName()

public void ClearJsonName()

Clears the value of the "json_name" field

ClearLabel()

public void ClearLabel()

Clears the value of the "label" field

ClearName()

public void ClearName()

Clears the value of the "name" field

ClearNumber()

public void ClearNumber()

Clears the value of the "number" field

ClearOneofIndex()

public void ClearOneofIndex()

Clears the value of the "oneof_index" field

ClearProto3Optional()

public void ClearProto3Optional()

Clears the value of the "proto3_optional" field

ClearType()

public void ClearType()

Clears the value of the "type" field

ClearTypeName()

public void ClearTypeName()

Clears the value of the "type_name" field

Clone()

public FieldDescriptorProto Clone()

Creates a deep clone of this object.

Returns
Type Description
FieldDescriptorProto

A deep clone of this object.

Equals(FieldDescriptorProto)

public bool Equals(FieldDescriptorProto other)
Parameter
Name Description
other FieldDescriptorProto
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

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

public void MergeFrom(FieldDescriptorProto other)

Merges the given message into this one.

Parameter
Name Description
other FieldDescriptorProto
Remarks

See the user guide for precise merge semantics.

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