Class EventDocField

Namespace

DatabentoDotNet.Reference

Assembly

DatabentoDotNet.Reference.dll

One field an event populates, and which of CorporateAction's three open maps it lands in.

public sealed record EventDocField : IEquatable<EventDocField>

Inheritance

object

EventDocField

Implements

IEquatable<EventDocField>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Port of upstream's EventDocField (corporate.rs:472-481). This is the type that makes corporate_actions.list_events worth shipping ahead of the endpoint it documents. CorporateAction carries event_info, date_info and rate_info as open maps whose keys vary by event (#55), and Group paired with Name is the server's own statement of which key may appear in which map.

The three groups are exactly the three maps, checked rather than assumed. Across the 349 field entries the live endpoint returned, Group took three distinct values — date_info, event_info and rate_info — and FieldGroup models those three and no others. A fourth would mean CorporateAction is missing a column, which is why the test asserting it belongs here rather than waiting for #55.

Properties

Description

What the field means.

public required string Description { get; init; }

Property Value

string

Group

Which of CorporateAction's three open maps the field arrives in.

public required FieldGroup Group { get; init; }

Property Value

FieldGroup

Name

The field's key within that map.

public required string Name { get; init; }

Property Value

string