graphscope-flex 0.27.0__5-py2.py3-none-any.whl

graphscope/flex/rest/models/get_edge_type.py

@@ -0,0 +1,116 @@
+# coding: utf-8
+
+"""
+    GraphScope FLEX HTTP SERVICE API
+
+    This is a specification for GraphScope FLEX HTTP service based on the OpenAPI 3.0 specification. You can find out more details about specification at [doc](https://swagger.io/specification/v3/).  Some useful links: - [GraphScope Repository](https://github.com/alibaba/GraphScope) - [The Source API definition for GraphScope Interactive](https://github.com/GraphScope/portal/tree/main/httpservice)
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: graphscope@alibaba-inc.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from graphscope.flex.rest.models.base_edge_type_vertex_type_pair_relations_inner import BaseEdgeTypeVertexTypePairRelationsInner
+from graphscope.flex.rest.models.get_property_meta import GetPropertyMeta
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetEdgeType(BaseModel):
+    """
+    GetEdgeType
+    """ # noqa: E501
+    type_name: StrictStr
+    vertex_type_pair_relations: List[BaseEdgeTypeVertexTypePairRelationsInner]
+    directed: Optional[StrictBool] = None
+    primary_keys: Optional[List[StrictStr]] = None
+    type_id: StrictInt
+    properties: Optional[List[GetPropertyMeta]] = None
+    description: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["type_name", "vertex_type_pair_relations", "directed", "primary_keys", "type_id", "properties", "description"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of GetEdgeType from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in vertex_type_pair_relations (list)
+        _items = []
+        if self.vertex_type_pair_relations:
+            for _item in self.vertex_type_pair_relations:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['vertex_type_pair_relations'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in properties (list)
+        _items = []
+        if self.properties:
+            for _item in self.properties:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['properties'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetEdgeType from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type_name": obj.get("type_name"),
+            "vertex_type_pair_relations": [BaseEdgeTypeVertexTypePairRelationsInner.from_dict(_item) for _item in obj["vertex_type_pair_relations"]] if obj.get("vertex_type_pair_relations") is not None else None,
+            "directed": obj.get("directed"),
+            "primary_keys": obj.get("primary_keys"),
+            "type_id": obj.get("type_id"),
+            "properties": [GetPropertyMeta.from_dict(_item) for _item in obj["properties"]] if obj.get("properties") is not None else None,
+            "description": obj.get("description")
+        })
+        return _obj
+
+

graphscope/flex/rest/models/get_graph_response.py

@@ -0,0 +1,126 @@
+# coding: utf-8
+
+"""
+    GraphScope FLEX HTTP SERVICE API
+
+    This is a specification for GraphScope FLEX HTTP service based on the OpenAPI 3.0 specification. You can find out more details about specification at [doc](https://swagger.io/specification/v3/).  Some useful links: - [GraphScope Repository](https://github.com/alibaba/GraphScope) - [The Source API definition for GraphScope Interactive](https://github.com/GraphScope/portal/tree/main/httpservice)
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: graphscope@alibaba-inc.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from graphscope.flex.rest.models.get_graph_schema_response import GetGraphSchemaResponse
+from graphscope.flex.rest.models.get_stored_proc_response import GetStoredProcResponse
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetGraphResponse(BaseModel):
+    """
+    GetGraphResponse
+    """ # noqa: E501
+    id: StrictStr
+    name: StrictStr
+    description: Optional[StrictStr] = None
+    store_type: Optional[StrictStr] = None
+    creation_time: StrictStr
+    data_update_time: StrictStr
+    schema_update_time: StrictStr
+    stored_procedures: Optional[List[GetStoredProcResponse]] = None
+    var_schema: GetGraphSchemaResponse = Field(alias="schema")
+    __properties: ClassVar[List[str]] = ["id", "name", "description", "store_type", "creation_time", "data_update_time", "schema_update_time", "stored_procedures", "schema"]
+
+    @field_validator('store_type')
+    def store_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['mutable_csr']):
+            raise ValueError("must be one of enum values ('mutable_csr')")
+        return value
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of GetGraphResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in stored_procedures (list)
+        _items = []
+        if self.stored_procedures:
+            for _item in self.stored_procedures:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['stored_procedures'] = _items
+        # override the default output from pydantic by calling `to_dict()` of var_schema
+        if self.var_schema:
+            _dict['schema'] = self.var_schema.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetGraphResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "store_type": obj.get("store_type"),
+            "creation_time": obj.get("creation_time"),
+            "data_update_time": obj.get("data_update_time"),
+            "schema_update_time": obj.get("schema_update_time"),
+            "stored_procedures": [GetStoredProcResponse.from_dict(_item) for _item in obj["stored_procedures"]] if obj.get("stored_procedures") is not None else None,
+            "schema": GetGraphSchemaResponse.from_dict(obj["schema"]) if obj.get("schema") is not None else None
+        })
+        return _obj
+
+

graphscope/flex/rest/models/get_graph_schema_response.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+    GraphScope FLEX HTTP SERVICE API
+
+    This is a specification for GraphScope FLEX HTTP service based on the OpenAPI 3.0 specification. You can find out more details about specification at [doc](https://swagger.io/specification/v3/).  Some useful links: - [GraphScope Repository](https://github.com/alibaba/GraphScope) - [The Source API definition for GraphScope Interactive](https://github.com/GraphScope/portal/tree/main/httpservice)
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: graphscope@alibaba-inc.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel
+from typing import Any, ClassVar, Dict, List
+from graphscope.flex.rest.models.get_edge_type import GetEdgeType
+from graphscope.flex.rest.models.get_vertex_type import GetVertexType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetGraphSchemaResponse(BaseModel):
+    """
+    GetGraphSchemaResponse
+    """ # noqa: E501
+    vertex_types: List[GetVertexType]
+    edge_types: List[GetEdgeType]
+    __properties: ClassVar[List[str]] = ["vertex_types", "edge_types"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of GetGraphSchemaResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in vertex_types (list)
+        _items = []
+        if self.vertex_types:
+            for _item in self.vertex_types:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['vertex_types'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in edge_types (list)
+        _items = []
+        if self.edge_types:
+            for _item in self.edge_types:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['edge_types'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetGraphSchemaResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "vertex_types": [GetVertexType.from_dict(_item) for _item in obj["vertex_types"]] if obj.get("vertex_types") is not None else None,
+            "edge_types": [GetEdgeType.from_dict(_item) for _item in obj["edge_types"]] if obj.get("edge_types") is not None else None
+        })
+        return _obj
+
+

graphscope/flex/rest/models/get_property_meta.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    GraphScope FLEX HTTP SERVICE API
+
+    This is a specification for GraphScope FLEX HTTP service based on the OpenAPI 3.0 specification. You can find out more details about specification at [doc](https://swagger.io/specification/v3/).  Some useful links: - [GraphScope Repository](https://github.com/alibaba/GraphScope) - [The Source API definition for GraphScope Interactive](https://github.com/GraphScope/portal/tree/main/httpservice)
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: graphscope@alibaba-inc.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from graphscope.flex.rest.models.gs_data_type import GSDataType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetPropertyMeta(BaseModel):
+    """
+    GetPropertyMeta
+    """ # noqa: E501
+    property_name: StrictStr
+    property_type: GSDataType
+    nullable: Optional[StrictBool] = None
+    default_value: Optional[Dict[str, Any]] = None
+    description: Optional[StrictStr] = None
+    property_id: StrictInt
+    __properties: ClassVar[List[str]] = ["property_name", "property_type", "nullable", "default_value", "description", "property_id"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of GetPropertyMeta from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of property_type
+        if self.property_type:
+            _dict['property_type'] = self.property_type.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetPropertyMeta from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "property_name": obj.get("property_name"),
+            "property_type": GSDataType.from_dict(obj["property_type"]) if obj.get("property_type") is not None else None,
+            "nullable": obj.get("nullable"),
+            "default_value": obj.get("default_value"),
+            "description": obj.get("description"),
+            "property_id": obj.get("property_id")
+        })
+        return _obj
+
+

graphscope/flex/rest/models/get_stored_proc_response.py

@@ -0,0 +1,128 @@
+# coding: utf-8
+
+"""
+    GraphScope FLEX HTTP SERVICE API
+
+    This is a specification for GraphScope FLEX HTTP service based on the OpenAPI 3.0 specification. You can find out more details about specification at [doc](https://swagger.io/specification/v3/).  Some useful links: - [GraphScope Repository](https://github.com/alibaba/GraphScope) - [The Source API definition for GraphScope Interactive](https://github.com/GraphScope/portal/tree/main/httpservice)
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: graphscope@alibaba-inc.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from graphscope.flex.rest.models.parameter import Parameter
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetStoredProcResponse(BaseModel):
+    """
+    GetStoredProcResponse
+    """ # noqa: E501
+    name: StrictStr
+    description: Optional[StrictStr] = None
+    type: StrictStr
+    query: StrictStr
+    id: StrictStr
+    library: StrictStr
+    params: List[Parameter]
+    returns: List[Parameter]
+    bound_graph: StrictStr
+    runnable: StrictBool
+    __properties: ClassVar[List[str]] = ["name", "description", "type", "query", "id", "library", "params", "returns", "bound_graph", "runnable"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['cpp', 'cypher']):
+            raise ValueError("must be one of enum values ('cpp', 'cypher')")
+        return value
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of GetStoredProcResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in params (list)
+        _items = []
+        if self.params:
+            for _item in self.params:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['params'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in returns (list)
+        _items = []
+        if self.returns:
+            for _item in self.returns:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['returns'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetStoredProcResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "type": obj.get("type"),
+            "query": obj.get("query"),
+            "id": obj.get("id"),
+            "library": obj.get("library"),
+            "params": [Parameter.from_dict(_item) for _item in obj["params"]] if obj.get("params") is not None else None,
+            "returns": [Parameter.from_dict(_item) for _item in obj["returns"]] if obj.get("returns") is not None else None,
+            "bound_graph": obj.get("bound_graph"),
+            "runnable": obj.get("runnable")
+        })
+        return _obj
+
+

graphscope/flex/rest/models/get_vertex_type.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    GraphScope FLEX HTTP SERVICE API
+
+    This is a specification for GraphScope FLEX HTTP service based on the OpenAPI 3.0 specification. You can find out more details about specification at [doc](https://swagger.io/specification/v3/).  Some useful links: - [GraphScope Repository](https://github.com/alibaba/GraphScope) - [The Source API definition for GraphScope Interactive](https://github.com/GraphScope/portal/tree/main/httpservice)
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: graphscope@alibaba-inc.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from graphscope.flex.rest.models.base_vertex_type_x_csr_params import BaseVertexTypeXCsrParams
+from graphscope.flex.rest.models.get_property_meta import GetPropertyMeta
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetVertexType(BaseModel):
+    """
+    GetVertexType
+    """ # noqa: E501
+    type_name: StrictStr
+    primary_keys: List[StrictStr]
+    x_csr_params: Optional[BaseVertexTypeXCsrParams] = None
+    type_id: StrictInt
+    properties: List[GetPropertyMeta]
+    description: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["type_name", "primary_keys", "x_csr_params", "type_id", "properties", "description"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of GetVertexType from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of x_csr_params
+        if self.x_csr_params:
+            _dict['x_csr_params'] = self.x_csr_params.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in properties (list)
+        _items = []
+        if self.properties:
+            for _item in self.properties:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['properties'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetVertexType from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type_name": obj.get("type_name"),
+            "primary_keys": obj.get("primary_keys"),
+            "x_csr_params": BaseVertexTypeXCsrParams.from_dict(obj["x_csr_params"]) if obj.get("x_csr_params") is not None else None,
+            "type_id": obj.get("type_id"),
+            "properties": [GetPropertyMeta.from_dict(_item) for _item in obj["properties"]] if obj.get("properties") is not None else None,
+            "description": obj.get("description")
+        })
+        return _obj
+
+