Lusid.Sdk.Model.StructuredResultData Class Reference

An item of structured result data that is to be inserted into Lusid. This will typically be a Json or Xml document that contains a set of result data appropriate to a specific entity such as an instrument or potentially an index. More...

Inheritance diagram for Lusid.Sdk.Model.StructuredResultData:

Public Member Functions
	StructuredResultData (string documentFormat=default(string), string version=default(string), string name=default(string), string document=default(string), DataMapKey dataMapKey=default(DataMapKey))
	Initializes a new instance of the StructuredResultData 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 (StructuredResultData input)
	Returns true if StructuredResultData instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

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

Properties
string	DocumentFormat [get, set]
	The format of the accompanying document. More...
string	_Version [get, set]
	The semantic version of the document format; MAJOR.MINOR.PATCH More...
string	Name [get, set]
	The name or description for the document More...
string	Document [get, set]
	The document that will be stored (or retrieved) and which describes a unit result data entity such as a set of prices or yields More...
DataMapKey	DataMapKey [get, set]
	Gets or Sets DataMapKey More...

Detailed Description

An item of structured result data that is to be inserted into Lusid. This will typically be a Json or Xml document that contains a set of result data appropriate to a specific entity such as an instrument or potentially an index.

Constructor & Destructor Documentation

StructuredResultData() [1/2]

Lusid.Sdk.Model.StructuredResultData.StructuredResultData ( )

inlineprotected

Initializes a new instance of the StructuredResultData class.

StructuredResultData() [2/2]

Lusid.Sdk.Model.StructuredResultData.StructuredResultData ( string  documentFormat = default(string), string  version = default(string), string  name = default(string), string  document = default(string), DataMapKey  dataMapKey = default(DataMapKey)  )

inline

Initializes a new instance of the StructuredResultData class.

Parameters

documentFormat	The format of the accompanying document. (required).
version	The semantic version of the document format; MAJOR.MINOR.PATCH.
name	The name or description for the document.
document	The document that will be stored (or retrieved) and which describes a unit result data entity such as a set of prices or yields (required).
dataMapKey	dataMapKey.

Member Function Documentation

Equals() [1/2]

override bool Lusid.Sdk.Model.StructuredResultData.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.StructuredResultData.Equals ( StructuredResultData  input )

inline

Returns true if StructuredResultData instances are equal

Parameters

input

Instance of StructuredResultData to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

_Version

string Lusid.Sdk.Model.StructuredResultData._Version

getset

The semantic version of the document format; MAJOR.MINOR.PATCH

The semantic version of the document format; MAJOR.MINOR.PATCH

DataMapKey

DataMapKey Lusid.Sdk.Model.StructuredResultData.DataMapKey

getset

Gets or Sets DataMapKey

Document

string Lusid.Sdk.Model.StructuredResultData.Document

getset

The document that will be stored (or retrieved) and which describes a unit result data entity such as a set of prices or yields

The document that will be stored (or retrieved) and which describes a unit result data entity such as a set of prices or yields

DocumentFormat

string Lusid.Sdk.Model.StructuredResultData.DocumentFormat

getset

The format of the accompanying document.

The format of the accompanying document.

Name

string Lusid.Sdk.Model.StructuredResultData.Name

getset

The name or description for the document

The name or description for the document

---

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