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

CustomEntityField More...

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

Public Member Functions

 CustomEntityField (string name=default(string), Object value=default(Object), DateTimeOffset? effectiveFrom=default(DateTimeOffset?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?))
 Initializes a new instance of the CustomEntityField 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 (CustomEntityField input)
 Returns true if CustomEntityField instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string Name [get, set]
 The name of the field in the custom entity type definition. More...
 
Object Value [get, set]
 The value for the field. More...
 
DateTimeOffset? EffectiveFrom [get, set]
 The effective datetime from which the field's value is valid. For timeVariant fields, this defaults to the beginning of time. More...
 
DateTimeOffset? EffectiveUntil [get, set]
 The effective datetime until which the field's value is valid. If not supplied, the value will be valid indefinitely or until the next “effectiveFrom” date of the field. More...
 

Detailed Description

CustomEntityField

Constructor & Destructor Documentation

◆ CustomEntityField() [1/2]

Lusid.Sdk.Model.CustomEntityField.CustomEntityField ( )
inlineprotected

Initializes a new instance of the CustomEntityField class.

◆ CustomEntityField() [2/2]

Lusid.Sdk.Model.CustomEntityField.CustomEntityField ( string  name = default(string),
Object  value = default(Object),
DateTimeOffset?  effectiveFrom = default(DateTimeOffset?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?) 
)
inline

Initializes a new instance of the CustomEntityField class.

Parameters
nameThe name of the field in the custom entity type definition. (required).
valueThe value for the field..
effectiveFromThe effective datetime from which the field's value is valid. For timeVariant fields, this defaults to the beginning of time..
effectiveUntilThe effective datetime until which the field's value is valid. If not supplied, the value will be valid indefinitely or until the next “effectiveFrom” date of the field..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if CustomEntityField instances are equal

Parameters
inputInstance of CustomEntityField to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ EffectiveFrom

DateTimeOffset? Lusid.Sdk.Model.CustomEntityField.EffectiveFrom
getset

The effective datetime from which the field's value is valid. For timeVariant fields, this defaults to the beginning of time.

The effective datetime from which the field's value is valid. For timeVariant fields, this defaults to the beginning of time.

◆ EffectiveUntil

DateTimeOffset? Lusid.Sdk.Model.CustomEntityField.EffectiveUntil
getset

The effective datetime until which the field's value is valid. If not supplied, the value will be valid indefinitely or until the next “effectiveFrom” date of the field.

The effective datetime until which the field's value is valid. If not supplied, the value will be valid indefinitely or until the next “effectiveFrom” date of the field.

◆ Name

string Lusid.Sdk.Model.CustomEntityField.Name
getset

The name of the field in the custom entity type definition.

The name of the field in the custom entity type definition.

◆ Value

Object Lusid.Sdk.Model.CustomEntityField.Value
getset

The value for the field.

The value for the field.


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