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

graphscope/flex/rest/api/service_api.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)
 
@@ -17,7 +17,8 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
-from typing import Optional
+from pydantic import StrictStr
+from typing import List, Optional
 from graphscope.flex.rest.models.service_status import ServiceStatus
 from graphscope.flex.rest.models.start_service_request import StartServiceRequest
 
@@ -40,8 +41,9 @@ class ServiceApi:
 
 
     @validate_call
-    def get_service_status(
+    def get_service_status_by_id(
         self,
+        graph_id: StrictStr,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -55,10 +57,12 @@ class ServiceApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ServiceStatus:
-        """get_service_status
+        """get_service_status_by_id
 
-        Get service status
+        Get service status by graph ID
 
+        :param graph_id: (required)
+        :type graph_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -81,7 +85,8 @@ class ServiceApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_service_status_serialize(
+        _param = self._get_service_status_by_id_serialize(
+            graph_id=graph_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -90,6 +95,7 @@ class ServiceApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "ServiceStatus",
+            '500': "Error",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -103,8 +109,9 @@ class ServiceApi:
 
 
     @validate_call
-    def get_service_status_with_http_info(
+    def get_service_status_by_id_with_http_info(
         self,
+        graph_id: StrictStr,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -118,10 +125,12 @@ class ServiceApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[ServiceStatus]:
-        """get_service_status
+        """get_service_status_by_id
 
-        Get service status
+        Get service status by graph ID
 
+        :param graph_id: (required)
+        :type graph_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -144,7 +153,8 @@ class ServiceApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_service_status_serialize(
+        _param = self._get_service_status_by_id_serialize(
+            graph_id=graph_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -153,6 +163,7 @@ class ServiceApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "ServiceStatus",
+            '500': "Error",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -166,8 +177,9 @@ class ServiceApi:
 
 
     @validate_call
-    def get_service_status_without_preload_content(
+    def get_service_status_by_id_without_preload_content(
         self,
+        graph_id: StrictStr,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -181,10 +193,12 @@ class ServiceApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """get_service_status
+        """get_service_status_by_id
 
-        Get service status
+        Get service status by graph ID
 
+        :param graph_id: (required)
+        :type graph_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -207,7 +221,8 @@ class ServiceApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_service_status_serialize(
+        _param = self._get_service_status_by_id_serialize(
+            graph_id=graph_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -216,6 +231,7 @@ class ServiceApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "ServiceStatus",
+            '500': "Error",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -224,8 +240,9 @@ class ServiceApi:
         return response_data.response
 
 
-    def _get_service_status_serialize(
+    def _get_service_status_by_id_serialize(
         self,
+        graph_id,
         _request_auth,
         _content_type,
         _headers,
@@ -241,10 +258,12 @@ class ServiceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, str] = {}
+        _files: Dict[str, Union[str, bytes]] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
+        if graph_id is not None:
+            _path_params['graph_id'] = graph_id
         # process the query parameters
         # process the header parameters
         # process the form parameters
@@ -252,11 +271,258 @@ class ServiceApi:
 
 
         # set the HTTP header `Accept`
-        _header_params['Accept'] = self.api_client.select_header_accept(
-            [
-                'application/json'
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/api/v1/graph/{graph_id}/service',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def list_service_status(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> List[ServiceStatus]:
+        """list_service_status
+
+        List all service status
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_service_status_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ServiceStatus]",
+            '500': "Error",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def list_service_status_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[List[ServiceStatus]]:
+        """list_service_status
+
+        List all service status
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_service_status_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ServiceStatus]",
+            '500': "Error",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def list_service_status_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
             ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """list_service_status
+
+        List all service status
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_service_status_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ServiceStatus]",
+            '500': "Error",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
         )
+        return response_data.response
+
+
+    def _list_service_status_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, Union[str, bytes]] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
 
 
         # authentication setting
@@ -265,7 +531,7 @@ class ServiceApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/api/v1/service/status',
+            resource_path='/api/v1/service',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -332,6 +598,7 @@ class ServiceApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "str",
+            '500': "Error",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -395,6 +662,7 @@ class ServiceApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "str",
+            '500': "Error",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -458,6 +726,7 @@ class ServiceApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "str",
+            '500': "Error",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -483,7 +752,7 @@ class ServiceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, str] = {}
+        _files: Dict[str, Union[str, bytes]] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -494,11 +763,12 @@ class ServiceApi:
 
 
         # set the HTTP header `Accept`
-        _header_params['Accept'] = self.api_client.select_header_accept(
-            [
-                'application/json'
-            ]
-        )
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
 
 
         # authentication setting
@@ -578,6 +848,8 @@ class ServiceApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "str",
+            '400': "Error",
+            '500': "Error",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -645,6 +917,8 @@ class ServiceApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "str",
+            '400': "Error",
+            '500': "Error",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -712,6 +986,8 @@ class ServiceApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "str",
+            '400': "Error",
+            '500': "Error",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -738,7 +1014,7 @@ class ServiceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, str] = {}
+        _files: Dict[str, Union[str, bytes]] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -751,11 +1027,12 @@ class ServiceApi:
 
 
         # set the HTTP header `Accept`
-        _header_params['Accept'] = self.api_client.select_header_accept(
-            [
-                'application/json'
-            ]
-        )
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
 
         # set the HTTP header `Content-Type`
         if _content_type:
@@ -844,6 +1121,7 @@ class ServiceApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "str",
+            '500': "Error",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -907,6 +1185,7 @@ class ServiceApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "str",
+            '500': "Error",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -970,6 +1249,7 @@ class ServiceApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "str",
+            '500': "Error",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -995,7 +1275,7 @@ class ServiceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, str] = {}
+        _files: Dict[str, Union[str, bytes]] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -1006,11 +1286,12 @@ class ServiceApi:
 
 
         # set the HTTP header `Accept`
-        _header_params['Accept'] = self.api_client.select_header_accept(
-            [
-                'application/json'
-            ]
-        )
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
 
 
         # authentication setting