A list of instruments. More...

Inheritance diagram for Lusid.Sdk.Model.Instrument:

Public Types
enum class	StateEnum { Active = 1 , Inactive = 2 , Deleted = 3 }
	The state of of the instrument at the asAt datetime of this version of the instrument definition. Available values: Active, Inactive, Deleted. More...

enum class	AssetClassEnum { InterestRates = 1 , FX = 2 , Inflation = 3 , Equities = 4 , Credit = 5 , Commodities = 6 , Money = 7 , Unknown = 8 }
	The nominal asset class of the instrument. Available values: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown. More...

Public Member Functions
	Instrument (string href=default(string), string scope=default(string), string lusidInstrumentId=default(string), ModelVersion varVersion=default(ModelVersion), StagedModificationsInfo stagedModifications=default(StagedModificationsInfo), string name=default(string), Dictionary< string, string > identifiers=default(Dictionary< string, string >), List< Property > properties=default(List< Property >), ResourceId lookthroughPortfolio=default(ResourceId), LusidInstrument instrumentDefinition=default(LusidInstrument), StateEnum state=default(StateEnum), AssetClassEnum ?assetClass=default(AssetClassEnum?), string domCcy=default(string), List< Relationship > relationships=default(List< Relationship >), SettlementCycle settlementCycle=default(SettlementCycle), DataModelMembership dataModelMembership=default(DataModelMembership), List< Link > links=default(List< Link >))
	Initializes a new instance of the Instrument 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 (Instrument input)
	Returns true if Instrument instances are equal More...

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

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

Properties
StateEnum	State `[get, set]`
	The state of of the instrument at the asAt datetime of this version of the instrument definition. Available values: Active, Inactive, Deleted. More...

AssetClassEnum?	AssetClass `[get, set]`
	The nominal asset class of the instrument. Available values: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown. More...

string	Href `[get, set]`
	The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. More...

string	Scope `[get, set]`
	The scope in which the instrument lies. More...

string	LusidInstrumentId `[get, set]`
	The unique LUSID Instrument Identifier (LUID) of the instrument. More...

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

StagedModificationsInfo	StagedModifications `[get, set]`
	Gets or Sets StagedModifications More...

string	Name `[get, set]`
	The name of the instrument. More...

Dictionary< string, string >	Identifiers `[get, set]`
	The set of identifiers that can be used to identify the instrument. More...

List< Property >	Properties `[get, set]`
	The requested instrument properties. These will be from the 'Instrument' domain. More...

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

LusidInstrument	InstrumentDefinition `[get, set]`
	Gets or Sets InstrumentDefinition More...

string	DomCcy `[get, set]`
	The domestic currency, meaning the currency in which the instrument would typically be expected to pay cashflows, e.g. a share in AAPL being USD. More...

List< Relationship >	Relationships `[get, set]`
	A set of relationships associated to the instrument. More...

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

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

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

Detailed Description

A list of instruments.

Member Enumeration Documentation

◆ AssetClassEnum

enum Lusid.Sdk.Model.Instrument.AssetClassEnum

strong

The nominal asset class of the instrument. Available values: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown.

Enumerator
InterestRates	Enum InterestRates for value: InterestRates
FX	Enum FX for value: FX
Inflation	Enum Inflation for value: Inflation
Equities	Enum Equities for value: Equities
Credit	Enum Credit for value: Credit
Commodities	Enum Commodities for value: Commodities
Money	Enum Money for value: Money
Unknown	Enum Unknown for value: Unknown

◆ StateEnum

enum Lusid.Sdk.Model.Instrument.StateEnum

strong

The state of of the instrument at the asAt datetime of this version of the instrument definition. Available values: Active, Inactive, Deleted.

Enumerator
Active	Enum Active for value: Active
Inactive	Enum Inactive for value: Inactive
Deleted	Enum Deleted for value: Deleted

Constructor & Destructor Documentation

◆ Instrument() [1/2]

Lusid.Sdk.Model.Instrument.Instrument ( )

inlineprotected

Initializes a new instance of the Instrument class.

◆ Instrument() [2/2]

Lusid.Sdk.Model.Instrument.Instrument	(	string	href = `default(string)`,
		string	scope = `default(string)`,
		string	lusidInstrumentId = `default(string)`,
		ModelVersion	varVersion = `default(ModelVersion)`,
		StagedModificationsInfo	stagedModifications = `default(StagedModificationsInfo)`,
		string	name = `default(string)`,
		Dictionary< string, string >	identifiers = `default(Dictionary<string, string>)`,
		List< Property >	properties = `default(List<Property>)`,
		ResourceId	lookthroughPortfolio = `default(ResourceId)`,
		LusidInstrument	instrumentDefinition = `default(LusidInstrument)`,
		StateEnum	state = `default(StateEnum)`,
		AssetClassEnum ?	assetClass = `default(AssetClassEnum?)`,
		string	domCcy = `default(string)`,
		List< Relationship >	relationships = `default(List<Relationship>)`,
		SettlementCycle	settlementCycle = `default(SettlementCycle)`,
		DataModelMembership	dataModelMembership = `default(DataModelMembership)`,
		List< Link >	links = `default(List<Link>)`
	)

inline

Initializes a new instance of the Instrument class.

Parameters

href	The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime..
scope	The scope in which the instrument lies..
lusidInstrumentId	The unique LUSID Instrument Identifier (LUID) of the instrument. (required).
varVersion	varVersion (required).
stagedModifications	stagedModifications.
name	The name of the instrument. (required).
identifiers	The set of identifiers that can be used to identify the instrument. (required).
properties	The requested instrument properties. These will be from the 'Instrument' domain..
lookthroughPortfolio	lookthroughPortfolio.
instrumentDefinition	instrumentDefinition.
state	The state of of the instrument at the asAt datetime of this version of the instrument definition. Available values: Active, Inactive, Deleted. (required).
assetClass	The nominal asset class of the instrument. Available values: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown..
domCcy	The domestic currency, meaning the currency in which the instrument would typically be expected to pay cashflows, e.g. a share in AAPL being USD..
relationships	A set of relationships associated to the instrument..
settlementCycle	settlementCycle.
dataModelMembership	dataModelMembership.
links	links.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if Instrument instances are equal

Parameters

input Instance of Instrument to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AssetClass

AssetClassEnum? Lusid.Sdk.Model.Instrument.AssetClass

getset

The nominal asset class of the instrument. Available values: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown.

◆ DataModelMembership

DataModelMembership Lusid.Sdk.Model.Instrument.DataModelMembership

getset

Gets or Sets DataModelMembership

◆ DomCcy

string Lusid.Sdk.Model.Instrument.DomCcy

getset

The domestic currency, meaning the currency in which the instrument would typically be expected to pay cashflows, e.g. a share in AAPL being USD.

◆ Href

string Lusid.Sdk.Model.Instrument.Href

getset

The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.

◆ Identifiers

Dictionary<string, string> Lusid.Sdk.Model.Instrument.Identifiers

getset

The set of identifiers that can be used to identify the instrument.

◆ InstrumentDefinition

LusidInstrument Lusid.Sdk.Model.Instrument.InstrumentDefinition

getset

Gets or Sets InstrumentDefinition

◆ Links

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

getset

Gets or Sets Links

◆ LookthroughPortfolio

ResourceId Lusid.Sdk.Model.Instrument.LookthroughPortfolio

getset

Gets or Sets LookthroughPortfolio

◆ LusidInstrumentId

string Lusid.Sdk.Model.Instrument.LusidInstrumentId

getset

The unique LUSID Instrument Identifier (LUID) of the instrument.

◆ Name

string Lusid.Sdk.Model.Instrument.Name

getset

The name of the instrument.

◆ Properties

List<Property> Lusid.Sdk.Model.Instrument.Properties

getset

The requested instrument properties. These will be from the 'Instrument' domain.

◆ Relationships

List<Relationship> Lusid.Sdk.Model.Instrument.Relationships

getset

A set of relationships associated to the instrument.

◆ Scope

string Lusid.Sdk.Model.Instrument.Scope

getset

The scope in which the instrument lies.

◆ SettlementCycle

SettlementCycle Lusid.Sdk.Model.Instrument.SettlementCycle

getset

Gets or Sets SettlementCycle

◆ StagedModifications

StagedModificationsInfo Lusid.Sdk.Model.Instrument.StagedModifications

getset

Gets or Sets StagedModifications

◆ State

StateEnum Lusid.Sdk.Model.Instrument.State

getset

The state of of the instrument at the asAt datetime of this version of the instrument definition. Available values: Active, Inactive, Deleted.

◆ VarVersion

ModelVersion Lusid.Sdk.Model.Instrument.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/Instrument.cs

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ AssetClassEnum

◆ StateEnum

Constructor & Destructor Documentation

◆ Instrument() [1/2]

◆ Instrument() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AssetClass

◆ DataModelMembership

◆ DomCcy

◆ Href

◆ Identifiers

◆ InstrumentDefinition

◆ Links

◆ LookthroughPortfolio

◆ LusidInstrumentId

◆ Name

◆ Properties

◆ Relationships

◆ Scope

◆ SettlementCycle

◆ StagedModifications

◆ State

◆ VarVersion