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

A list of instruments. More...

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

Public Member Functions

 InstrumentEntity (string href=default(string), string entityUniqueId=default(string), int? asAtVersionNumber=default(int?), string status=default(string), DateTimeOffset? asAtDeleted=default(DateTimeOffset?), string userIdDeleted=default(string), string requestIdDeleted=default(string), DateTimeOffset? effectiveAtCreated=default(DateTimeOffset?), Instrument prevailingInstrument=default(Instrument), Instrument deletedInstrument=default(Instrument), string previewedStatus=default(string), Instrument previewedInstrument=default(Instrument), List< Link > links=default(List< Link >))
 Initializes a new instance of the InstrumentEntity 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 (InstrumentEntity input)
 Returns true if InstrumentEntity instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string Href [get, set]
 The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. More...
 
string EntityUniqueId [get, set]
 The unique id of the entity. More...
 
int? AsAtVersionNumber [get, set]
 The integer version number for the entity (the entity was created at version 1) More...
 
string Status [get, set]
 The status of the entity at the current time. Available values: Prevailing, Deleted, DoesNotExist. More...
 
DateTimeOffset? AsAtDeleted [get, set]
 The asAt datetime at which the entity was deleted. More...
 
string UserIdDeleted [get, set]
 The unique id of the user who deleted the entity. More...
 
string RequestIdDeleted [get, set]
 The unique request id of the command that deleted the entity. More...
 
DateTimeOffset? EffectiveAtCreated [get, set]
 The EffectiveAt this Entity is created, if entity does not currently exist in EffectiveAt. More...
 
Instrument PrevailingInstrument [get, set]
 Gets or Sets PrevailingInstrument More...
 
Instrument DeletedInstrument [get, set]
 Gets or Sets DeletedInstrument More...
 
string PreviewedStatus [get, set]
 The status of the previewed entity. Available values: Prevailing, Deleted, DoesNotExist. More...
 
Instrument PreviewedInstrument [get, set]
 Gets or Sets PreviewedInstrument More...
 
List< LinkLinks [get, set]
 Gets or Sets Links More...
 

Detailed Description

A list of instruments.

Constructor & Destructor Documentation

◆ InstrumentEntity() [1/2]

Lusid.Sdk.Model.InstrumentEntity.InstrumentEntity ( )
inlineprotected

Initializes a new instance of the InstrumentEntity class.

◆ InstrumentEntity() [2/2]

Lusid.Sdk.Model.InstrumentEntity.InstrumentEntity ( string  href = default(string),
string  entityUniqueId = default(string),
int?  asAtVersionNumber = default(int?),
string  status = default(string),
DateTimeOffset?  asAtDeleted = default(DateTimeOffset?),
string  userIdDeleted = default(string),
string  requestIdDeleted = default(string),
DateTimeOffset?  effectiveAtCreated = default(DateTimeOffset?),
Instrument  prevailingInstrument = default(Instrument),
Instrument  deletedInstrument = default(Instrument),
string  previewedStatus = default(string),
Instrument  previewedInstrument = default(Instrument),
List< Link links = default(List<Link>) 
)
inline

Initializes a new instance of the InstrumentEntity class.

Parameters
hrefThe specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. (required).
entityUniqueIdThe unique id of the entity. (required).
asAtVersionNumberThe integer version number for the entity (the entity was created at version 1).
statusThe status of the entity at the current time. Available values: Prevailing, Deleted, DoesNotExist. (required).
asAtDeletedThe asAt datetime at which the entity was deleted..
userIdDeletedThe unique id of the user who deleted the entity..
requestIdDeletedThe unique request id of the command that deleted the entity..
effectiveAtCreatedThe EffectiveAt this Entity is created, if entity does not currently exist in EffectiveAt..
prevailingInstrumentprevailingInstrument.
deletedInstrumentdeletedInstrument.
previewedStatusThe status of the previewed entity. Available values: Prevailing, Deleted, DoesNotExist..
previewedInstrumentpreviewedInstrument.
linkslinks.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if InstrumentEntity instances are equal

Parameters
inputInstance of InstrumentEntity to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AsAtDeleted

DateTimeOffset? Lusid.Sdk.Model.InstrumentEntity.AsAtDeleted
getset

The asAt datetime at which the entity was deleted.

The asAt datetime at which the entity was deleted.

◆ AsAtVersionNumber

int? Lusid.Sdk.Model.InstrumentEntity.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)

◆ DeletedInstrument

Instrument Lusid.Sdk.Model.InstrumentEntity.DeletedInstrument
getset

Gets or Sets DeletedInstrument

◆ EffectiveAtCreated

DateTimeOffset? Lusid.Sdk.Model.InstrumentEntity.EffectiveAtCreated
getset

The EffectiveAt this Entity is created, if entity does not currently exist in EffectiveAt.

The EffectiveAt this Entity is created, if entity does not currently exist in EffectiveAt.

◆ EntityUniqueId

string Lusid.Sdk.Model.InstrumentEntity.EntityUniqueId
getset

The unique id of the entity.

The unique id of the entity.

◆ Href

string Lusid.Sdk.Model.InstrumentEntity.Href
getset

The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.

The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.

◆ Links

List<Link> Lusid.Sdk.Model.InstrumentEntity.Links
getset

Gets or Sets Links

◆ PrevailingInstrument

Instrument Lusid.Sdk.Model.InstrumentEntity.PrevailingInstrument
getset

Gets or Sets PrevailingInstrument

◆ PreviewedInstrument

Instrument Lusid.Sdk.Model.InstrumentEntity.PreviewedInstrument
getset

Gets or Sets PreviewedInstrument

◆ PreviewedStatus

string Lusid.Sdk.Model.InstrumentEntity.PreviewedStatus
getset

The status of the previewed entity. Available values: Prevailing, Deleted, DoesNotExist.

The status of the previewed entity. Available values: Prevailing, Deleted, DoesNotExist.

◆ RequestIdDeleted

string Lusid.Sdk.Model.InstrumentEntity.RequestIdDeleted
getset

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

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

◆ Status

string Lusid.Sdk.Model.InstrumentEntity.Status
getset

The status of the entity at the current time. Available values: Prevailing, Deleted, DoesNotExist.

The status of the entity at the current time. Available values: Prevailing, Deleted, DoesNotExist.

◆ UserIdDeleted

string Lusid.Sdk.Model.InstrumentEntity.UserIdDeleted
getset

The unique id of the user who deleted the entity.

The unique id of the user who deleted the entity.


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