An instrument event equipped with additional metadata. More...

Inheritance diagram for Lusid.Sdk.Model.InstrumentEventHolder:

Public Member Functions
	InstrumentEventHolder (string instrumentEventId=default(string), ResourceId corporateActionSourceId=default(ResourceId), Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), string lusidInstrumentId=default(string), string instrumentScope=default(string), string description=default(string), EventDateRange eventDateRange=default(EventDateRange), InstrumentEvent instrumentEvent=default(InstrumentEvent), List< PerpetualProperty > properties=default(List< PerpetualProperty >), int sequenceNumber=default(int), string participationType=@"Mandatory", string groupCode=default(string))
	Initializes a new instance of the InstrumentEventHolder class. More...

bool	ShouldSerializeCompleteness ()
	Returns false as Completeness should not be serialized given that it's read-only. More...

bool	ShouldSerializeAsAt ()
	Returns false as AsAt should not be serialized given that it's read-only. More...

override string	ToString ()
	Returns the string presentation of the object More...

virtual string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object input)
	Returns true if objects are equal More...

bool	Equals (InstrumentEventHolder input)
	Returns true if InstrumentEventHolder instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	InstrumentEventHolder ()
	Initializes a new instance of the InstrumentEventHolder class. More...

Properties
string	InstrumentEventId Mandatory" `[get, set]`
	The unique identifier of this corporate action. More...

ResourceId	CorporateActionSourceId `[get, set]`
	Gets or Sets CorporateActionSourceId More...

Dictionary< string, string >	InstrumentIdentifiers `[get, set]`
	The set of identifiers which determine the instrument this event relates to. More...

string	LusidInstrumentId `[get, set]`
	The LUID for the instrument. More...

string	InstrumentScope `[get, set]`
	The scope of the instrument. More...

string	Description `[get, set]`
	The description of the instrument event. More...

EventDateRange	EventDateRange `[get, set]`
	Gets or Sets EventDateRange More...

string	Completeness `[get]`
	Is the event Economically Complete, or is it missing some DataDependent fields (Incomplete). Available values: Complete, Incomplete. More...

InstrumentEvent	InstrumentEvent `[get, set]`
	Gets or Sets InstrumentEvent More...

List< PerpetualProperty >	Properties `[get, set]`
	The properties attached to this instrument event. More...

int	SequenceNumber `[get, set]`
	The order of the instrument event relative others on the same date (0 being processed first). Must be non negative. More...

string	ParticipationType `[get, set]`
	Indicates the type of participation in this event. Default value: Mandatory. Available values: Mandatory, MandatoryWithChoices, Voluntary. More...

DateTimeOffset?	AsAt `[get]`
	The AsAt time of the instrument event, if available. This is a readonly field and should not be provided on upsert. More...

string	GroupCode `[get, set]`
	The group code that determines the processing order of instrument events with the same effective datetime. Available values: Tier1, Tier2, Tier3, Legacy. More...

Detailed Description

An instrument event equipped with additional metadata.

Constructor & Destructor Documentation

◆ InstrumentEventHolder() [1/2]

Lusid.Sdk.Model.InstrumentEventHolder.InstrumentEventHolder ( )

inlineprotected

Initializes a new instance of the InstrumentEventHolder class.

◆ InstrumentEventHolder() [2/2]

Lusid.Sdk.Model.InstrumentEventHolder.InstrumentEventHolder	(	string	instrumentEventId = `default(string)`,
		ResourceId	corporateActionSourceId = `default(ResourceId)`,
		Dictionary< string, string >	instrumentIdentifiers = `default(Dictionary<string, string>)`,
		string	lusidInstrumentId = `default(string)`,
		string	instrumentScope = `default(string)`,
		string	description = `default(string)`,
		EventDateRange	eventDateRange = `default(EventDateRange)`,
		InstrumentEvent	instrumentEvent = `default(InstrumentEvent)`,
		List< PerpetualProperty >	properties = `default(List<PerpetualProperty>)`,
		int	sequenceNumber = `default(int)`,
		string	participationType = `@"Mandatory"`,
		string	groupCode = `default(string)`
	)

inline

Initializes a new instance of the InstrumentEventHolder class.

Parameters

instrumentEventId	The unique identifier of this corporate action. (required).
corporateActionSourceId	corporateActionSourceId.
instrumentIdentifiers	The set of identifiers which determine the instrument this event relates to. (required).
lusidInstrumentId	The LUID for the instrument. (required).
instrumentScope	The scope of the instrument. (required).
description	The description of the instrument event. (required).
eventDateRange	eventDateRange (required).
instrumentEvent	instrumentEvent (required).
properties	The properties attached to this instrument event..
sequenceNumber	The order of the instrument event relative others on the same date (0 being processed first). Must be non negative..
participationType	Indicates the type of participation in this event. Default value: Mandatory. Available values: Mandatory, MandatoryWithChoices, Voluntary. (default to "Mandatory").
groupCode	The group code that determines the processing order of instrument events with the same effective datetime. Available values: Tier1, Tier2, Tier3, Legacy..

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.InstrumentEventHolder.Equals ( InstrumentEventHolder input )

inline

Returns true if InstrumentEventHolder instances are equal

Parameters

input Instance of InstrumentEventHolder to be compared

Returns: Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.InstrumentEventHolder.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.InstrumentEventHolder.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ShouldSerializeAsAt()

bool Lusid.Sdk.Model.InstrumentEventHolder.ShouldSerializeAsAt ( )

inline

Returns false as AsAt should not be serialized given that it's read-only.

Returns: false (boolean)

◆ ShouldSerializeCompleteness()

bool Lusid.Sdk.Model.InstrumentEventHolder.ShouldSerializeCompleteness ( )

inline

Returns false as Completeness should not be serialized given that it's read-only.

Returns: false (boolean)

◆ ToJson()

virtual string Lusid.Sdk.Model.InstrumentEventHolder.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.InstrumentEventHolder.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AsAt

DateTimeOffset? Lusid.Sdk.Model.InstrumentEventHolder.AsAt

get

The AsAt time of the instrument event, if available. This is a readonly field and should not be provided on upsert.

◆ Completeness

string Lusid.Sdk.Model.InstrumentEventHolder.Completeness

get

Is the event Economically Complete, or is it missing some DataDependent fields (Incomplete). Available values: Complete, Incomplete.

◆ CorporateActionSourceId

ResourceId Lusid.Sdk.Model.InstrumentEventHolder.CorporateActionSourceId

getset

Gets or Sets CorporateActionSourceId

◆ Description

string Lusid.Sdk.Model.InstrumentEventHolder.Description

getset

The description of the instrument event.

◆ EventDateRange

EventDateRange Lusid.Sdk.Model.InstrumentEventHolder.EventDateRange

getset

Gets or Sets EventDateRange

◆ GroupCode

string Lusid.Sdk.Model.InstrumentEventHolder.GroupCode

getset

The group code that determines the processing order of instrument events with the same effective datetime. Available values: Tier1, Tier2, Tier3, Legacy.

◆ InstrumentEvent

InstrumentEvent Lusid.Sdk.Model.InstrumentEventHolder.InstrumentEvent

getset

Gets or Sets InstrumentEvent

◆ InstrumentEventId

string Lusid.Sdk.Model.InstrumentEventHolder.InstrumentEventId Mandatory"

getset

The unique identifier of this corporate action.

◆ InstrumentIdentifiers

Dictionary<string, string> Lusid.Sdk.Model.InstrumentEventHolder.InstrumentIdentifiers

getset

The set of identifiers which determine the instrument this event relates to.

◆ InstrumentScope

string Lusid.Sdk.Model.InstrumentEventHolder.InstrumentScope

getset

The scope of the instrument.

◆ LusidInstrumentId

string Lusid.Sdk.Model.InstrumentEventHolder.LusidInstrumentId

getset

The LUID for the instrument.

◆ ParticipationType

string Lusid.Sdk.Model.InstrumentEventHolder.ParticipationType

getset

Indicates the type of participation in this event. Default value: Mandatory. Available values: Mandatory, MandatoryWithChoices, Voluntary.

◆ Properties

List<PerpetualProperty> Lusid.Sdk.Model.InstrumentEventHolder.Properties

getset

The properties attached to this instrument event.

◆ SequenceNumber

int Lusid.Sdk.Model.InstrumentEventHolder.SequenceNumber

getset

The order of the instrument event relative others on the same date (0 being processed first). Must be non negative.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/InstrumentEventHolder.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ InstrumentEventHolder() [1/2]

◆ InstrumentEventHolder() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ShouldSerializeAsAt()

◆ ShouldSerializeCompleteness()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AsAt

◆ Completeness

◆ CorporateActionSourceId

◆ Description

◆ EventDateRange

◆ GroupCode

◆ InstrumentEvent

◆ InstrumentEventId

◆ InstrumentIdentifiers

◆ InstrumentScope

◆ LusidInstrumentId

◆ ParticipationType

◆ Properties

◆ SequenceNumber