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

The version metadata. More...

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

Public Member Functions

 ModelVersion (DateTimeOffset effectiveFrom=default(DateTimeOffset), DateTimeOffset asAtDate=default(DateTimeOffset), DateTimeOffset? asAtCreated=default(DateTimeOffset?), string userIdCreated=default(string), string requestIdCreated=default(string), DateTimeOffset? asAtModified=default(DateTimeOffset?), string userIdModified=default(string), string requestIdModified=default(string), int? asAtVersionNumber=default(int?), string entityUniqueId=default(string))
 Initializes a new instance of the ModelVersion class. More...
 
bool ShouldSerializeStagedModificationIdModified ()
 Returns false as StagedModificationIdModified should not be serialized given that it's read-only. 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 (ModelVersion input)
 Returns true if ModelVersion instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 ModelVersion ()
 Initializes a new instance of the ModelVersion class. More...
 

Properties

DateTimeOffset EffectiveFrom [get, set]
 The effective datetime at which this version became valid. Only applies when a single entity is being interacted with. More...
 
DateTimeOffset AsAtDate [get, set]
 The asAt datetime at which the data was committed to LUSID. More...
 
DateTimeOffset? AsAtCreated [get, set]
 The asAt datetime at which the entity was first created in LUSID. More...
 
string UserIdCreated [get, set]
 The unique id of the user who created the entity. More...
 
string RequestIdCreated [get, set]
 The unique request id of the command that created the entity. More...
 
DateTimeOffset? AsAtModified [get, set]
 The asAt datetime at which the entity (including its properties) was last updated in LUSID. More...
 
string UserIdModified [get, set]
 The unique id of the user who last updated the entity (including its properties) in LUSID. More...
 
string RequestIdModified [get, set]
 The unique request id of the command that last updated the entity (including its properties) in LUSID. More...
 
int? AsAtVersionNumber [get, set]
 The integer version number for the entity (the entity was created at version 1) More...
 
string EntityUniqueId [get, set]
 The unique id of the entity More...
 
string StagedModificationIdModified [get]
 The ID of the staged change that resulted in the most recent modification. More...
 

Detailed Description

The version metadata.

Constructor & Destructor Documentation

◆ ModelVersion() [1/2]

Lusid.Sdk.Model.ModelVersion.ModelVersion ( )
inlineprotected

Initializes a new instance of the ModelVersion class.

◆ ModelVersion() [2/2]

Lusid.Sdk.Model.ModelVersion.ModelVersion ( DateTimeOffset  effectiveFrom = default(DateTimeOffset),
DateTimeOffset  asAtDate = default(DateTimeOffset),
DateTimeOffset?  asAtCreated = default(DateTimeOffset?),
string  userIdCreated = default(string),
string  requestIdCreated = default(string),
DateTimeOffset?  asAtModified = default(DateTimeOffset?),
string  userIdModified = default(string),
string  requestIdModified = default(string),
int?  asAtVersionNumber = default(int?),
string  entityUniqueId = default(string) 
)
inline

Initializes a new instance of the ModelVersion class.

Parameters
effectiveFromThe effective datetime at which this version became valid. Only applies when a single entity is being interacted with. (required).
asAtDateThe asAt datetime at which the data was committed to LUSID. (required).
asAtCreatedThe asAt datetime at which the entity was first created in LUSID..
userIdCreatedThe unique id of the user who created the entity..
requestIdCreatedThe unique request id of the command that created the entity..
asAtModifiedThe asAt datetime at which the entity (including its properties) was last updated in LUSID..
userIdModifiedThe unique id of the user who last updated the entity (including its properties) in LUSID..
requestIdModifiedThe unique request id of the command that last updated the entity (including its properties) in LUSID..
asAtVersionNumberThe integer version number for the entity (the entity was created at version 1).
entityUniqueIdThe unique id of the entity.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if ModelVersion instances are equal

Parameters
inputInstance of ModelVersion to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ShouldSerializeStagedModificationIdModified()

bool Lusid.Sdk.Model.ModelVersion.ShouldSerializeStagedModificationIdModified ( )
inline

Returns false as StagedModificationIdModified should not be serialized given that it's read-only.

Returns
false (boolean)

◆ ToJson()

virtual string Lusid.Sdk.Model.ModelVersion.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AsAtCreated

DateTimeOffset? Lusid.Sdk.Model.ModelVersion.AsAtCreated
getset

The asAt datetime at which the entity was first created in LUSID.

The asAt datetime at which the entity was first created in LUSID.

◆ AsAtDate

DateTimeOffset Lusid.Sdk.Model.ModelVersion.AsAtDate
getset

The asAt datetime at which the data was committed to LUSID.

The asAt datetime at which the data was committed to LUSID.

◆ AsAtModified

DateTimeOffset? Lusid.Sdk.Model.ModelVersion.AsAtModified
getset

The asAt datetime at which the entity (including its properties) was last updated in LUSID.

The asAt datetime at which the entity (including its properties) was last updated in LUSID.

◆ AsAtVersionNumber

int? Lusid.Sdk.Model.ModelVersion.AsAtVersionNumber
getset

The integer version number for the entity (the entity was created at version 1)

The integer version number for the entity (the entity was created at version 1)

◆ EffectiveFrom

DateTimeOffset Lusid.Sdk.Model.ModelVersion.EffectiveFrom
getset

The effective datetime at which this version became valid. Only applies when a single entity is being interacted with.

The effective datetime at which this version became valid. Only applies when a single entity is being interacted with.

◆ EntityUniqueId

string Lusid.Sdk.Model.ModelVersion.EntityUniqueId
getset

The unique id of the entity

The unique id of the entity

◆ RequestIdCreated

string Lusid.Sdk.Model.ModelVersion.RequestIdCreated
getset

The unique request id of the command that created the entity.

The unique request id of the command that created the entity.

◆ RequestIdModified

string Lusid.Sdk.Model.ModelVersion.RequestIdModified
getset

The unique request id of the command that last updated the entity (including its properties) in LUSID.

The unique request id of the command that last updated the entity (including its properties) in LUSID.

◆ StagedModificationIdModified

string Lusid.Sdk.Model.ModelVersion.StagedModificationIdModified
get

The ID of the staged change that resulted in the most recent modification.

The ID of the staged change that resulted in the most recent modification.

◆ UserIdCreated

string Lusid.Sdk.Model.ModelVersion.UserIdCreated
getset

The unique id of the user who created the entity.

The unique id of the user who created the entity.

◆ UserIdModified

string Lusid.Sdk.Model.ModelVersion.UserIdModified
getset

The unique id of the user who last updated the entity (including its properties) in LUSID.

The unique id of the user who last updated the entity (including its properties) in LUSID.


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