LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.StructuredResultDataId Class Reference

An identifier that uniquely describes an item of structured result data such as the risk to an interest curve or a set of yields or analytics on an index. More...

Inheritance diagram for Lusid.Sdk.Model.StructuredResultDataId:
Inheritance graph
[legend]

Public Member Functions

 StructuredResultDataId (string source=default(string), string code=default(string), DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), string resultType=default(string))
 Initializes a new instance of the StructuredResultDataId 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 (StructuredResultDataId input)
 Returns true if StructuredResultDataId instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 StructuredResultDataId ()
 Initializes a new instance of the StructuredResultDataId class. More...
 

Properties

string Source [get, set]
 The platform or vendor that provided the structured result data, e.g. 'client'. This is primarily of interest when data could have been sourced from multiple sources More...
 
string Code [get, set]
 The identifier for the entity that this id describes. It could be an index, instrument or other form of structured data More...
 
DateTimeOrCutLabel EffectiveAt [get, set]
 The effectiveAt or cut label that this item of structured result data is/was updated/inserted with. More...
 
string ResultType [get, set]
 An identifier that denotes the class of data that the id points to. This is not the same as the format, but a more generic identifier such as 'risk result', 'cashflow', 'index' or similar. More...
 

Detailed Description

An identifier that uniquely describes an item of structured result data such as the risk to an interest curve or a set of yields or analytics on an index.

Constructor & Destructor Documentation

◆ StructuredResultDataId() [1/2]

Lusid.Sdk.Model.StructuredResultDataId.StructuredResultDataId ( )
inlineprotected

Initializes a new instance of the StructuredResultDataId class.

◆ StructuredResultDataId() [2/2]

Lusid.Sdk.Model.StructuredResultDataId.StructuredResultDataId ( string  source = default(string),
string  code = default(string),
DateTimeOrCutLabel  effectiveAt = default(DateTimeOrCutLabel),
string  resultType = default(string) 
)
inline

Initializes a new instance of the StructuredResultDataId class.

Parameters
sourceThe platform or vendor that provided the structured result data, e.g. 'client'. This is primarily of interest when data could have been sourced from multiple sources (required).
codeThe identifier for the entity that this id describes. It could be an index, instrument or other form of structured data.
effectiveAtThe effectiveAt or cut label that this item of structured result data is/was updated/inserted with..
resultTypeAn identifier that denotes the class of data that the id points to. This is not the same as the format, but a more generic identifier such as 'risk result', 'cashflow', 'index' or similar..

Member Function Documentation

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.StructuredResultDataId.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.StructuredResultDataId.Equals ( StructuredResultDataId  input)
inline

Returns true if StructuredResultDataId instances are equal

Parameters
inputInstance of StructuredResultDataId to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.StructuredResultDataId.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.StructuredResultDataId.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.StructuredResultDataId.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Code

string Lusid.Sdk.Model.StructuredResultDataId.Code
getset

The identifier for the entity that this id describes. It could be an index, instrument or other form of structured data

The identifier for the entity that this id describes. It could be an index, instrument or other form of structured data

◆ EffectiveAt

DateTimeOrCutLabel Lusid.Sdk.Model.StructuredResultDataId.EffectiveAt
getset

The effectiveAt or cut label that this item of structured result data is/was updated/inserted with.

The effectiveAt or cut label that this item of structured result data is/was updated/inserted with.

◆ ResultType

string Lusid.Sdk.Model.StructuredResultDataId.ResultType
getset

An identifier that denotes the class of data that the id points to. This is not the same as the format, but a more generic identifier such as 'risk result', 'cashflow', 'index' or similar.

An identifier that denotes the class of data that the id points to. This is not the same as the format, but a more generic identifier such as 'risk result', 'cashflow', 'index' or similar.

◆ Source

string Lusid.Sdk.Model.StructuredResultDataId.Source
getset

The platform or vendor that provided the structured result data, e.g. 'client'. This is primarily of interest when data could have been sourced from multiple sources

The platform or vendor that provided the structured result data, e.g. 'client'. This is primarily of interest when data could have been sourced from multiple sources


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