A list of instruments. More...

Inheritance diagram for Lusid.Sdk.Model.Instrument:

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

Public Member Functions
	Instrument (string href=default(string), string lusidInstrumentId=default(string), Version version=default(Version), 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), 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. The available values are: Active, Inactive More...

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

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

Version	Version `[get, set]`
	Gets or Sets Version 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...

List< Link >	Links `[get, set]`
	Collection of links. More...

Detailed Description

A list of instruments.

Member Enumeration Documentation

◆ 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. The available values are: Active, Inactive

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

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	lusidInstrumentId = `default(string)`,
		Version	version = `default(Version)`,
		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)`,
		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..
lusidInstrumentId	The unique LUSID Instrument Identifier (LUID) of the instrument. (required).
version	version (required).
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. The available values are: Active, Inactive (required).
links	Collection of links..

Member Function Documentation

◆ Equals() [1/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

◆ Equals() [2/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

◆ 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

◆ 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

Collection of 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.

◆ 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. The available values are: Active, Inactive

◆ Version

Version Lusid.Sdk.Model.Instrument.Version

getset

Gets or Sets Version

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

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

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ StateEnum

Constructor & Destructor Documentation

◆ Instrument() [1/2]

◆ Instrument() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Href

◆ Identifiers

◆ InstrumentDefinition

◆ Links

◆ LookthroughPortfolio

◆ LusidInstrumentId

◆ Name

◆ Properties

◆ State

◆ Version