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

UpsertInstrumentEventRequest More...

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

Public Member Functions

 UpsertInstrumentEventRequest (string instrumentEventId=default(string), Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), string description=default(string), InstrumentEvent instrumentEvent=default(InstrumentEvent), List< PerpetualProperty > properties=default(List< PerpetualProperty >), int? sequenceNumber=default(int?), string participationType=@"Mandatory", Dictionary< string, YearMonthDay > eventDateStamps=default(Dictionary< string, YearMonthDay >))
 Initializes a new instance of the UpsertInstrumentEventRequest 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 (UpsertInstrumentEventRequest input)
 Returns true if UpsertInstrumentEventRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string InstrumentEventId Mandatory" [get, set]
 Free string that uniquely identifies the event within the corporate action source More...
 
Dictionary< string, string > InstrumentIdentifiers [get, set]
 The set of identifiers which determine the instrument this event relates to. More...
 
string Description [get, set]
 The description of the instrument event. More...
 
InstrumentEvent InstrumentEvent [get, set]
 Gets or Sets InstrumentEvent More...
 
List< PerpetualPropertyProperties [get, set]
 The properties attached to this instrument event. More...
 
int? SequenceNumber [get, set]
 The order of the instrument event relative others on the same date (0 being processed first). Must be non negative. More...
 
string ParticipationType [get, set]
 Indicates the type of participation in this event. Default value: Mandatory. Available values: Mandatory, MandatoryWithChoices, Voluntary. More...
 
Dictionary< string, YearMonthDayEventDateStamps [get, set]
 The date stamps corresponding to the relevant date-time fields for the instrument event. The key for each provided date stamp must match the field name of a valid datetime field from the InstrumentEvent DTO. More...
 

Detailed Description

UpsertInstrumentEventRequest

Constructor & Destructor Documentation

◆ UpsertInstrumentEventRequest() [1/2]

Lusid.Sdk.Model.UpsertInstrumentEventRequest.UpsertInstrumentEventRequest ( )
inlineprotected

Initializes a new instance of the UpsertInstrumentEventRequest class.

◆ UpsertInstrumentEventRequest() [2/2]

Lusid.Sdk.Model.UpsertInstrumentEventRequest.UpsertInstrumentEventRequest ( string  instrumentEventId = default(string),
Dictionary< string, string >  instrumentIdentifiers = default(Dictionary<string, string>),
string  description = default(string),
InstrumentEvent  instrumentEvent = default(InstrumentEvent),
List< PerpetualProperty properties = default(List<PerpetualProperty>),
int?  sequenceNumber = default(int?),
string  participationType = @"Mandatory",
Dictionary< string, YearMonthDay eventDateStamps = default(Dictionary<string, YearMonthDay>) 
)
inline

Initializes a new instance of the UpsertInstrumentEventRequest class.

Parameters
instrumentEventIdFree string that uniquely identifies the event within the corporate action source (required).
instrumentIdentifiersThe set of identifiers which determine the instrument this event relates to. (required).
descriptionThe description of the instrument event..
instrumentEventinstrumentEvent (required).
propertiesThe properties attached to this instrument event..
sequenceNumberThe order of the instrument event relative others on the same date (0 being processed first). Must be non negative..
participationTypeIndicates the type of participation in this event. Default value: Mandatory. Available values: Mandatory, MandatoryWithChoices, Voluntary. (default to "Mandatory").
eventDateStampsThe date stamps corresponding to the relevant date-time fields for the instrument event. The key for each provided date stamp must match the field name of a valid datetime field from the InstrumentEvent DTO..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if UpsertInstrumentEventRequest instances are equal

Parameters
inputInstance of UpsertInstrumentEventRequest to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Description

string Lusid.Sdk.Model.UpsertInstrumentEventRequest.Description
getset

The description of the instrument event.

The description of the instrument event.

◆ EventDateStamps

Dictionary<string, YearMonthDay> Lusid.Sdk.Model.UpsertInstrumentEventRequest.EventDateStamps
getset

The date stamps corresponding to the relevant date-time fields for the instrument event. The key for each provided date stamp must match the field name of a valid datetime field from the InstrumentEvent DTO.

The date stamps corresponding to the relevant date-time fields for the instrument event. The key for each provided date stamp must match the field name of a valid datetime field from the InstrumentEvent DTO.

◆ InstrumentEvent

InstrumentEvent Lusid.Sdk.Model.UpsertInstrumentEventRequest.InstrumentEvent
getset

Gets or Sets InstrumentEvent

◆ InstrumentEventId

string Lusid.Sdk.Model.UpsertInstrumentEventRequest.InstrumentEventId Mandatory"
getset

Free string that uniquely identifies the event within the corporate action source

Free string that uniquely identifies the event within the corporate action source

◆ InstrumentIdentifiers

Dictionary<string, string> Lusid.Sdk.Model.UpsertInstrumentEventRequest.InstrumentIdentifiers
getset

The set of identifiers which determine the instrument this event relates to.

The set of identifiers which determine the instrument this event relates to.

◆ ParticipationType

string Lusid.Sdk.Model.UpsertInstrumentEventRequest.ParticipationType
getset

Indicates the type of participation in this event. Default value: Mandatory. Available values: Mandatory, MandatoryWithChoices, Voluntary.

Indicates the type of participation in this event. Default value: Mandatory. Available values: Mandatory, MandatoryWithChoices, Voluntary.

◆ Properties

List<PerpetualProperty> Lusid.Sdk.Model.UpsertInstrumentEventRequest.Properties
getset

The properties attached to this instrument event.

The properties attached to this instrument event.

◆ SequenceNumber

int? Lusid.Sdk.Model.UpsertInstrumentEventRequest.SequenceNumber
getset

The order of the instrument event relative others on the same date (0 being processed first). Must be non negative.

The order of the instrument event relative others on the same date (0 being processed first). Must be non negative.


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