An instruction for an instrument event More...

Inheritance diagram for Lusid.Sdk.Model.InstrumentEventInstruction:

Public Member Functions
	InstrumentEventInstruction (string instrumentEventInstructionId=default(string), ResourceId portfolioId=default(ResourceId), string instrumentEventId=default(string), string instructionType=default(string), string electionKey=default(string), long? holdingId=default(long?), ModelVersion varVersion=default(ModelVersion), string href=default(string), DateTimeOffset? entitlementDateInstructed=default(DateTimeOffset?), QuantityInstructed quantityInstructed=default(QuantityInstructed), string taxLotId=default(string), bool ignoreCostImpact=default(bool), List< Link > links=default(List< Link >))
	Initializes a new instance of the InstrumentEventInstruction class. 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 (InstrumentEventInstruction input)
	Returns true if InstrumentEventInstruction instances are equal More...

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

Properties
string	InstrumentEventInstructionId `[get, set]`
	The unique identifier for this instruction More...

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

string	InstrumentEventId `[get, set]`
	The identifier of the instrument event being instructed More...

string	InstructionType `[get, set]`
	The type of instruction (Ignore, ElectForPortfolio, ElectForHolding, ElectForLoanFacilityHolding) More...

string	ElectionKey `[get, set]`
	For elected instructions, the key to be chosen More...

long?	HoldingId `[get, set]`
	For holding instructions, the id of the holding for which the instruction will apply More...

ModelVersion	VarVersion `[get, set]`
	Gets or Sets VarVersion More...

string	Href `[get, set]`
	The uri for this version of this instruction More...

DateTimeOffset?	EntitlementDateInstructed `[get, set]`
	The instructed entitlement date for the event (where none is set on the event itself) More...

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

string	TaxLotId `[get, set]`
	For loan facility holding instructions, the tax lot id of the holding for which the instruction will apply More...

bool	IgnoreCostImpact `[get, set]`
	For loan facility holding instructions, set this flag to 'true' if you want the event to not impact cost. If you want to use this option, do not add multiple instructions to the same tax lot or you will get undefined behaviour. More...

List< Link >	Links `[get, set]`
	Gets or Sets Links More...

Detailed Description

An instruction for an instrument event

Constructor & Destructor Documentation

◆ InstrumentEventInstruction()

Lusid.Sdk.Model.InstrumentEventInstruction.InstrumentEventInstruction	(	string	instrumentEventInstructionId = `default(string)`,
		ResourceId	portfolioId = `default(ResourceId)`,
		string	instrumentEventId = `default(string)`,
		string	instructionType = `default(string)`,
		string	electionKey = `default(string)`,
		long?	holdingId = `default(long?)`,
		ModelVersion	varVersion = `default(ModelVersion)`,
		string	href = `default(string)`,
		DateTimeOffset?	entitlementDateInstructed = `default(DateTimeOffset?)`,
		QuantityInstructed	quantityInstructed = `default(QuantityInstructed)`,
		string	taxLotId = `default(string)`,
		bool	ignoreCostImpact = `default(bool)`,
		List< Link >	links = `default(List<Link>)`
	)

inline

Initializes a new instance of the InstrumentEventInstruction class.

Parameters

instrumentEventInstructionId	The unique identifier for this instruction.
portfolioId	portfolioId.
instrumentEventId	The identifier of the instrument event being instructed.
instructionType	The type of instruction (Ignore, ElectForPortfolio, ElectForHolding, ElectForLoanFacilityHolding).
electionKey	For elected instructions, the key to be chosen.
holdingId	For holding instructions, the id of the holding for which the instruction will apply.
varVersion	varVersion.
href	The uri for this version of this instruction.
entitlementDateInstructed	The instructed entitlement date for the event (where none is set on the event itself).
quantityInstructed	quantityInstructed.
taxLotId	For loan facility holding instructions, the tax lot id of the holding for which the instruction will apply.
ignoreCostImpact	For loan facility holding instructions, set this flag to 'true' if you want the event to not impact cost. If you want to use this option, do not add multiple instructions to the same tax lot or you will get undefined behaviour..
links	links.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if InstrumentEventInstruction instances are equal

Parameters

input Instance of InstrumentEventInstruction to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ ElectionKey

string Lusid.Sdk.Model.InstrumentEventInstruction.ElectionKey

getset

For elected instructions, the key to be chosen

◆ EntitlementDateInstructed

DateTimeOffset? Lusid.Sdk.Model.InstrumentEventInstruction.EntitlementDateInstructed

getset

The instructed entitlement date for the event (where none is set on the event itself)

◆ HoldingId

long? Lusid.Sdk.Model.InstrumentEventInstruction.HoldingId

getset

For holding instructions, the id of the holding for which the instruction will apply

◆ Href

string Lusid.Sdk.Model.InstrumentEventInstruction.Href

getset

The uri for this version of this instruction

◆ IgnoreCostImpact

bool Lusid.Sdk.Model.InstrumentEventInstruction.IgnoreCostImpact

getset

For loan facility holding instructions, set this flag to 'true' if you want the event to not impact cost. If you want to use this option, do not add multiple instructions to the same tax lot or you will get undefined behaviour.

◆ InstructionType

string Lusid.Sdk.Model.InstrumentEventInstruction.InstructionType

getset

The type of instruction (Ignore, ElectForPortfolio, ElectForHolding, ElectForLoanFacilityHolding)

◆ InstrumentEventId

string Lusid.Sdk.Model.InstrumentEventInstruction.InstrumentEventId

getset

The identifier of the instrument event being instructed

◆ InstrumentEventInstructionId

string Lusid.Sdk.Model.InstrumentEventInstruction.InstrumentEventInstructionId

getset

The unique identifier for this instruction

◆ Links

List<Link> Lusid.Sdk.Model.InstrumentEventInstruction.Links

getset

Gets or Sets Links

◆ PortfolioId

ResourceId Lusid.Sdk.Model.InstrumentEventInstruction.PortfolioId

getset

Gets or Sets PortfolioId

◆ QuantityInstructed

QuantityInstructed Lusid.Sdk.Model.InstrumentEventInstruction.QuantityInstructed

getset

Gets or Sets QuantityInstructed

◆ TaxLotId

string Lusid.Sdk.Model.InstrumentEventInstruction.TaxLotId

getset

For loan facility holding instructions, the tax lot id of the holding for which the instruction will apply

◆ VarVersion

ModelVersion Lusid.Sdk.Model.InstrumentEventInstruction.VarVersion

getset

Gets or Sets VarVersion

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/InstrumentEventInstruction.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ InstrumentEventInstruction()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ ElectionKey

◆ EntitlementDateInstructed

◆ HoldingId

◆ Href

◆ IgnoreCostImpact

◆ InstructionType

◆ InstrumentEventId

◆ InstrumentEventInstructionId

◆ Links

◆ PortfolioId

◆ QuantityInstructed

◆ TaxLotId

◆ VarVersion