Public Types | |
| enum class | TypeEnum { String = 1 , Int = 2 , Decimal = 3 , DateTime = 4 , Boolean = 5 , ResultValue = 6 , Result0D = 7 , Json = 8 } |
| Available values: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json. More... | |
Public Member Functions | |
| AddressDefinition (string displayName=default(string), TypeEnum ?type=default(TypeEnum?), string description=default(string), string lifeCycleStatus=default(string), DateTimeOffset? removalDate=default(DateTimeOffset?), string documentationLink=default(string)) | |
| Initializes a new instance of the AddressDefinition 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 (AddressDefinition input) |
| Returns true if AddressDefinition instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
Properties | |
| TypeEnum? | Type [get, set] |
| Available values: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json. More... | |
| string | DisplayName [get, set] |
| The display name of the address key. More... | |
| string | Description [get, set] |
| The description for this result. More... | |
| string | LifeCycleStatus [get, set] |
| What is the status of the address path. If it is not Production then it might be removed at some point in the future. See the removal date for the likely timing of that if any. More... | |
| DateTimeOffset? | RemovalDate [get, set] |
| If the life-cycle status of the address is Deprecated then this is the date at which support of the address will be suspended. After that date it will be removed at the earliest possible point subject to any specific contractual support and development constraints. More... | |
| string | DocumentationLink [get, set] |
| Contains a link to the documentation for this AddressDefinition in KnowledgeBase. More... | |
Detailed Description
Member Enumeration Documentation
◆ TypeEnum
|
strong |
Available values: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json.
Available values: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json.
| Enumerator | |
|---|---|
| String | Enum String for value: String |
| Int | Enum Int for value: Int |
| Decimal | Enum Decimal for value: Decimal |
| DateTime | Enum DateTime for value: DateTime |
| Boolean | Enum Boolean for value: Boolean |
| ResultValue | Enum ResultValue for value: ResultValue |
| Result0D | Enum Result0D for value: Result0D |
| Json | Enum Json for value: Json |
Constructor & Destructor Documentation
◆ AddressDefinition()
|
inline |
Initializes a new instance of the AddressDefinition class.
- Parameters
-
displayName The display name of the address key.. type Available values: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json.. description The description for this result.. lifeCycleStatus What is the status of the address path. If it is not Production then it might be removed at some point in the future. See the removal date for the likely timing of that if any.. removalDate If the life-cycle status of the address is Deprecated then this is the date at which support of the address will be suspended. After that date it will be removed at the earliest possible point subject to any specific contractual support and development constraints.. documentationLink Contains a link to the documentation for this AddressDefinition in KnowledgeBase..
Member Function Documentation
◆ Equals() [1/2]
|
inline |
Returns true if AddressDefinition instances are equal
- Parameters
-
input Instance of AddressDefinition 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
◆ Description
|
getset |
The description for this result.
The description for this result.
◆ DisplayName
|
getset |
The display name of the address key.
The display name of the address key.
◆ DocumentationLink
|
getset |
Contains a link to the documentation for this AddressDefinition in KnowledgeBase.
Contains a link to the documentation for this AddressDefinition in KnowledgeBase.
◆ LifeCycleStatus
|
getset |
What is the status of the address path. If it is not Production then it might be removed at some point in the future. See the removal date for the likely timing of that if any.
What is the status of the address path. If it is not Production then it might be removed at some point in the future. See the removal date for the likely timing of that if any.
◆ RemovalDate
|
getset |
If the life-cycle status of the address is Deprecated then this is the date at which support of the address will be suspended. After that date it will be removed at the earliest possible point subject to any specific contractual support and development constraints.
If the life-cycle status of the address is Deprecated then this is the date at which support of the address will be suspended. After that date it will be removed at the earliest possible point subject to any specific contractual support and development constraints.
◆ Type
|
getset |
Available values: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json.
Available values: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json.
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/AddressDefinition.cs
