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

graphscope/flex/rest/models/{groot_schema.py → get_graph_schema_response.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,26 +18,26 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel
-from typing import Any, ClassVar, Dict, List, Optional
-from graphscope.flex.rest.models.groot_edge_type import GrootEdgeType
-from graphscope.flex.rest.models.groot_vertex_type import GrootVertexType
+from pydantic import BaseModel, ConfigDict
+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 GrootSchema(BaseModel):
+class GetGraphSchemaResponse(BaseModel):
     """
-    GrootSchema
+    GetGraphSchemaResponse
     """ # noqa: E501
-    vertices: Optional[List[GrootVertexType]] = None
-    edges: Optional[List[GrootEdgeType]] = None
-    __properties: ClassVar[List[str]] = ["vertices", "edges"]
+    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": (),
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -51,7 +51,7 @@ class GrootSchema(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of GrootSchema from a JSON string"""
+        """Create an instance of GetGraphSchemaResponse from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -72,25 +72,25 @@ class GrootSchema(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of each item in vertices (list)
+        # override the default output from pydantic by calling `to_dict()` of each item in vertex_types (list)
         _items = []
-        if self.vertices:
-            for _item in self.vertices:
-                if _item:
-                    _items.append(_item.to_dict())
-            _dict['vertices'] = _items
-        # override the default output from pydantic by calling `to_dict()` of each item in edges (list)
+        if self.vertex_types:
+            for _item_vertex_types in self.vertex_types:
+                if _item_vertex_types:
+                    _items.append(_item_vertex_types.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.edges:
-            for _item in self.edges:
-                if _item:
-                    _items.append(_item.to_dict())
-            _dict['edges'] = _items
+        if self.edge_types:
+            for _item_edge_types in self.edge_types:
+                if _item_edge_types:
+                    _items.append(_item_edge_types.to_dict())
+            _dict['edge_types'] = _items
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of GrootSchema from a dict"""
+        """Create an instance of GetGraphSchemaResponse from a dict"""
         if obj is None:
             return None
 
@@ -98,8 +98,8 @@ class GrootSchema(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "vertices": [GrootVertexType.from_dict(_item) for _item in obj["vertices"]] if obj.get("vertices") is not None else None,
-            "edges": [GrootEdgeType.from_dict(_item) for _item in obj["edges"]] if obj.get("edges") is not None else None
+            "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_pod_log_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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetPodLogResponse(BaseModel):
+    """
+    GetPodLogResponse
+    """ # noqa: E501
+    log: Dict[str, Any]
+    __properties: ClassVar[List[str]] = ["log"]
+
+    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 GetPodLogResponse 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 GetPodLogResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "log": obj.get("log")
+        })
+        return _obj
+
+

graphscope/flex/rest/models/{edge_mapping_destination_vertex_mappings_inner.py → get_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,24 +18,29 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from graphscope.flex.rest.models.edge_mapping_source_vertex_mappings_inner_column import EdgeMappingSourceVertexMappingsInnerColumn
+from graphscope.flex.rest.models.gs_data_type import GSDataType
 from typing import Optional, Set
 from typing_extensions import Self
 
-class EdgeMappingDestinationVertexMappingsInner(BaseModel):
+class GetPropertyMeta(BaseModel):
     """
-    Mapping column index to the primary key of destination vertex
+    GetPropertyMeta
     """ # noqa: E501
-    column: Optional[EdgeMappingSourceVertexMappingsInnerColumn] = None
-    __properties: ClassVar[List[str]] = ["column"]
+    property_name: StrictStr
+    property_type: GSDataType
+    nullable: Optional[StrictBool] = None
+    default_value: Optional[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": (),
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -49,7 +54,7 @@ class EdgeMappingDestinationVertexMappingsInner(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of EdgeMappingDestinationVertexMappingsInner from a JSON string"""
+        """Create an instance of GetPropertyMeta from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -70,14 +75,19 @@ class EdgeMappingDestinationVertexMappingsInner(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of column
-        if self.column:
-            _dict['column'] = self.column.to_dict()
+        # 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 EdgeMappingDestinationVertexMappingsInner from a dict"""
+        """Create an instance of GetPropertyMeta from a dict"""
         if obj is None:
             return None
 
@@ -85,7 +95,12 @@ class EdgeMappingDestinationVertexMappingsInner(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "column": EdgeMappingSourceVertexMappingsInnerColumn.from_dict(obj["column"]) if obj.get("column") 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"),
+            "property_id": obj.get("property_id")
         })
         return _obj
 

graphscope/flex/rest/models/get_resource_usage_response.py

@@ -0,0 +1,105 @@
+# 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.resource_usage import ResourceUsage
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetResourceUsageResponse(BaseModel):
+    """
+    GetResourceUsageResponse
+    """ # noqa: E501
+    cpu_usage: List[ResourceUsage]
+    memory_usage: List[ResourceUsage]
+    __properties: ClassVar[List[str]] = ["cpu_usage", "memory_usage"]
+
+    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 GetResourceUsageResponse 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 cpu_usage (list)
+        _items = []
+        if self.cpu_usage:
+            for _item_cpu_usage in self.cpu_usage:
+                if _item_cpu_usage:
+                    _items.append(_item_cpu_usage.to_dict())
+            _dict['cpu_usage'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in memory_usage (list)
+        _items = []
+        if self.memory_usage:
+            for _item_memory_usage in self.memory_usage:
+                if _item_memory_usage:
+                    _items.append(_item_memory_usage.to_dict())
+            _dict['memory_usage'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetResourceUsageResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "cpu_usage": [ResourceUsage.from_dict(_item) for _item in obj["cpu_usage"]] if obj.get("cpu_usage") is not None else None,
+            "memory_usage": [ResourceUsage.from_dict(_item) for _item in obj["memory_usage"]] if obj.get("memory_usage") is not None else None
+        })
+        return _obj
+
+

graphscope/flex/rest/models/get_storage_usage_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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetStorageUsageResponse(BaseModel):
+    """
+    GetStorageUsageResponse
+    """ # noqa: E501
+    storage_usage: Dict[str, Union[StrictFloat, StrictInt]]
+    __properties: ClassVar[List[str]] = ["storage_usage"]
+
+    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 GetStorageUsageResponse 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 GetStorageUsageResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "storage_usage": obj.get("storage_usage")
+        })
+        return _obj
+
+

graphscope/flex/rest/models/{procedure.py → get_stored_proc_response.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,42 +18,41 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, StrictBool, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
-from graphscope.flex.rest.models.procedure_params_inner import ProcedureParamsInner
+from graphscope.flex.rest.models.parameter import Parameter
 from typing import Optional, Set
 from typing_extensions import Self
 
-class Procedure(BaseModel):
+class GetStoredProcResponse(BaseModel):
     """
-    Procedure
+    GetStoredProcResponse
     """ # noqa: E501
-    name: Optional[StrictStr] = None
-    bound_graph: Optional[StrictStr] = None
+    name: StrictStr
     description: Optional[StrictStr] = None
-    type: Optional[StrictStr] = None
-    query: Optional[StrictStr] = None
-    enable: Optional[StrictBool] = None
-    runnable: Optional[StrictBool] = None
-    params: Optional[List[ProcedureParamsInner]] = None
-    returns: Optional[List[ProcedureParamsInner]] = None
-    __properties: ClassVar[List[str]] = ["name", "bound_graph", "description", "type", "query", "enable", "runnable", "params", "returns"]
+    type: StrictStr
+    query: StrictStr
+    id: StrictStr
+    library: StrictStr
+    params: List[Parameter]
+    returns: List[Parameter]
+    option: Optional[Dict[str, Any]] = None
+    bound_graph: StrictStr
+    runnable: StrictBool
+    __properties: ClassVar[List[str]] = ["name", "description", "type", "query", "id", "library", "params", "returns", "option", "bound_graph", "runnable"]
 
     @field_validator('type')
     def type_validate_enum(cls, value):
         """Validates the enum"""
-        if value is None:
-            return value
-
         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:
@@ -67,7 +66,7 @@ class Procedure(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of Procedure from a JSON string"""
+        """Create an instance of GetStoredProcResponse from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -91,22 +90,22 @@ class Procedure(BaseModel):
         # 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())
+            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 in self.returns:
-                if _item:
-                    _items.append(_item.to_dict())
+            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 Procedure from a dict"""
+        """Create an instance of GetStoredProcResponse from a dict"""
         if obj is None:
             return None
 
@@ -115,14 +114,16 @@ class Procedure(BaseModel):
 
         _obj = cls.model_validate({
             "name": obj.get("name"),
-            "bound_graph": obj.get("bound_graph"),
             "description": obj.get("description"),
             "type": obj.get("type"),
             "query": obj.get("query"),
-            "enable": obj.get("enable"),
-            "runnable": obj.get("runnable"),
-            "params": [ProcedureParamsInner.from_dict(_item) for _item in obj["params"]] if obj.get("params") is not None else None,
-            "returns": [ProcedureParamsInner.from_dict(_item) for _item in obj["returns"]] if obj.get("returns") is not None else None
+            "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"),
+            "bound_graph": obj.get("bound_graph"),
+            "runnable": obj.get("runnable")
         })
         return _obj