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

ResultDataKeyRule More...

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

Public Member Functions

 ResultDataKeyRule (string supplier=default(string), string dataScope=default(string), string documentCode=default(string), string quoteInterval=default(string), DateTimeOffset? asAt=default(DateTimeOffset?), string resourceKey=default(string), string documentResultType=default(string), ResultKeyRuleTypeEnum resultKeyRuleType=default(ResultKeyRuleTypeEnum))
 Initializes a new instance of the ResultDataKeyRule class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override 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 (ResultDataKeyRule input)
 Returns true if ResultDataKeyRule instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.ResultKeyRule
 ResultKeyRule (ResultKeyRuleTypeEnum resultKeyRuleType=default(ResultKeyRuleTypeEnum))
 Initializes a new instance of the ResultKeyRule class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (ResultKeyRule input)
 Returns true if ResultKeyRule instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 ResultDataKeyRule ()
 Initializes a new instance of the ResultDataKeyRule class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 
- Protected Member Functions inherited from Lusid.Sdk.Model.ResultKeyRule
 ResultKeyRule ()
 Initializes a new instance of the ResultKeyRule class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 

Properties

string Supplier [get, set]
 the result resource supplier (where the data comes from) More...
 
string DataScope [get, set]
 which is the scope in which the data should be found More...
 
string DocumentCode [get, set]
 document code that defines which document is desired More...
 
string QuoteInterval [get, set]
 Shorthand for the time interval used to select result data. This must be a dot-separated string specifying a start and end date, for example &#39;5D.0D&#39; to look back 5 days from today (0 days ago). More...
 
DateTimeOffset? AsAt [get, set]
 The AsAt predicate specification. More...
 
string ResourceKey [get, set]
 The result data key that identifies the address pattern that this is a rule for More...
 
string DocumentResultType [get, set]
 Gets or Sets DocumentResultType More...
 
- Properties inherited from Lusid.Sdk.Model.ResultKeyRule
ResultKeyRuleTypeEnum ResultKeyRuleType [get, set]
 The available values are: Invalid, ResultDataKeyRule, PortfolioResultDataKeyRule More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.ResultKeyRule
enum class  ResultKeyRuleTypeEnum { Invalid = 1 , ResultDataKeyRule = 2 , PortfolioResultDataKeyRule = 3 }
 The available values are: Invalid, ResultDataKeyRule, PortfolioResultDataKeyRule More...
 

Detailed Description

ResultDataKeyRule

Constructor & Destructor Documentation

◆ ResultDataKeyRule() [1/2]

Lusid.Sdk.Model.ResultDataKeyRule.ResultDataKeyRule ( )
inlineprotected

Initializes a new instance of the ResultDataKeyRule class.

◆ ResultDataKeyRule() [2/2]

Lusid.Sdk.Model.ResultDataKeyRule.ResultDataKeyRule ( string  supplier = default(string),
string  dataScope = default(string),
string  documentCode = default(string),
string  quoteInterval = default(string),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string  resourceKey = default(string),
string  documentResultType = default(string),
ResultKeyRuleTypeEnum  resultKeyRuleType = default(ResultKeyRuleTypeEnum) 
)
inline

Initializes a new instance of the ResultDataKeyRule class.

Parameters
supplierthe result resource supplier (where the data comes from) (required).
dataScopewhich is the scope in which the data should be found (required).
documentCodedocument code that defines which document is desired (required).
quoteIntervalShorthand for the time interval used to select result data. This must be a dot-separated string specifying a start and end date, for example &#39;5D.0D&#39; to look back 5 days from today (0 days ago)..
asAtThe AsAt predicate specification..
resourceKeyThe result data key that identifies the address pattern that this is a rule for (required).
documentResultTypedocumentResultType (required).
resultKeyRuleTypeThe available values are: Invalid, ResultDataKeyRule, PortfolioResultDataKeyRule (required) (default to "ResultDataKeyRule").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.ResultDataKeyRule.BaseValidate ( ValidationContext  validationContext)
inlineprotected

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if ResultDataKeyRule instances are equal

Parameters
inputInstance of ResultDataKeyRule to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.ResultDataKeyRule.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.ResultKeyRule.

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AsAt

DateTimeOffset? Lusid.Sdk.Model.ResultDataKeyRule.AsAt
getset

The AsAt predicate specification.

The AsAt predicate specification.

◆ DataScope

string Lusid.Sdk.Model.ResultDataKeyRule.DataScope
getset

which is the scope in which the data should be found

which is the scope in which the data should be found

◆ DocumentCode

string Lusid.Sdk.Model.ResultDataKeyRule.DocumentCode
getset

document code that defines which document is desired

document code that defines which document is desired

◆ DocumentResultType

string Lusid.Sdk.Model.ResultDataKeyRule.DocumentResultType
getset

Gets or Sets DocumentResultType

◆ QuoteInterval

string Lusid.Sdk.Model.ResultDataKeyRule.QuoteInterval
getset

Shorthand for the time interval used to select result data. This must be a dot-separated string specifying a start and end date, for example &#39;5D.0D&#39; to look back 5 days from today (0 days ago).

Shorthand for the time interval used to select result data. This must be a dot-separated string specifying a start and end date, for example &#39;5D.0D&#39; to look back 5 days from today (0 days ago).

◆ ResourceKey

string Lusid.Sdk.Model.ResultDataKeyRule.ResourceKey
getset

The result data key that identifies the address pattern that this is a rule for

The result data key that identifies the address pattern that this is a rule for

◆ Supplier

string Lusid.Sdk.Model.ResultDataKeyRule.Supplier
getset

the result resource supplier (where the data comes from)

the result resource supplier (where the data comes from)


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