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

FieldSchema More...

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

Public Types

enum class  TypeEnum {
  String = 1 , Int = 2 , Decimal = 3 , DateTime = 4 ,
  Boolean = 5 , Map = 6 , List = 7 , PropertyArray = 8 ,
  Percentage = 9 , Code = 10 , Id = 11 , Uri = 12 ,
  CurrencyAndAmount = 13 , TradePrice = 14 , Currency = 15 , MetricValue = 16 ,
  ResourceId = 17 , ResultValue = 18 , CutLocalTime = 19 , DateOrCutLabel = 20 ,
  UnindexedText = 21
}
 The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText More...
 

Public Member Functions

 FieldSchema (ResourceId id=default(ResourceId), string displayName=default(string), string description=default(string), TypeEnum? type=default(TypeEnum?), int displayOrder=default(int))
 Initializes a new instance of the FieldSchema 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 (FieldSchema input)
 Returns true if FieldSchema instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Properties

TypeEnumType [get, set]
 The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText More...
 
ResourceId Id [get, set]
 Gets or Sets Id More...
 
string DisplayName [get, set]
 Gets or Sets DisplayName More...
 
string Description [get, set]
 Gets or Sets Description More...
 
int DisplayOrder [get, set]
 Gets or Sets DisplayOrder More...
 

Detailed Description

FieldSchema

Member Enumeration Documentation

◆ TypeEnum

The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText

The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText

Enumerator
String 

Enum String for value: String

Int 

Enum Int for value: Int

Decimal 

Enum Decimal for value: Decimal

DateTime 

Enum DateTime for value: DateTime

Boolean 

Enum Boolean for value: Boolean

Map 

Enum Map for value: Map

List 

Enum List for value: List

PropertyArray 

Enum PropertyArray for value: PropertyArray

Percentage 

Enum Percentage for value: Percentage

Code 

Enum Code for value: Code

Id 

Enum Id for value: Id

Uri 

Enum Uri for value: Uri

CurrencyAndAmount 

Enum CurrencyAndAmount for value: CurrencyAndAmount

TradePrice 

Enum TradePrice for value: TradePrice

Currency 

Enum Currency for value: Currency

MetricValue 

Enum MetricValue for value: MetricValue

ResourceId 

Enum ResourceId for value: ResourceId

ResultValue 

Enum ResultValue for value: ResultValue

CutLocalTime 

Enum CutLocalTime for value: CutLocalTime

DateOrCutLabel 

Enum DateOrCutLabel for value: DateOrCutLabel

UnindexedText 

Enum UnindexedText for value: UnindexedText

Constructor & Destructor Documentation

◆ FieldSchema()

Lusid.Sdk.Model.FieldSchema.FieldSchema ( ResourceId  id = default(ResourceId),
string  displayName = default(string),
string  description = default(string),
TypeEnum type = default(TypeEnum?),
int  displayOrder = default(int) 
)
inline

Initializes a new instance of the FieldSchema class.

Parameters
idid.
displayNamedisplayName.
descriptiondescription.
typeThe available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText.
displayOrderdisplayOrder.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if FieldSchema instances are equal

Parameters
inputInstance of FieldSchema to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Description

string Lusid.Sdk.Model.FieldSchema.Description
getset

Gets or Sets Description

◆ DisplayName

string Lusid.Sdk.Model.FieldSchema.DisplayName
getset

Gets or Sets DisplayName

◆ DisplayOrder

int Lusid.Sdk.Model.FieldSchema.DisplayOrder
getset

Gets or Sets DisplayOrder

◆ Id

ResourceId Lusid.Sdk.Model.FieldSchema.Id
getset

Gets or Sets Id

◆ Type

TypeEnum? Lusid.Sdk.Model.FieldSchema.Type
getset

The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText

The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText


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