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

graphscope/flex/rest/models/{alert_rule.py → create_alert_rule_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,29 +18,26 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List, Optional
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
 from typing import Optional, Set
 from typing_extensions import Self
 
-class AlertRule(BaseModel):
+class CreateAlertRuleRequest(BaseModel):
     """
-    AlertRule
+    CreateAlertRuleRequest
     """ # noqa: E501
-    name: Optional[StrictStr] = None
-    severity: Optional[StrictStr] = None
-    metric_type: Optional[StrictStr] = None
-    conditions_description: Optional[StrictStr] = None
-    frequency: Optional[StrictInt] = Field(default=None, description="(mins)")
-    enable: Optional[StrictBool] = None
+    name: StrictStr
+    severity: StrictStr
+    metric_type: StrictStr
+    conditions_description: StrictStr
+    frequency: StrictInt = Field(description="(mins)")
+    enable: StrictBool
     __properties: ClassVar[List[str]] = ["name", "severity", "metric_type", "conditions_description", "frequency", "enable"]
 
     @field_validator('severity')
     def severity_validate_enum(cls, value):
         """Validates the enum"""
-        if value is None:
-            return value
-
         if value not in set(['warning', 'emergency']):
             raise ValueError("must be one of enum values ('warning', 'emergency')")
         return value
@@ -48,18 +45,15 @@ class AlertRule(BaseModel):
     @field_validator('metric_type')
     def metric_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value is None:
-            return value
-
         if value not in set(['node', 'service']):
             raise ValueError("must be one of enum values ('node', 'service')")
         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:
@@ -73,7 +67,7 @@ class AlertRule(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of AlertRule from a JSON string"""
+        """Create an instance of CreateAlertRuleRequest from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -98,7 +92,7 @@ class AlertRule(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of AlertRule from a dict"""
+        """Create an instance of CreateAlertRuleRequest from a dict"""
         if obj is None:
             return None
 

graphscope/flex/rest/models/create_dataloading_job_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 CreateDataloadingJobResponse(BaseModel):
+    """
+    CreateDataloadingJobResponse
+    """ # noqa: E501
+    job_id: StrictStr
+    __properties: ClassVar[List[str]] = ["job_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 CreateDataloadingJobResponse 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 CreateDataloadingJobResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "job_id": obj.get("job_id")
+        })
+        return _obj
+
+

graphscope/flex/rest/models/create_edge_type.py

@@ -0,0 +1,114 @@
+# 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, StrictBool, 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.create_property_meta import CreatePropertyMeta
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateEdgeType(BaseModel):
+    """
+    CreateEdgeType
+    """ # noqa: E501
+    type_name: StrictStr
+    vertex_type_pair_relations: List[BaseEdgeTypeVertexTypePairRelationsInner]
+    directed: Optional[StrictBool] = None
+    primary_keys: Optional[List[StrictStr]] = None
+    properties: Optional[List[CreatePropertyMeta]] = None
+    description: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["type_name", "vertex_type_pair_relations", "directed", "primary_keys", "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 CreateEdgeType 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_vertex_type_pair_relations in self.vertex_type_pair_relations:
+                if _item_vertex_type_pair_relations:
+                    _items.append(_item_vertex_type_pair_relations.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_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 CreateEdgeType 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"),
+            "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/{graph.py → create_graph_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,38 +18,28 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, Field, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from graphscope.flex.rest.models.graph_stored_procedures import GraphStoredProcedures
-from graphscope.flex.rest.models.model_schema import ModelSchema
+from graphscope.flex.rest.models.create_graph_schema_request import CreateGraphSchemaRequest
+from graphscope.flex.rest.models.create_stored_proc_request import CreateStoredProcRequest
 from typing import Optional, Set
 from typing_extensions import Self
 
-class Graph(BaseModel):
+class CreateGraphRequest(BaseModel):
     """
-    Graph
+    CreateGraphRequest
     """ # noqa: E501
     name: Optional[StrictStr] = None
-    store_type: Optional[StrictStr] = None
-    stored_procedures: Optional[GraphStoredProcedures] = None
-    var_schema: Optional[ModelSchema] = Field(default=None, alias="schema")
-    __properties: ClassVar[List[str]] = ["name", "store_type", "stored_procedures", "schema"]
+    description: Optional[StrictStr] = None
+    stored_procedures: Optional[List[CreateStoredProcRequest]] = None
+    var_schema: Optional[CreateGraphSchemaRequest] = Field(default=None, alias="schema")
+    __properties: ClassVar[List[str]] = ["name", "description", "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": (),
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -63,7 +53,7 @@ class Graph(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of Graph from a JSON string"""
+        """Create an instance of CreateGraphRequest from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -84,9 +74,13 @@ class Graph(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of stored_procedures
+        # override the default output from pydantic by calling `to_dict()` of each item in stored_procedures (list)
+        _items = []
         if self.stored_procedures:
-            _dict['stored_procedures'] = self.stored_procedures.to_dict()
+            for _item_stored_procedures in self.stored_procedures:
+                if _item_stored_procedures:
+                    _items.append(_item_stored_procedures.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()
@@ -94,7 +88,7 @@ class Graph(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of Graph from a dict"""
+        """Create an instance of CreateGraphRequest from a dict"""
         if obj is None:
             return None
 
@@ -103,9 +97,9 @@ class Graph(BaseModel):
 
         _obj = cls.model_validate({
             "name": obj.get("name"),
-            "store_type": obj.get("store_type"),
-            "stored_procedures": GraphStoredProcedures.from_dict(obj["stored_procedures"]) if obj.get("stored_procedures") is not None else None,
-            "schema": ModelSchema.from_dict(obj["schema"]) if obj.get("schema") is not None else None
+            "description": obj.get("description"),
+            "stored_procedures": [CreateStoredProcRequest.from_dict(_item) for _item in obj["stored_procedures"]] if obj.get("stored_procedures") is not None else None,
+            "schema": CreateGraphSchemaRequest.from_dict(obj["schema"]) if obj.get("schema") is not None else None
         })
         return _obj
 

graphscope/flex/rest/models/create_graph_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 CreateGraphResponse(BaseModel):
+    """
+    CreateGraphResponse
+    """ # noqa: E501
+    graph_id: StrictStr
+    __properties: ClassVar[List[str]] = ["graph_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 CreateGraphResponse 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 CreateGraphResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "graph_id": obj.get("graph_id")
+        })
+        return _obj
+
+

graphscope/flex/rest/models/{model_schema.py → create_graph_schema_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,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.edge_type import EdgeType
-from graphscope.flex.rest.models.vertex_type import VertexType
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List
+from graphscope.flex.rest.models.create_edge_type import CreateEdgeType
+from graphscope.flex.rest.models.create_vertex_type import CreateVertexType
 from typing import Optional, Set
 from typing_extensions import Self
 
-class ModelSchema(BaseModel):
+class CreateGraphSchemaRequest(BaseModel):
     """
-    ModelSchema
+    CreateGraphSchemaRequest
     """ # noqa: E501
-    vertex_types: Optional[List[VertexType]] = None
-    edge_types: Optional[List[EdgeType]] = None
+    vertex_types: List[CreateVertexType]
+    edge_types: List[CreateEdgeType]
     __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 ModelSchema(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of ModelSchema from a JSON string"""
+        """Create an instance of CreateGraphSchemaRequest from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -75,22 +75,22 @@ class ModelSchema(BaseModel):
         # 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())
+            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.edge_types:
-            for _item in self.edge_types:
-                if _item:
-                    _items.append(_item.to_dict())
+            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 ModelSchema from a dict"""
+        """Create an instance of CreateGraphSchemaRequest from a dict"""
         if obj is None:
             return None
 
@@ -98,8 +98,8 @@ class ModelSchema(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "vertex_types": [VertexType.from_dict(_item) for _item in obj["vertex_types"]] if obj.get("vertex_types") is not None else None,
-            "edge_types": [EdgeType.from_dict(_item) for _item in obj["edge_types"]] if obj.get("edge_types") is not None else None
+            "vertex_types": [CreateVertexType.from_dict(_item) for _item in obj["vertex_types"]] if obj.get("vertex_types") is not None else None,
+            "edge_types": [CreateEdgeType.from_dict(_item) for _item in obj["edge_types"]] if obj.get("edge_types") is not None else None
         })
         return _obj