Lusid.Sdk.Model.AddressKeyAlias Class Reference

An address key alias that maps a short alias key to a real key with options. More...

Inheritance diagram for Lusid.Sdk.Model.AddressKeyAlias:

Public Member Functions
	AddressKeyAlias (string scope=default(string), string code=default(string), string aliasKey=default(string), string realKey=default(string), Dictionary< string, string > options=default(Dictionary< string, string >), string displayName=default(string), string description=default(string))
	Initializes a new instance of the AddressKeyAlias 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 (AddressKeyAlias input)
	Returns true if AddressKeyAlias instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

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

Properties
string	Scope [get, set]
	The scope of the alias More...
string	Code [get, set]
	The code of the alias More...
string	AliasKey [get, set]
	The alias address key, must start with "Alias/" prefix (e.g., "Alias/DailyNZPnL") More...
string	RealKey [get, set]
	The real address key this alias resolves to (e.g., "ProfitAndLoss/Total"). Must NOT start with "Alias/". More...
Dictionary< string, string >	Options [get, set]
	Options to apply when resolving the alias (e.g., {&quot;Window&quot;:&quot;Daily&quot;,&quot;TimeZone&quot;:&quot;NZ&quot;}) More...
string	DisplayName [get, set]
	Human-readable display name More...
string	Description [get, set]
	Description of the alias More...

Detailed Description

An address key alias that maps a short alias key to a real key with options.

Constructor & Destructor Documentation

AddressKeyAlias() [1/2]

Lusid.Sdk.Model.AddressKeyAlias.AddressKeyAlias ( )

inlineprotected

Initializes a new instance of the AddressKeyAlias class.

AddressKeyAlias() [2/2]

Lusid.Sdk.Model.AddressKeyAlias.AddressKeyAlias ( string  scope = default(string), string  code = default(string), string  aliasKey = default(string), string  realKey = default(string), Dictionary< string, string >  options = default(Dictionary<string, string>), string  displayName = default(string), string  description = default(string)  )

inline

Initializes a new instance of the AddressKeyAlias class.

Parameters

scope	The scope of the alias (required).
code	The code of the alias (required).
aliasKey	The alias address key, must start with "Alias/" prefix (e.g., "Alias/DailyNZPnL") (required).
realKey	The real address key this alias resolves to (e.g., "ProfitAndLoss/Total"). Must NOT start with "Alias/". (required).
options	Options to apply when resolving the alias (e.g., {"Window":"Daily","TimeZone":"NZ"}).
displayName	Human-readable display name.
description	Description of the alias.

Member Function Documentation

Equals() [1/2]

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

inline

Returns true if AddressKeyAlias instances are equal

Parameters

input

Instance of AddressKeyAlias to be compared

Returns

Boolean

Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input

Object to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

AliasKey

string Lusid.Sdk.Model.AddressKeyAlias.AliasKey

getset

The alias address key, must start with "Alias/" prefix (e.g., "Alias/DailyNZPnL")

The alias address key, must start with "Alias/" prefix (e.g., "Alias/DailyNZPnL")

Code

string Lusid.Sdk.Model.AddressKeyAlias.Code

getset

The code of the alias

The code of the alias

Description

string Lusid.Sdk.Model.AddressKeyAlias.Description

getset

Description of the alias

Description of the alias

DisplayName

string Lusid.Sdk.Model.AddressKeyAlias.DisplayName

getset

Human-readable display name

Human-readable display name

Options

Dictionary<string, string> Lusid.Sdk.Model.AddressKeyAlias.Options

getset

Options to apply when resolving the alias (e.g., {"Window":"Daily","TimeZone":"NZ"})

Options to apply when resolving the alias (e.g., {"Window":"Daily","TimeZone":"NZ"})

RealKey

string Lusid.Sdk.Model.AddressKeyAlias.RealKey

getset

The real address key this alias resolves to (e.g., "ProfitAndLoss/Total"). Must NOT start with "Alias/".

The real address key this alias resolves to (e.g., "ProfitAndLoss/Total"). Must NOT start with "Alias/".

Scope

string Lusid.Sdk.Model.AddressKeyAlias.Scope

getset

The scope of the alias

The scope of the alias

---

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