graphscope-flex 0.27.0__py2.py3-none-any.whl → 0.29.0a20250114__py2.py3-none-any.whl

graphscope/flex/rest/models/{groot_vertex_type.py → create_property_meta.py}

@@ -3,9 +3,9 @@
 """
     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)
+    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/).
 
-    The version of the OpenAPI document: 0.9.1
+    The version of the OpenAPI document: 1.0.0
     Contact: graphscope@alibaba-inc.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,25 +18,28 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, StrictStr
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from graphscope.flex.rest.models.groot_property import GrootProperty
+from graphscope.flex.rest.models.gs_data_type import GSDataType
 from typing import Optional, Set
 from typing_extensions import Self
 
-class GrootVertexType(BaseModel):
+class CreatePropertyMeta(BaseModel):
     """
-    GrootVertexType
+    CreatePropertyMeta
     """ # noqa: E501
-    label: Optional[StrictStr] = None
-    properties: Optional[List[GrootProperty]] = None
-    __properties: ClassVar[List[str]] = ["label", "properties"]
+    property_name: StrictStr
+    property_type: GSDataType
+    nullable: Optional[StrictBool] = None
+    default_value: Optional[Any] = None
+    description: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["property_name", "property_type", "nullable", "default_value", "description"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True,
-        "protected_namespaces": (),
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -50,7 +53,7 @@ class GrootVertexType(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of GrootVertexType from a JSON string"""
+        """Create an instance of CreatePropertyMeta from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -71,18 +74,19 @@ class GrootVertexType(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # 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
+        # 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()
+        # set to None if default_value (nullable) is None
+        # and model_fields_set contains the field
+        if self.default_value is None and "default_value" in self.model_fields_set:
+            _dict['default_value'] = None
+
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of GrootVertexType from a dict"""
+        """Create an instance of CreatePropertyMeta from a dict"""
         if obj is None:
             return None
 
@@ -90,8 +94,11 @@ class GrootVertexType(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "label": obj.get("label"),
-            "properties": [GrootProperty.from_dict(_item) for _item in obj["properties"]] if obj.get("properties") is not None else None
+            "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")
         })
         return _obj
 

graphscope/flex/rest/models/{graph_stored_procedures.py → create_stored_proc_request.py}

@@ -3,9 +3,9 @@
 """
     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)
+    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/).
 
-    The version of the OpenAPI document: 0.9.1
+    The version of the OpenAPI document: 1.0.0
     Contact: graphscope@alibaba-inc.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,33 +18,33 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
-class GraphStoredProcedures(BaseModel):
+class CreateStoredProcRequest(BaseModel):
     """
-    GraphStoredProcedures
+    CreateStoredProcRequest
     """ # noqa: E501
-    directory: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["directory"]
-
-    @field_validator('directory')
-    def directory_validate_enum(cls, value):
+    name: StrictStr
+    description: Optional[StrictStr] = None
+    type: StrictStr
+    query: StrictStr
+    __properties: ClassVar[List[str]] = ["name", "description", "type", "query"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
         """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['plugins']):
-            raise ValueError("must be one of enum values ('plugins')")
+        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": (),
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -58,7 +58,7 @@ class GraphStoredProcedures(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of GraphStoredProcedures from a JSON string"""
+        """Create an instance of CreateStoredProcRequest from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -83,7 +83,7 @@ class GraphStoredProcedures(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of GraphStoredProcedures from a dict"""
+        """Create an instance of CreateStoredProcRequest from a dict"""
         if obj is None:
             return None
 
@@ -91,7 +91,10 @@ class GraphStoredProcedures(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "directory": obj.get("directory")
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "type": obj.get("type"),
+            "query": obj.get("query")
         })
         return _obj
 

graphscope/flex/rest/models/create_stored_proc_response.py

@@ -0,0 +1,88 @@
+# 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/).
+
+    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, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateStoredProcResponse(BaseModel):
+    """
+    CreateStoredProcResponse
+    """ # noqa: E501
+    stored_procedure_id: StrictStr
+    __properties: ClassVar[List[str]] = ["stored_procedure_id"]
+
+    model_config = ConfigDict(
+        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 CreateStoredProcResponse 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateStoredProcResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "stored_procedure_id": obj.get("stored_procedure_id")
+        })
+        return _obj
+
+

graphscope/flex/rest/models/create_vertex_type.py

@@ -0,0 +1,108 @@
+# 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/).
+
+    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, ConfigDict, 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.create_property_meta import CreatePropertyMeta
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateVertexType(BaseModel):
+    """
+    CreateVertexType
+    """ # noqa: E501
+    type_name: StrictStr
+    primary_keys: List[StrictStr]
+    x_csr_params: Optional[BaseVertexTypeXCsrParams] = None
+    properties: List[CreatePropertyMeta]
+    description: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["type_name", "primary_keys", "x_csr_params", "properties", "description"]
+
+    model_config = ConfigDict(
+        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 CreateVertexType 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_properties in self.properties:
+                if _item_properties:
+                    _items.append(_item_properties.to_dict())
+            _dict['properties'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateVertexType 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,
+            "properties": [CreatePropertyMeta.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/{groot_dataloading_job_config.py → dataloading_job_config.py}

@@ -3,9 +3,9 @@
 """
     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)
+    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/).
 
-    The version of the OpenAPI document: 0.9.1
+    The version of the OpenAPI document: 1.0.0
     Contact: graphscope@alibaba-inc.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,21 +18,24 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, Field, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
-from graphscope.flex.rest.models.groot_dataloading_job_config_edges_inner import GrootDataloadingJobConfigEdgesInner
+from graphscope.flex.rest.models.dataloading_job_config_edges_inner import DataloadingJobConfigEdgesInner
+from graphscope.flex.rest.models.dataloading_job_config_loading_config import DataloadingJobConfigLoadingConfig
+from graphscope.flex.rest.models.dataloading_job_config_vertices_inner import DataloadingJobConfigVerticesInner
 from typing import Optional, Set
 from typing_extensions import Self
 
-class GrootDataloadingJobConfig(BaseModel):
+class DataloadingJobConfig(BaseModel):
     """
-    GrootDataloadingJobConfig
+    DataloadingJobConfig
     """ # noqa: E501
-    vertices: Optional[List[StrictStr]] = None
-    edges: Optional[List[GrootDataloadingJobConfigEdgesInner]] = None
+    loading_config: DataloadingJobConfigLoadingConfig
+    vertices: List[DataloadingJobConfigVerticesInner]
+    edges: List[DataloadingJobConfigEdgesInner]
     schedule: Optional[StrictStr] = Field(default=None, description="format with '2023-02-21 11:56:30'")
     repeat: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["vertices", "edges", "schedule", "repeat"]
+    __properties: ClassVar[List[str]] = ["loading_config", "vertices", "edges", "schedule", "repeat"]
 
     @field_validator('repeat')
     def repeat_validate_enum(cls, value):
@@ -44,11 +47,11 @@ class GrootDataloadingJobConfig(BaseModel):
             raise ValueError("must be one of enum values ('once', 'day', 'week')")
         return value
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True,
-        "protected_namespaces": (),
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -62,7 +65,7 @@ class GrootDataloadingJobConfig(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of GrootDataloadingJobConfig from a JSON string"""
+        """Create an instance of DataloadingJobConfig from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -83,18 +86,38 @@ class GrootDataloadingJobConfig(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of loading_config
+        if self.loading_config:
+            _dict['loading_config'] = self.loading_config.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in vertices (list)
+        _items = []
+        if self.vertices:
+            for _item_vertices in self.vertices:
+                if _item_vertices:
+                    _items.append(_item_vertices.to_dict())
+            _dict['vertices'] = _items
         # override the default output from pydantic by calling `to_dict()` of each item in edges (list)
         _items = []
         if self.edges:
-            for _item in self.edges:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_edges in self.edges:
+                if _item_edges:
+                    _items.append(_item_edges.to_dict())
             _dict['edges'] = _items
+        # set to None if schedule (nullable) is None
+        # and model_fields_set contains the field
+        if self.schedule is None and "schedule" in self.model_fields_set:
+            _dict['schedule'] = None
+
+        # set to None if repeat (nullable) is None
+        # and model_fields_set contains the field
+        if self.repeat is None and "repeat" in self.model_fields_set:
+            _dict['repeat'] = None
+
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of GrootDataloadingJobConfig from a dict"""
+        """Create an instance of DataloadingJobConfig from a dict"""
         if obj is None:
             return None
 
@@ -102,8 +125,9 @@ class GrootDataloadingJobConfig(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "vertices": obj.get("vertices"),
-            "edges": [GrootDataloadingJobConfigEdgesInner.from_dict(_item) for _item in obj["edges"]] if obj.get("edges") is not None else None,
+            "loading_config": DataloadingJobConfigLoadingConfig.from_dict(obj["loading_config"]) if obj.get("loading_config") is not None else None,
+            "vertices": [DataloadingJobConfigVerticesInner.from_dict(_item) for _item in obj["vertices"]] if obj.get("vertices") is not None else None,
+            "edges": [DataloadingJobConfigEdgesInner.from_dict(_item) for _item in obj["edges"]] if obj.get("edges") is not None else None,
             "schedule": obj.get("schedule"),
             "repeat": obj.get("repeat")
         })

graphscope/flex/rest/models/{groot_dataloading_job_config_edges_inner.py → dataloading_job_config_edges_inner.py}

@@ -3,9 +3,9 @@
 """
     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)
+    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/).
 
-    The version of the OpenAPI document: 0.9.1
+    The version of the OpenAPI document: 1.0.0
     Contact: graphscope@alibaba-inc.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,25 +18,25 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, StrictStr
+from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
-class GrootDataloadingJobConfigEdgesInner(BaseModel):
+class DataloadingJobConfigEdgesInner(BaseModel):
     """
-    GrootDataloadingJobConfigEdgesInner
+    DataloadingJobConfigEdgesInner
     """ # noqa: E501
     type_name: Optional[StrictStr] = None
     source_vertex: Optional[StrictStr] = None
     destination_vertex: Optional[StrictStr] = None
     __properties: ClassVar[List[str]] = ["type_name", "source_vertex", "destination_vertex"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True,
-        "protected_namespaces": (),
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -50,7 +50,7 @@ class GrootDataloadingJobConfigEdgesInner(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of GrootDataloadingJobConfigEdgesInner from a JSON string"""
+        """Create an instance of DataloadingJobConfigEdgesInner from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -75,7 +75,7 @@ class GrootDataloadingJobConfigEdgesInner(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of GrootDataloadingJobConfigEdgesInner from a dict"""
+        """Create an instance of DataloadingJobConfigEdgesInner from a dict"""
         if obj is None:
             return None