When importing data from an external data source, in order for it to be reliable queryable, LUSID needs to know something about it. A data definition tells LUSID, what a given external data item is, what type it is and whether it in some way identifies items of data. Consider presenting LUSID with a list of dictionaries where each dictionary contains the same set of keys (names). Each data item pointed to by a key would be expected to be of the same type (integer, string, decimal etc.). To identify a particular dictionary from the list, a tuple of one or more of the items in the dictionary would make it unique. If only a single item is required then the More...

Inheritance diagram for Lusid.Sdk.Model.DataDefinition:

[legend]

Public Member Functions
	DataDefinition (string address=default(string), string name=default(string), string dataType=default(string), string keyType=default(string), bool allowNull=default(bool), bool allowMissing=default(bool))
	Initializes a new instance of the DataDefinition 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 (DataDefinition input)
	Returns true if DataDefinition instances are equal More...

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

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

Properties
string	Address `[get, set]`
	The internal address (LUSID native) of the unit in the provided data itself and corresponds to the external name of the data item More...

string	Name `[get, set]`
	The name of the data item. This is the name that will appear More...

string	DataType `[get, set]`
	A member of the set of possible data types, that all data passed under that key is expected to be of. Currently limited to one of [string, integer, decimal, result0d]. More...

string	KeyType `[get, set]`
	Is the item either a unique key for the dictionary, i.e. does it identify a unique index or conceptual 'row' within the list of dictionaries, or a partial key or is it simply a data item within that dictionary. Must be one of [Unique,PartOfUnique,Leaf, CompositeLeaf] More...

bool	AllowNull `[get, set]`
	The path to the field must exist (unless AllowMissing is true) but the actual value is allowed to be null. More...

bool	AllowMissing `[get, set]`
	The path (or column) is allowed to be missing but if it is present it is not allowed to be null unless AllowNull is true. More...

Detailed Description

When importing data from an external data source, in order for it to be reliable queryable, LUSID needs to know something about it. A data definition tells LUSID, what a given external data item is, what type it is and whether it in some way identifies items of data. Consider presenting LUSID with a list of dictionaries where each dictionary contains the same set of keys (names). Each data item pointed to by a key would be expected to be of the same type (integer, string, decimal etc.). To identify a particular dictionary from the list, a tuple of one or more of the items in the dictionary would make it unique. If only a single item is required then the

Constructor & Destructor Documentation

◆ DataDefinition() [1/2]

Lusid.Sdk.Model.DataDefinition.DataDefinition ( )

inlineprotected

Initializes a new instance of the DataDefinition class.

◆ DataDefinition() [2/2]

Lusid.Sdk.Model.DataDefinition.DataDefinition	(	string	address = `default(string)`,
		string	name = `default(string)`,
		string	dataType = `default(string)`,
		string	keyType = `default(string)`,
		bool	allowNull = `default(bool)`,
		bool	allowMissing = `default(bool)`
	)

inline

Initializes a new instance of the DataDefinition class.

Parameters

address	The internal address (LUSID native) of the unit in the provided data itself and corresponds to the external name of the data item (required).
name	The name of the data item. This is the name that will appear.
dataType	A member of the set of possible data types, that all data passed under that key is expected to be of. Currently limited to one of [string, integer, decimal, result0d]..
keyType	Is the item either a unique key for the dictionary, i.e. does it identify a unique index or conceptual 'row' within the list of dictionaries, or a partial key or is it simply a data item within that dictionary. Must be one of [Unique,PartOfUnique,Leaf, CompositeLeaf].
allowNull	The path to the field must exist (unless AllowMissing is true) but the actual value is allowed to be null..
allowMissing	The path (or column) is allowed to be missing but if it is present it is not allowed to be null unless AllowNull is true..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if DataDefinition instances are equal

Parameters

input Instance of DataDefinition to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ Address

string Lusid.Sdk.Model.DataDefinition.Address

getset

The internal address (LUSID native) of the unit in the provided data itself and corresponds to the external name of the data item

◆ AllowMissing

bool Lusid.Sdk.Model.DataDefinition.AllowMissing

getset

The path (or column) is allowed to be missing but if it is present it is not allowed to be null unless AllowNull is true.

◆ AllowNull

bool Lusid.Sdk.Model.DataDefinition.AllowNull

getset

The path to the field must exist (unless AllowMissing is true) but the actual value is allowed to be null.

◆ DataType

string Lusid.Sdk.Model.DataDefinition.DataType

getset

A member of the set of possible data types, that all data passed under that key is expected to be of. Currently limited to one of [string, integer, decimal, result0d].

◆ KeyType

string Lusid.Sdk.Model.DataDefinition.KeyType

getset

Is the item either a unique key for the dictionary, i.e. does it identify a unique index or conceptual 'row' within the list of dictionaries, or a partial key or is it simply a data item within that dictionary. Must be one of [Unique,PartOfUnique,Leaf, CompositeLeaf]

◆ Name

string Lusid.Sdk.Model.DataDefinition.Name

getset

The name of the data item. This is the name that will appear

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

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ DataDefinition() [1/2]

◆ DataDefinition() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Address

◆ AllowMissing

◆ AllowNull

◆ DataType

◆ KeyType

◆ Name