LUSID representation of a reference to another instrument that has already been upserted (Mastered) More...

Inheritance diagram for Lusid.Sdk.Model.MasteredInstrument:

[legend]

Public Member Functions
	MasteredInstrument (Dictionary< string, string > identifiers=default(Dictionary< string, string >), InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
	Initializes a new instance of the MasteredInstrument class. More...

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

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

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

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

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

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

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

override 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 (MasteredInstrument input)
	Returns true if MasteredInstrument instances are equal More...

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

Public Member Functions inherited from Lusid.Sdk.Model.LusidInstrument
	LusidInstrument (InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
	Initializes a new instance of the LusidInstrument class. More...

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

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

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

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

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

IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult >	BaseValidate (ValidationContext validationContext)
	To validate all properties of the instance More...

Protected Member Functions inherited from Lusid.Sdk.Model.LusidInstrument
	LusidInstrument ()
	Initializes a new instance of the LusidInstrument class. More...

IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult >	BaseValidate (ValidationContext validationContext)
	To validate all properties of the instance More...

Properties
Dictionary< string, string >	Identifiers `[get, set]`
	Dictionary of identifiers of the mastered instrument More...

string	MasteredDomCcy `[get]`
	DomCcy of the Instrument that Mastered Instrument points to - read only field More...

string	MasteredInstrumentType `[get]`
	Type of the Instrument that Mastered Instrument points to - read only field More...

string	MasteredLusidInstrumentId `[get]`
	Luid of the Instrument that Mastered Instrument points to - read only field More...

string	MasteredName `[get]`
	Name of the Instrument that Mastered Instrument points to - read only field More...

string	MasteredScope `[get]`
	Scope of the Instrument that Mastered Instrument points to - read only field More...

string	MasteredAssetClass `[get]`
	Asset class of the underlying mastered instrument - read only field Supported string (enumeration) values are: [InterestRates, FX, Inflation, Equities, Credit, Commodities, Money]. Defaults to "Unknown" if not set. More...

Properties inherited from Lusid.Sdk.Model.LusidInstrument
InstrumentTypeEnum	InstrumentType `[get, set]`
	Available values: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility, FlexibleDeposit, FlexibleRepo. More...

Additional Inherited Members
Public Types inherited from Lusid.Sdk.Model.LusidInstrument
enum class	InstrumentTypeEnum { QuotedSecurity = 1 , InterestRateSwap = 2 , FxForward = 3 , Future = 4 , ExoticInstrument = 5 , FxOption = 6 , CreditDefaultSwap = 7 , InterestRateSwaption = 8 , Bond = 9 , EquityOption = 10 , FixedLeg = 11 , FloatingLeg = 12 , BespokeCashFlowsLeg = 13 , Unknown = 14 , TermDeposit = 15 , ContractForDifference = 16 , EquitySwap = 17 , CashPerpetual = 18 , CapFloor = 19 , CashSettled = 20 , CdsIndex = 21 , Basket = 22 , FundingLeg = 23 , FxSwap = 24 , ForwardRateAgreement = 25 , SimpleInstrument = 26 , Repo = 27 , Equity = 28 , ExchangeTradedOption = 29 , ReferenceInstrument = 30 , ComplexBond = 31 , InflationLinkedBond = 32 , InflationSwap = 33 , SimpleCashFlowLoan = 34 , TotalReturnSwap = 35 , InflationLeg = 36 , FundShareClass = 37 , FlexibleLoan = 38 , UnsettledCash = 39 , Cash = 40 , MasteredInstrument = 41 , LoanFacility = 42 , FlexibleDeposit = 43 , FlexibleRepo = 44 }
	Available values: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility, FlexibleDeposit, FlexibleRepo. More...

Detailed Description

LUSID representation of a reference to another instrument that has already been upserted (Mastered)

Constructor & Destructor Documentation

◆ MasteredInstrument() [1/2]

Lusid.Sdk.Model.MasteredInstrument.MasteredInstrument ( )

inlineprotected

Initializes a new instance of the MasteredInstrument class.

◆ MasteredInstrument() [2/2]

Lusid.Sdk.Model.MasteredInstrument.MasteredInstrument	(	Dictionary< string, string >	identifiers = `default(Dictionary<string, string>)`,
		InstrumentTypeEnum	instrumentType = `default(InstrumentTypeEnum)`
	)

inline

Initializes a new instance of the MasteredInstrument class.

Parameters

identifiers Dictionary of identifiers of the mastered instrument (required).

instrumentType Available values: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility, FlexibleDeposit, FlexibleRepo. (required) (default to "MasteredInstrument").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.MasteredInstrument.BaseValidate ( ValidationContext validationContext )

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

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

inline

Returns true if MasteredInstrument instances are equal

Parameters

input Instance of MasteredInstrument to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ShouldSerializeMasteredAssetClass()

bool Lusid.Sdk.Model.MasteredInstrument.ShouldSerializeMasteredAssetClass ( )

inline

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

Returns: false (boolean)

◆ ShouldSerializeMasteredDomCcy()

bool Lusid.Sdk.Model.MasteredInstrument.ShouldSerializeMasteredDomCcy ( )

inline

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

Returns: false (boolean)

◆ ShouldSerializeMasteredInstrumentType()

bool Lusid.Sdk.Model.MasteredInstrument.ShouldSerializeMasteredInstrumentType ( )

inline

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

Returns: false (boolean)

◆ ShouldSerializeMasteredLusidInstrumentId()

bool Lusid.Sdk.Model.MasteredInstrument.ShouldSerializeMasteredLusidInstrumentId ( )

inline

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

Returns: false (boolean)

◆ ShouldSerializeMasteredName()

bool Lusid.Sdk.Model.MasteredInstrument.ShouldSerializeMasteredName ( )

inline

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

Returns: false (boolean)

◆ ShouldSerializeMasteredScope()

bool Lusid.Sdk.Model.MasteredInstrument.ShouldSerializeMasteredScope ( )

inline

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

Returns: false (boolean)

◆ ToJson()

override string Lusid.Sdk.Model.MasteredInstrument.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.LusidInstrument.

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ Identifiers

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

getset

Dictionary of identifiers of the mastered instrument

◆ MasteredAssetClass

string Lusid.Sdk.Model.MasteredInstrument.MasteredAssetClass

get

Asset class of the underlying mastered instrument - read only field Supported string (enumeration) values are: [InterestRates, FX, Inflation, Equities, Credit, Commodities, Money]. Defaults to "Unknown" if not set.

◆ MasteredDomCcy

string Lusid.Sdk.Model.MasteredInstrument.MasteredDomCcy

get

DomCcy of the Instrument that Mastered Instrument points to - read only field

◆ MasteredInstrumentType

string Lusid.Sdk.Model.MasteredInstrument.MasteredInstrumentType

get

Type of the Instrument that Mastered Instrument points to - read only field

◆ MasteredLusidInstrumentId

string Lusid.Sdk.Model.MasteredInstrument.MasteredLusidInstrumentId

get

Luid of the Instrument that Mastered Instrument points to - read only field

◆ MasteredName

string Lusid.Sdk.Model.MasteredInstrument.MasteredName

get

Name of the Instrument that Mastered Instrument points to - read only field

◆ MasteredScope

string Lusid.Sdk.Model.MasteredInstrument.MasteredScope

get

Scope of the Instrument that Mastered Instrument points to - read only field

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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MasteredInstrument() [1/2]

◆ MasteredInstrument() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ShouldSerializeMasteredAssetClass()

◆ ShouldSerializeMasteredDomCcy()

◆ ShouldSerializeMasteredInstrumentType()

◆ ShouldSerializeMasteredLusidInstrumentId()

◆ ShouldSerializeMasteredName()

◆ ShouldSerializeMasteredScope()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Identifiers

◆ MasteredAssetClass

◆ MasteredDomCcy

◆ MasteredInstrumentType

◆ MasteredLusidInstrumentId

◆ MasteredName

◆ MasteredScope