Avro.Field Class Reference

Class for fields defined in a record More...

Public Types
enum	SortOrder {   SortOrder.ascending,   SortOrder.descending,   SortOrder.ignore }
	Enum for the sorting order of record fields More...

Public Member Functions
string	GetProperty (string key)
	Returns the field's custom property value given the property name More...
override bool	Equals (object obj)
	Compares two field objects More...
override int	GetHashCode ()
	Hash code function More...

Public Attributes
readonly string	Name
	Name of the field. More...
readonly IList< string >	aliases
	List of aliases for the field name More...

Protected Member Functions
internal void	writeJson (JsonTextWriter writer, SchemaNames names, string encspace)
	Writes the Field class in JSON format More...

Properties
int	Pos [get]
	Position of the field within its record. More...
string	Documentation [get]
	Documentation for the field, if any. More...
JToken	DefaultValue [get]
	The default value for the field stored as JSON object, if defined. More...
SortOrder?	Ordering [get]
	Order of the field More...
Schema	Schema [get]
	Field type's schema More...

Detailed Description

Class for fields defined in a record

Definition at line 30 of file Field.cs.

Member Enumeration Documentation

SortOrder

enum Avro.Field.SortOrder

strong

Enum for the sorting order of record fields

Enumerator
ascending
descending
ignore

Definition at line 35 of file Field.cs.

Member Function Documentation

Equals()

override bool Avro.Field.Equals ( object  obj )

inline

Compares two field objects

Parameters

obj	field to compare with this field

Returns

true if two fields are equal, false otherwise

Definition at line 200 of file Field.cs.

GetHashCode()

override int Avro.Field.GetHashCode ( )

inline

Hash code function

Returns

Definition at line 228 of file Field.cs.

GetProperty()

string Avro.Field.GetProperty ( string  key )

inline

Returns the field's custom property value given the property name

Parameters

key	custom property name

Returns

custom property value

Definition at line 188 of file Field.cs.

writeJson()

internal void Avro.Field.writeJson ( JsonTextWriter  writer, SchemaNames  names, string  encspace  )

inlineprotected

Writes the Field class in JSON format

Parameters

writer	JSON writer
names	list of named schemas already written
encspace	enclosing namespace for the field

Definition at line 126 of file Field.cs.

Member Data Documentation

aliases

readonly IList<string> Avro.Field.aliases

List of aliases for the field name

Definition at line 50 of file Field.cs.

Name

readonly string Avro.Field.Name

Name of the field.

Definition at line 45 of file Field.cs.

Property Documentation

DefaultValue

JToken Avro.Field.DefaultValue

get

The default value for the field stored as JSON object, if defined.

Otherwise, null.

Definition at line 65 of file Field.cs.

Documentation

string Avro.Field.Documentation

get

Documentation for the field, if any.

Null if there is no documentation.

Definition at line 60 of file Field.cs.

Ordering

SortOrder? Avro.Field.Ordering

get

Order of the field

Definition at line 70 of file Field.cs.

Pos

int Avro.Field.Pos

get

Position of the field within its record.

Definition at line 55 of file Field.cs.

Schema

Schema Avro.Field.Schema

get

Field type's schema

Definition at line 75 of file Field.cs.

---

The documentation for this class was generated from the following file:

• _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Avro/src/apache/main/Schema/Field.cs