Represents the result of a data quality check operation More...

Inheritance diagram for Lusid.Sdk.Model.DataQualityCheckResult:

Public Member Functions
	DataQualityCheckResult (string checkDefinitionScope=default(string), string checkDefinitionCode=default(string), string checkDefinitionDisplayName=default(string), DateTimeOffset checkRunAsAt=default(DateTimeOffset), string resultType=default(string), string ruleSetKey=default(string), string ruleSetDisplayName=default(string), string ruleKey=default(string), string ruleDisplayName=default(string), string ruleDescription=default(string), string ruleFormula=default(string), int? severity=default(int?), LusidEntityResult lusidEntity=default(LusidEntityResult), int? countRuleBreaches=default(int?), string errorDetail=default(string), string resultId=default(string))
	Initializes a new instance of the DataQualityCheckResult 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 (DataQualityCheckResult input)
	Returns true if DataQualityCheckResult instances are equal More...

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

Properties
string	CheckDefinitionScope `[get, set]`
	The scope of the check definition More...

string	CheckDefinitionCode `[get, set]`
	The code of the check definition More...

string	CheckDefinitionDisplayName `[get, set]`
	The display name of the check definition More...

DateTimeOffset	CheckRunAsAt `[get, set]`
	The timestamp when the check was run More...

string	ResultType `[get, set]`
	The type of result from the check More...

string	RuleSetKey `[get, set]`
	The key identifying the ruleset More...

string	RuleSetDisplayName `[get, set]`
	The display name of the ruleset More...

string	RuleKey `[get, set]`
	The key identifying the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit) More...

string	RuleDisplayName `[get, set]`
	The display name of the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit) More...

string	RuleDescription `[get, set]`
	The description of the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit) More...

string	RuleFormula `[get, set]`
	The formula of the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit) More...

int?	Severity `[get, set]`
	The severity level More...

LusidEntityResult	LusidEntity `[get, set]`
	Gets or Sets LusidEntity More...

int?	CountRuleBreaches `[get, set]`
	The count of rule breaches (1 for RuleBreached, multiple for RuleBreachesOverLimit) More...

string	ErrorDetail `[get, set]`
	Error details (for RulesetInvalid, RuleInvalid) More...

string	ResultId `[get, set]`
	Unique identifier for the result in format: {{GUID of Check Definition}}-{{resultType}}-{{rulesetKey}}-{{ruleKey}}-{{entity GUID}} More...

Detailed Description

Represents the result of a data quality check operation

Constructor & Destructor Documentation

◆ DataQualityCheckResult()

Lusid.Sdk.Model.DataQualityCheckResult.DataQualityCheckResult	(	string	checkDefinitionScope = `default(string)`,
		string	checkDefinitionCode = `default(string)`,
		string	checkDefinitionDisplayName = `default(string)`,
		DateTimeOffset	checkRunAsAt = `default(DateTimeOffset)`,
		string	resultType = `default(string)`,
		string	ruleSetKey = `default(string)`,
		string	ruleSetDisplayName = `default(string)`,
		string	ruleKey = `default(string)`,
		string	ruleDisplayName = `default(string)`,
		string	ruleDescription = `default(string)`,
		string	ruleFormula = `default(string)`,
		int?	severity = `default(int?)`,
		LusidEntityResult	lusidEntity = `default(LusidEntityResult)`,
		int?	countRuleBreaches = `default(int?)`,
		string	errorDetail = `default(string)`,
		string	resultId = `default(string)`
	)

inline

Initializes a new instance of the DataQualityCheckResult class.

Parameters

checkDefinitionScope	The scope of the check definition.
checkDefinitionCode	The code of the check definition.
checkDefinitionDisplayName	The display name of the check definition.
checkRunAsAt	The timestamp when the check was run.
resultType	The type of result from the check.
ruleSetKey	The key identifying the ruleset.
ruleSetDisplayName	The display name of the ruleset.
ruleKey	The key identifying the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit).
ruleDisplayName	The display name of the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit).
ruleDescription	The description of the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit).
ruleFormula	The formula of the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit).
severity	The severity level.
lusidEntity	lusidEntity.
countRuleBreaches	The count of rule breaches (1 for RuleBreached, multiple for RuleBreachesOverLimit).
errorDetail	Error details (for RulesetInvalid, RuleInvalid).
resultId	Unique identifier for the result in format: {{GUID of Check Definition}}-{{resultType}}-{{rulesetKey}}-{{ruleKey}}-{{entity GUID}}.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if DataQualityCheckResult instances are equal

Parameters

input Instance of DataQualityCheckResult to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ CheckDefinitionCode

string Lusid.Sdk.Model.DataQualityCheckResult.CheckDefinitionCode

getset

The code of the check definition

◆ CheckDefinitionDisplayName

string Lusid.Sdk.Model.DataQualityCheckResult.CheckDefinitionDisplayName

getset

The display name of the check definition

◆ CheckDefinitionScope

string Lusid.Sdk.Model.DataQualityCheckResult.CheckDefinitionScope

getset

The scope of the check definition

◆ CheckRunAsAt

DateTimeOffset Lusid.Sdk.Model.DataQualityCheckResult.CheckRunAsAt

getset

The timestamp when the check was run

◆ CountRuleBreaches

int? Lusid.Sdk.Model.DataQualityCheckResult.CountRuleBreaches

getset

The count of rule breaches (1 for RuleBreached, multiple for RuleBreachesOverLimit)

◆ ErrorDetail

string Lusid.Sdk.Model.DataQualityCheckResult.ErrorDetail

getset

Error details (for RulesetInvalid, RuleInvalid)

◆ LusidEntity

LusidEntityResult Lusid.Sdk.Model.DataQualityCheckResult.LusidEntity

getset

Gets or Sets LusidEntity

◆ ResultId

string Lusid.Sdk.Model.DataQualityCheckResult.ResultId

getset

Unique identifier for the result in format: {{GUID of Check Definition}}-{{resultType}}-{{rulesetKey}}-{{ruleKey}}-{{entity GUID}}

◆ ResultType

string Lusid.Sdk.Model.DataQualityCheckResult.ResultType

getset

The type of result from the check

◆ RuleDescription

string Lusid.Sdk.Model.DataQualityCheckResult.RuleDescription

getset

The description of the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit)

◆ RuleDisplayName

string Lusid.Sdk.Model.DataQualityCheckResult.RuleDisplayName

getset

The display name of the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit)

◆ RuleFormula

string Lusid.Sdk.Model.DataQualityCheckResult.RuleFormula

getset

The formula of the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit)

◆ RuleKey

string Lusid.Sdk.Model.DataQualityCheckResult.RuleKey

getset

The key identifying the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit)

◆ RuleSetDisplayName

string Lusid.Sdk.Model.DataQualityCheckResult.RuleSetDisplayName

getset

The display name of the ruleset

◆ RuleSetKey

string Lusid.Sdk.Model.DataQualityCheckResult.RuleSetKey

getset

The key identifying the ruleset

◆ Severity

int? Lusid.Sdk.Model.DataQualityCheckResult.Severity

getset

The severity level

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ DataQualityCheckResult()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ CheckDefinitionCode

◆ CheckDefinitionDisplayName

◆ CheckDefinitionScope

◆ CheckRunAsAt

◆ CountRuleBreaches

◆ ErrorDetail

◆ LusidEntity

◆ ResultId

◆ ResultType

◆ RuleDescription

◆ RuleDisplayName

◆ RuleFormula

◆ RuleKey

◆ RuleSetDisplayName

◆ RuleSetKey

◆ Severity