Lusid.Sdk.Model.CustomEntityFieldDefinition Class Reference

CustomEntityFieldDefinition More...

Inheritance diagram for Lusid.Sdk.Model.CustomEntityFieldDefinition:

Public Member Functions
	CustomEntityFieldDefinition (string name=default(string), string lifetime=default(string), string type=default(string), string collectionType=default(string), bool required=default(bool), string description=default(string))
	Initializes a new instance of the CustomEntityFieldDefinition 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 (CustomEntityFieldDefinition input)
	Returns true if CustomEntityFieldDefinition instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	CustomEntityFieldDefinition ()
	Initializes a new instance of the CustomEntityFieldDefinition class. More...

Properties
string	Name [get, set]
	The name of the field. More...
string	Lifetime [get, set]
	Describes how the field’s values can change over time. The available values are: “Perpetual”, “TimeVariant”. More...
string	Type [get, set]
	The value type for the field. Available values are: “String”, “Boolean”, “DateTime”, “Decimal”. More...
string	CollectionType [get, set]
	The collection type for the field. Available values are: “Single”, “Array”. Null value defaults to “Single” More...
bool	Required [get, set]
	Whether the field is required or not. More...
string	Description [get, set]
	An optional description for the field. More...

Detailed Description

CustomEntityFieldDefinition

Constructor & Destructor Documentation

CustomEntityFieldDefinition() [1/2]

Lusid.Sdk.Model.CustomEntityFieldDefinition.CustomEntityFieldDefinition ( )

inlineprotected

Initializes a new instance of the CustomEntityFieldDefinition class.

CustomEntityFieldDefinition() [2/2]

Lusid.Sdk.Model.CustomEntityFieldDefinition.CustomEntityFieldDefinition ( string  name = default(string), string  lifetime = default(string), string  type = default(string), string  collectionType = default(string), bool  required = default(bool), string  description = default(string)  )

inline

Initializes a new instance of the CustomEntityFieldDefinition class.

Parameters

name	The name of the field. (required).
lifetime	Describes how the field’s values can change over time. The available values are: “Perpetual”, “TimeVariant”. (required).
type	The value type for the field. Available values are: “String”, “Boolean”, “DateTime”, “Decimal”. (required).
collectionType	The collection type for the field. Available values are: “Single”, “Array”. Null value defaults to “Single”.
required	Whether the field is required or not. (required).
description	An optional description for the field..

Member Function Documentation

Equals() [1/2]

bool Lusid.Sdk.Model.CustomEntityFieldDefinition.Equals ( CustomEntityFieldDefinition  input )

inline

Returns true if CustomEntityFieldDefinition instances are equal

Parameters

input

Instance of CustomEntityFieldDefinition to be compared

Returns

Boolean

Equals() [2/2]

override bool Lusid.Sdk.Model.CustomEntityFieldDefinition.Equals ( object  input )

inline

Returns true if objects are equal

Parameters

input

Object to be compared

Returns

Boolean

GetHashCode()

override int Lusid.Sdk.Model.CustomEntityFieldDefinition.GetHashCode ( )

inline

Gets the hash code

Returns

Hash code

ToJson()

virtual string Lusid.Sdk.Model.CustomEntityFieldDefinition.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

override string Lusid.Sdk.Model.CustomEntityFieldDefinition.ToString ( )

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

CollectionType

string Lusid.Sdk.Model.CustomEntityFieldDefinition.CollectionType

getset

The collection type for the field. Available values are: “Single”, “Array”. Null value defaults to “Single”

The collection type for the field. Available values are: “Single”, “Array”. Null value defaults to “Single”

Description

string Lusid.Sdk.Model.CustomEntityFieldDefinition.Description

getset

An optional description for the field.

An optional description for the field.

Lifetime

string Lusid.Sdk.Model.CustomEntityFieldDefinition.Lifetime

getset

Describes how the field’s values can change over time. The available values are: “Perpetual”, “TimeVariant”.

Describes how the field’s values can change over time. The available values are: “Perpetual”, “TimeVariant”.

Name

string Lusid.Sdk.Model.CustomEntityFieldDefinition.Name

getset

The name of the field.

The name of the field.

Required

bool Lusid.Sdk.Model.CustomEntityFieldDefinition.Required

getset

Whether the field is required or not.

Whether the field is required or not.

Type

string Lusid.Sdk.Model.CustomEntityFieldDefinition.Type

getset

The value type for the field. Available values are: “String”, “Boolean”, “DateTime”, “Decimal”.

The value type for the field. Available values are: “String”, “Boolean”, “DateTime”, “Decimal”.

---

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/CustomEntityFieldDefinition.cs