Source code for sdk.lusid.models.field_schema

# coding: utf-8

"""
    LUSID API

    FINBOURNE Technology  # noqa: E501

    Contact: info@finbourne.com
    Generated by OpenAPI Generator (https://openapi-generator.tech)

    Do not edit the class manually.
"""


from __future__ import annotations
import pprint
import re  # noqa: F401
import json


from typing import Any, Dict, Optional
from pydantic.v1 import BaseModel, Field, StrictInt, StrictStr, validator
from lusid.models.resource_id import ResourceId

[docs] class FieldSchema(BaseModel): """ FieldSchema """ id: Optional[ResourceId] = None display_name: Optional[StrictStr] = Field(None, alias="displayName") description: Optional[StrictStr] = None type: Optional[StrictStr] = Field(None, description="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") display_order: Optional[StrictInt] = Field(None, alias="displayOrder") __properties = ["id", "displayName", "description", "type", "displayOrder"]
[docs] @validator('type') def type_validate_enum(cls, value): """Validates the enum""" if value is None: return value if value not in ('String', 'Int', 'Decimal', 'DateTime', 'Boolean', 'Map', 'List', 'PropertyArray', 'Percentage', 'Code', 'Id', 'Uri', 'CurrencyAndAmount', 'TradePrice', 'Currency', 'MetricValue', 'ResourceId', 'ResultValue', 'CutLocalTime', 'DateOrCutLabel', 'UnindexedText'): raise ValueError("must be one of enum values ('String', 'Int', 'Decimal', 'DateTime', 'Boolean', 'Map', 'List', 'PropertyArray', 'Percentage', 'Code', 'Id', 'Uri', 'CurrencyAndAmount', 'TradePrice', 'Currency', 'MetricValue', 'ResourceId', 'ResultValue', 'CutLocalTime', 'DateOrCutLabel', 'UnindexedText')") return value
[docs] class Config: """Pydantic configuration""" allow_population_by_field_name = True validate_assignment = True
[docs] def to_str(self) -> str: """Returns the string representation of the model using alias""" return pprint.pformat(self.dict(by_alias=True))
[docs] def to_json(self) -> str: """Returns the JSON representation of the model using alias""" return json.dumps(self.to_dict())
[docs] @classmethod def from_json(cls, json_str: str) -> FieldSchema: """Create an instance of FieldSchema from a JSON string""" return cls.from_dict(json.loads(json_str))
[docs] def to_dict(self): """Returns the dictionary representation of the model using alias""" _dict = self.dict(by_alias=True, exclude={ }, exclude_none=True) # override the default output from pydantic by calling `to_dict()` of id if self.id: _dict['id'] = self.id.to_dict() # set to None if display_name (nullable) is None # and __fields_set__ contains the field if self.display_name is None and "display_name" in self.__fields_set__: _dict['displayName'] = None # set to None if description (nullable) is None # and __fields_set__ contains the field if self.description is None and "description" in self.__fields_set__: _dict['description'] = None return _dict
[docs] @classmethod def from_dict(cls, obj: dict) -> FieldSchema: """Create an instance of FieldSchema from a dict""" if obj is None: return None if not isinstance(obj, dict): return FieldSchema.parse_obj(obj) _obj = FieldSchema.parse_obj({ "id": ResourceId.from_dict(obj.get("id")) if obj.get("id") is not None else None, "display_name": obj.get("displayName"), "description": obj.get("description"), "type": obj.get("type"), "display_order": obj.get("displayOrder") }) return _obj