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

graphscope/flex/rest/models/start_service_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,7 +18,7 @@ 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
@@ -27,14 +27,14 @@ class StartServiceRequest(BaseModel):
     """
     StartServiceRequest
     """ # noqa: E501
-    graph_name: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["graph_name"]
+    graph_id: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["graph_id"]
 
-    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:
@@ -81,7 +81,7 @@ class StartServiceRequest(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "graph_name": obj.get("graph_name")
+            "graph_id": obj.get("graph_id")
         })
         return _obj
 

graphscope/flex/rest/models/{groot_graph.py → stored_procedure_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,40 +18,39 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, Field, StrictBool, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
-from graphscope.flex.rest.models.groot_graph_gremlin_interface import GrootGraphGremlinInterface
-from graphscope.flex.rest.models.groot_schema import GrootSchema
+from graphscope.flex.rest.models.parameter import Parameter
 from typing import Optional, Set
 from typing_extensions import Self
 
-class GrootGraph(BaseModel):
+class StoredProcedureMeta(BaseModel):
     """
-    GrootGraph
+    StoredProcedureMeta
     """ # noqa: E501
-    name: Optional[StrictStr] = None
-    type: Optional[StrictStr] = None
-    directed: Optional[StrictBool] = None
-    creation_time: Optional[StrictStr] = None
-    var_schema: Optional[GrootSchema] = Field(default=None, alias="schema")
-    gremlin_interface: Optional[GrootGraphGremlinInterface] = None
-    __properties: ClassVar[List[str]] = ["name", "type", "directed", "creation_time", "schema", "gremlin_interface"]
+    name: StrictStr
+    description: Optional[StrictStr] = None
+    type: StrictStr
+    query: StrictStr
+    id: StrictStr
+    library: StrictStr
+    params: List[Parameter]
+    returns: List[Parameter]
+    option: Optional[Dict[str, Any]] = None
+    __properties: ClassVar[List[str]] = ["name", "description", "type", "query", "id", "library", "params", "returns", "option"]
 
     @field_validator('type')
     def type_validate_enum(cls, value):
         """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['GrootGraph']):
-            raise ValueError("must be one of enum values ('GrootGraph')")
+        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:
@@ -65,7 +64,7 @@ class GrootGraph(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of GrootGraph from a JSON string"""
+        """Create an instance of StoredProcedureMeta from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -86,17 +85,25 @@ class GrootGraph(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of var_schema
-        if self.var_schema:
-            _dict['schema'] = self.var_schema.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of gremlin_interface
-        if self.gremlin_interface:
-            _dict['gremlin_interface'] = self.gremlin_interface.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in params (list)
+        _items = []
+        if self.params:
+            for _item_params in self.params:
+                if _item_params:
+                    _items.append(_item_params.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_returns in self.returns:
+                if _item_returns:
+                    _items.append(_item_returns.to_dict())
+            _dict['returns'] = _items
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of GrootGraph from a dict"""
+        """Create an instance of StoredProcedureMeta from a dict"""
         if obj is None:
             return None
 
@@ -105,11 +112,14 @@ class GrootGraph(BaseModel):
 
         _obj = cls.model_validate({
             "name": obj.get("name"),
+            "description": obj.get("description"),
             "type": obj.get("type"),
-            "directed": obj.get("directed"),
-            "creation_time": obj.get("creation_time"),
-            "schema": GrootSchema.from_dict(obj["schema"]) if obj.get("schema") is not None else None,
-            "gremlin_interface": GrootGraphGremlinInterface.from_dict(obj["gremlin_interface"]) if obj.get("gremlin_interface") is not None else None
+            "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,
+            "option": obj.get("option")
         })
         return _obj
 

graphscope/flex/rest/models/string_type.py

@@ -0,0 +1,92 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from graphscope.flex.rest.models.string_type_string import StringTypeString
+from typing import Optional, Set
+from typing_extensions import Self
+
+class StringType(BaseModel):
+    """
+    StringType
+    """ # noqa: E501
+    string: StringTypeString
+    __properties: ClassVar[List[str]] = ["string"]
+
+    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 StringType 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 string
+        if self.string:
+            _dict['string'] = self.string.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of StringType from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "string": StringTypeString.from_dict(obj["string"]) if obj.get("string") is not None else None
+        })
+        return _obj
+
+

graphscope/flex/rest/models/string_type_string.py

@@ -0,0 +1,124 @@
+# 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 json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from graphscope.flex.rest.models.long_text import LongText
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+STRINGTYPESTRING_ONE_OF_SCHEMAS = ["LongText"]
+
+class StringTypeString(BaseModel):
+    """
+    StringTypeString
+    """
+    # data type: LongText
+    oneof_schema_1_validator: Optional[LongText] = None
+    actual_instance: Optional[Union[LongText]] = None
+    one_of_schemas: Set[str] = { "LongText" }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = StringTypeString.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: LongText
+        if not isinstance(v, LongText):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `LongText`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in StringTypeString with oneOf schemas: LongText. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in StringTypeString with oneOf schemas: LongText. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # deserialize data into LongText
+        try:
+            instance.actual_instance = LongText.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when deserializing the JSON string into StringTypeString with oneOf schemas: LongText. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into StringTypeString with oneOf schemas: LongText. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], LongText]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

graphscope/flex/rest/models/temporal_type.py

@@ -0,0 +1,92 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from graphscope.flex.rest.models.temporal_type_temporal import TemporalTypeTemporal
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TemporalType(BaseModel):
+    """
+    TemporalType
+    """ # noqa: E501
+    temporal: TemporalTypeTemporal
+    __properties: ClassVar[List[str]] = ["temporal"]
+
+    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 TemporalType 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 temporal
+        if self.temporal:
+            _dict['temporal'] = self.temporal.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TemporalType from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "temporal": TemporalTypeTemporal.from_dict(obj["temporal"]) if obj.get("temporal") is not None else None
+        })
+        return _obj
+
+

graphscope/flex/rest/models/temporal_type_temporal.py

@@ -0,0 +1,138 @@
+# 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 json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from graphscope.flex.rest.models.date_type import DateType
+from graphscope.flex.rest.models.time_stamp_type import TimeStampType
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+TEMPORALTYPETEMPORAL_ONE_OF_SCHEMAS = ["DateType", "TimeStampType"]
+
+class TemporalTypeTemporal(BaseModel):
+    """
+    TemporalTypeTemporal
+    """
+    # data type: TimeStampType
+    oneof_schema_1_validator: Optional[TimeStampType] = None
+    # data type: DateType
+    oneof_schema_2_validator: Optional[DateType] = None
+    actual_instance: Optional[Union[DateType, TimeStampType]] = None
+    one_of_schemas: Set[str] = { "DateType", "TimeStampType" }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = TemporalTypeTemporal.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: TimeStampType
+        if not isinstance(v, TimeStampType):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TimeStampType`")
+        else:
+            match += 1
+        # validate data type: DateType
+        if not isinstance(v, DateType):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `DateType`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in TemporalTypeTemporal with oneOf schemas: DateType, TimeStampType. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in TemporalTypeTemporal with oneOf schemas: DateType, TimeStampType. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # deserialize data into TimeStampType
+        try:
+            instance.actual_instance = TimeStampType.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into DateType
+        try:
+            instance.actual_instance = DateType.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when deserializing the JSON string into TemporalTypeTemporal with oneOf schemas: DateType, TimeStampType. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into TemporalTypeTemporal with oneOf schemas: DateType, TimeStampType. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], DateType, TimeStampType]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+