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

CreateDataTypeRequest More...

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

Public Types

enum class  TypeValueRangeEnum { Open = 1 , Closed = 2 }
 Indicates the range of data acceptable by a data type. The available values are: Open, Closed More...
 
enum class  ValueTypeEnum {
  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 expected type of the values. 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...
 
enum class  UnitSchemaEnum { NoUnits = 1 , Basic = 2 , Iso4217Currency = 3 }
 The schema of the data type's units. The available values are: NoUnits, Basic, Iso4217Currency More...
 

Public Member Functions

 CreateDataTypeRequest (string scope=default(string), string code=default(string), TypeValueRangeEnum typeValueRange=default(TypeValueRangeEnum), string displayName=default(string), string description=default(string), ValueTypeEnum valueType=default(ValueTypeEnum), List< string > acceptableValues=default(List< string >), UnitSchemaEnum? unitSchema=default(UnitSchemaEnum?), List< CreateUnitDefinition > acceptableUnits=default(List< CreateUnitDefinition >), ReferenceData referenceData=default(ReferenceData))
 Initializes a new instance of the CreateDataTypeRequest 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 (CreateDataTypeRequest input)
 Returns true if CreateDataTypeRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

TypeValueRangeEnum TypeValueRange [get, set]
 Indicates the range of data acceptable by a data type. The available values are: Open, Closed More...
 
ValueTypeEnum ValueType [get, set]
 The expected type of the values. 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...
 
UnitSchemaEnumUnitSchema [get, set]
 The schema of the data type&#39;s units. The available values are: NoUnits, Basic, Iso4217Currency More...
 
string Scope [get, set]
 The scope that the data type will be created in. More...
 
string Code [get, set]
 The code of the data type. Together with the scope this uniquely defines the data type. More...
 
string DisplayName [get, set]
 The display name of the data type. More...
 
string Description [get, set]
 The description of the data type. More...
 
List< string > AcceptableValues [get, set]
 The acceptable set of values for this data type. Only applies to &#39;open&#39; value type range. More...
 
List< CreateUnitDefinitionAcceptableUnits [get, set]
 The definitions of the acceptable units. More...
 
ReferenceData ReferenceData [get, set]
 Gets or Sets ReferenceData More...
 

Detailed Description

CreateDataTypeRequest

Member Enumeration Documentation

◆ TypeValueRangeEnum

Indicates the range of data acceptable by a data type. The available values are: Open, Closed

Indicates the range of data acceptable by a data type. The available values are: Open, Closed

Enumerator
Open 

Enum Open for value: Open

Closed 

Enum Closed for value: Closed

◆ UnitSchemaEnum

The schema of the data type&#39;s units. The available values are: NoUnits, Basic, Iso4217Currency

The schema of the data type&#39;s units. The available values are: NoUnits, Basic, Iso4217Currency

Enumerator
NoUnits 

Enum NoUnits for value: NoUnits

Basic 

Enum Basic for value: Basic

Iso4217Currency 

Enum Iso4217Currency for value: Iso4217Currency

◆ ValueTypeEnum

The expected type of the values. 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 expected type of the values. 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

◆ CreateDataTypeRequest() [1/2]

Lusid.Sdk.Model.CreateDataTypeRequest.CreateDataTypeRequest ( )
inlineprotected

Initializes a new instance of the CreateDataTypeRequest class.

◆ CreateDataTypeRequest() [2/2]

Lusid.Sdk.Model.CreateDataTypeRequest.CreateDataTypeRequest ( string  scope = default(string),
string  code = default(string),
TypeValueRangeEnum  typeValueRange = default(TypeValueRangeEnum),
string  displayName = default(string),
string  description = default(string),
ValueTypeEnum  valueType = default(ValueTypeEnum),
List< string >  acceptableValues = default(List<string>),
UnitSchemaEnum unitSchema = default(UnitSchemaEnum?),
List< CreateUnitDefinition acceptableUnits = default(List<CreateUnitDefinition>),
ReferenceData  referenceData = default(ReferenceData) 
)
inline

Initializes a new instance of the CreateDataTypeRequest class.

Parameters
scopeThe scope that the data type will be created in. (required).
codeThe code of the data type. Together with the scope this uniquely defines the data type. (required).
typeValueRangeIndicates the range of data acceptable by a data type. The available values are: Open, Closed (required).
displayNameThe display name of the data type. (required).
descriptionThe description of the data type. (required).
valueTypeThe expected type of the values. 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 (required).
acceptableValuesThe acceptable set of values for this data type. Only applies to &#39;open&#39; value type range..
unitSchemaThe schema of the data type&#39;s units. The available values are: NoUnits, Basic, Iso4217Currency.
acceptableUnitsThe definitions of the acceptable units..
referenceDatareferenceData.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if CreateDataTypeRequest instances are equal

Parameters
inputInstance of CreateDataTypeRequest to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AcceptableUnits

List<CreateUnitDefinition> Lusid.Sdk.Model.CreateDataTypeRequest.AcceptableUnits
getset

The definitions of the acceptable units.

The definitions of the acceptable units.

◆ AcceptableValues

List<string> Lusid.Sdk.Model.CreateDataTypeRequest.AcceptableValues
getset

The acceptable set of values for this data type. Only applies to &#39;open&#39; value type range.

The acceptable set of values for this data type. Only applies to &#39;open&#39; value type range.

◆ Code

string Lusid.Sdk.Model.CreateDataTypeRequest.Code
getset

The code of the data type. Together with the scope this uniquely defines the data type.

The code of the data type. Together with the scope this uniquely defines the data type.

◆ Description

string Lusid.Sdk.Model.CreateDataTypeRequest.Description
getset

The description of the data type.

The description of the data type.

◆ DisplayName

string Lusid.Sdk.Model.CreateDataTypeRequest.DisplayName
getset

The display name of the data type.

The display name of the data type.

◆ ReferenceData

ReferenceData Lusid.Sdk.Model.CreateDataTypeRequest.ReferenceData
getset

Gets or Sets ReferenceData

◆ Scope

string Lusid.Sdk.Model.CreateDataTypeRequest.Scope
getset

The scope that the data type will be created in.

The scope that the data type will be created in.

◆ TypeValueRange

TypeValueRangeEnum Lusid.Sdk.Model.CreateDataTypeRequest.TypeValueRange
getset

Indicates the range of data acceptable by a data type. The available values are: Open, Closed

Indicates the range of data acceptable by a data type. The available values are: Open, Closed

◆ UnitSchema

UnitSchemaEnum? Lusid.Sdk.Model.CreateDataTypeRequest.UnitSchema
getset

The schema of the data type&#39;s units. The available values are: NoUnits, Basic, Iso4217Currency

The schema of the data type&#39;s units. The available values are: NoUnits, Basic, Iso4217Currency

◆ ValueType

ValueTypeEnum Lusid.Sdk.Model.CreateDataTypeRequest.ValueType
getset

The expected type of the values. 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 expected type of the values. 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: