Contains the run-time parameters that are appropriate for check definitions with datasetSchema.type = "LusidEntity" More...

Inheritance diagram for Lusid.Sdk.Model.LusidEntityDataset:

[legend]

Public Member Functions
	LusidEntityDataset (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOffset? effectiveAt=default(DateTimeOffset?), string scope=default(string), DateTimeOffset? asAtModifiedSince=default(DateTimeOffset?), string selectorAttribute=default(string), string selectorValue=default(string), string returnIdentifierKey=default(string))
	Initializes a new instance of the LusidEntityDataset 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 (LusidEntityDataset input)
	Returns true if LusidEntityDataset instances are equal More...

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

Properties
DateTimeOffset?	AsAt `[get, set]`
	The asAt date to fetch the data. Nullable. Defaults to latest. More...

DateTimeOffset?	EffectiveAt `[get, set]`
	The effectiveAt date to fetch the data. Nullable. Defaults to latest. More...

string	Scope `[get, set]`
	The scope of the entities to check. Required for scoped entity types (Instrument, Portfolio). Must not be provided for unscoped entity types (LegalEntity). More...

DateTimeOffset?	AsAtModifiedSince `[get, set]`
	Nullable. Filters the dataset for version.asAtModified greater than or equal to this value. More...

string	SelectorAttribute `[get, set]`
	An attribute (field name, propertyKey or identifierKey) to use to sub-divide the dataset. More...

string	SelectorValue `[get, set]`
	The value of the above attribute used to sub-divide the dataset. More...

string	ReturnIdentifierKey `[get, set]`
	The preferred identifier to return for entities with multiple external identifiers. More...

Detailed Description

Contains the run-time parameters that are appropriate for check definitions with datasetSchema.type = "LusidEntity"

Constructor & Destructor Documentation

◆ LusidEntityDataset()

Lusid.Sdk.Model.LusidEntityDataset.LusidEntityDataset	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		string	scope = `default(string)`,
		DateTimeOffset?	asAtModifiedSince = `default(DateTimeOffset?)`,
		string	selectorAttribute = `default(string)`,
		string	selectorValue = `default(string)`,
		string	returnIdentifierKey = `default(string)`
	)

inline

Initializes a new instance of the LusidEntityDataset class.

Parameters

asAt	The asAt date to fetch the data. Nullable. Defaults to latest..
effectiveAt	The effectiveAt date to fetch the data. Nullable. Defaults to latest..
scope	The scope of the entities to check. Required for scoped entity types (Instrument, Portfolio). Must not be provided for unscoped entity types (LegalEntity)..
asAtModifiedSince	Nullable. Filters the dataset for version.asAtModified greater than or equal to this value..
selectorAttribute	An attribute (field name, propertyKey or identifierKey) to use to sub-divide the dataset..
selectorValue	The value of the above attribute used to sub-divide the dataset..
returnIdentifierKey	The preferred identifier to return for entities with multiple external identifiers..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if LusidEntityDataset instances are equal

Parameters

input Instance of LusidEntityDataset to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AsAt

DateTimeOffset? Lusid.Sdk.Model.LusidEntityDataset.AsAt

getset

The asAt date to fetch the data. Nullable. Defaults to latest.

◆ AsAtModifiedSince

DateTimeOffset? Lusid.Sdk.Model.LusidEntityDataset.AsAtModifiedSince

getset

Nullable. Filters the dataset for version.asAtModified greater than or equal to this value.

◆ EffectiveAt

DateTimeOffset? Lusid.Sdk.Model.LusidEntityDataset.EffectiveAt

getset

The effectiveAt date to fetch the data. Nullable. Defaults to latest.

◆ ReturnIdentifierKey

string Lusid.Sdk.Model.LusidEntityDataset.ReturnIdentifierKey

getset

The preferred identifier to return for entities with multiple external identifiers.

◆ Scope

string Lusid.Sdk.Model.LusidEntityDataset.Scope

getset

The scope of the entities to check. Required for scoped entity types (Instrument, Portfolio). Must not be provided for unscoped entity types (LegalEntity).

◆ SelectorAttribute

string Lusid.Sdk.Model.LusidEntityDataset.SelectorAttribute

getset

An attribute (field name, propertyKey or identifierKey) to use to sub-divide the dataset.

◆ SelectorValue

string Lusid.Sdk.Model.LusidEntityDataset.SelectorValue

getset

The value of the above attribute used to sub-divide the dataset.

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ LusidEntityDataset()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AsAt

◆ AsAtModifiedSince

◆ EffectiveAt

◆ ReturnIdentifierKey

◆ Scope

◆ SelectorAttribute

◆ SelectorValue