The definition of an Address Key Option More...
Inheritance diagram for Lusid.Sdk.Model.AddressKeyOptionDefinition:
Public Member Functions | |
| AddressKeyOptionDefinition (string name=default(string), string type=default(string), string description=default(string), bool optional=default(bool), List< string > allowedValueSet=default(List< string >), string defaultValue=default(string)) | |
| Initializes a new instance of the AddressKeyOptionDefinition 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 (AddressKeyOptionDefinition input) |
| Returns true if AddressKeyOptionDefinition instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
Protected Member Functions | |
| AddressKeyOptionDefinition () | |
| Initializes a new instance of the AddressKeyOptionDefinition class. More... | |
Properties | |
| string | Name [get, set] |
| The name of the option More... | |
| string | Type [get, set] |
| The type of the option More... | |
| string | Description [get, set] |
| The description of the option More... | |
| bool | Optional [get, set] |
| Is this option required or optional? More... | |
| List< string > | AllowedValueSet [get, set] |
| If the option is a string or enum, the allowed set of values it can take. More... | |
| string | DefaultValue [get, set] |
| If the option is not required, what is the default value? More... | |
Detailed Description
The definition of an Address Key Option
Constructor & Destructor Documentation
◆ AddressKeyOptionDefinition() [1/2]
|
inlineprotected |
Initializes a new instance of the AddressKeyOptionDefinition class.
◆ AddressKeyOptionDefinition() [2/2]
|
inline |
Initializes a new instance of the AddressKeyOptionDefinition class.
- Parameters
-
name The name of the option (required). type The type of the option (required). description The description of the option (required). optional Is this option required or optional? (required). allowedValueSet If the option is a string or enum, the allowed set of values it can take.. defaultValue If the option is not required, what is the default value?.
Member Function Documentation
◆ Equals() [1/2]
|
inline |
Returns true if AddressKeyOptionDefinition instances are equal
- Parameters
-
input Instance of AddressKeyOptionDefinition to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
Returns true if objects are equal
- Parameters
-
input Object to be compared
- Returns
- Boolean
◆ GetHashCode()
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ToJson()
|
inlinevirtual |
Returns the JSON string presentation of the object
- Returns
- JSON string presentation of the object
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ AllowedValueSet
|
getset |
If the option is a string or enum, the allowed set of values it can take.
If the option is a string or enum, the allowed set of values it can take.
◆ DefaultValue
|
getset |
If the option is not required, what is the default value?
If the option is not required, what is the default value?
◆ Description
|
getset |
The description of the option
The description of the option
◆ Name
|
getset |
The name of the option
The name of the option
◆ Optional
|
getset |
Is this option required or optional?
Is this option required or optional?
◆ Type
|
getset |
The type of the option
The type of the option
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/AddressKeyOptionDefinition.cs
