|
|
|
|
|
|
|
|
""" |
|
|
VCell API |
|
|
|
|
|
VCell API |
|
|
|
|
|
The version of the OpenAPI document: 1.0.1 |
|
|
Contact: vcell_support@uchc.com |
|
|
Generated by OpenAPI Generator (https://openapi-generator.tech) |
|
|
|
|
|
Do not edit the class manually. |
|
|
""" |
|
|
|
|
|
|
|
|
import io |
|
|
import warnings |
|
|
|
|
|
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt |
|
|
from typing import Dict, List, Optional, Tuple, Union, Any |
|
|
|
|
|
try: |
|
|
from typing import Annotated |
|
|
except ImportError: |
|
|
from typing_extensions import Annotated |
|
|
|
|
|
from pydantic import StrictStr |
|
|
|
|
|
from typing import List, Optional |
|
|
|
|
|
from vcell_client.models.simulation_status_persistent_record import SimulationStatusPersistentRecord |
|
|
from vcell_client.models.status_message import StatusMessage |
|
|
|
|
|
from vcell_client.api_client import ApiClient |
|
|
from vcell_client.api_response import ApiResponse |
|
|
from vcell_client.rest import RESTResponseType |
|
|
|
|
|
|
|
|
class SimulationResourceApi: |
|
|
"""NOTE: This class is auto generated by OpenAPI Generator |
|
|
Ref: https://openapi-generator.tech |
|
|
|
|
|
Do not edit the class manually. |
|
|
""" |
|
|
|
|
|
def __init__(self, api_client=None) -> None: |
|
|
if api_client is None: |
|
|
api_client = ApiClient.get_default() |
|
|
self.api_client = api_client |
|
|
|
|
|
|
|
|
@validate_call |
|
|
def get_simulation_status( |
|
|
self, |
|
|
sim_id: StrictStr, |
|
|
bio_model_id: Optional[StrictStr] = None, |
|
|
math_model_id: Optional[StrictStr] = None, |
|
|
_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, |
|
|
) -> SimulationStatusPersistentRecord: |
|
|
"""Get the status of simulation running |
|
|
|
|
|
|
|
|
:param sim_id: (required) |
|
|
:type sim_id: str |
|
|
:param bio_model_id: |
|
|
:type bio_model_id: str |
|
|
:param math_model_id: |
|
|
:type math_model_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 |
|
|
(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. |
|
|
""" |
|
|
|
|
|
_param = self._get_simulation_status_serialize( |
|
|
sim_id=sim_id, |
|
|
bio_model_id=bio_model_id, |
|
|
math_model_id=math_model_id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "SimulationStatusPersistentRecord", |
|
|
'401': "VCellHTTPError", |
|
|
'403': "VCellHTTPError", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
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 get_simulation_status_with_http_info( |
|
|
self, |
|
|
sim_id: StrictStr, |
|
|
bio_model_id: Optional[StrictStr] = None, |
|
|
math_model_id: Optional[StrictStr] = None, |
|
|
_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[SimulationStatusPersistentRecord]: |
|
|
"""Get the status of simulation running |
|
|
|
|
|
|
|
|
:param sim_id: (required) |
|
|
:type sim_id: str |
|
|
:param bio_model_id: |
|
|
:type bio_model_id: str |
|
|
:param math_model_id: |
|
|
:type math_model_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 |
|
|
(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. |
|
|
""" |
|
|
|
|
|
_param = self._get_simulation_status_serialize( |
|
|
sim_id=sim_id, |
|
|
bio_model_id=bio_model_id, |
|
|
math_model_id=math_model_id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "SimulationStatusPersistentRecord", |
|
|
'401': "VCellHTTPError", |
|
|
'403': "VCellHTTPError", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
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 get_simulation_status_without_preload_content( |
|
|
self, |
|
|
sim_id: StrictStr, |
|
|
bio_model_id: Optional[StrictStr] = None, |
|
|
math_model_id: Optional[StrictStr] = None, |
|
|
_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: |
|
|
"""Get the status of simulation running |
|
|
|
|
|
|
|
|
:param sim_id: (required) |
|
|
:type sim_id: str |
|
|
:param bio_model_id: |
|
|
:type bio_model_id: str |
|
|
:param math_model_id: |
|
|
:type math_model_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 |
|
|
(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. |
|
|
""" |
|
|
|
|
|
_param = self._get_simulation_status_serialize( |
|
|
sim_id=sim_id, |
|
|
bio_model_id=bio_model_id, |
|
|
math_model_id=math_model_id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "SimulationStatusPersistentRecord", |
|
|
'401': "VCellHTTPError", |
|
|
'403': "VCellHTTPError", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
response_data = self.api_client.call_api( |
|
|
*_param, |
|
|
_request_timeout=_request_timeout |
|
|
) |
|
|
return response_data.response |
|
|
|
|
|
|
|
|
def _get_simulation_status_serialize( |
|
|
self, |
|
|
sim_id, |
|
|
bio_model_id, |
|
|
math_model_id, |
|
|
_request_auth, |
|
|
_content_type, |
|
|
_headers, |
|
|
_host_index, |
|
|
) -> Tuple: |
|
|
|
|
|
_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, str] = {} |
|
|
_body_params: Optional[bytes] = None |
|
|
|
|
|
|
|
|
if sim_id is not None: |
|
|
_path_params['simID'] = sim_id |
|
|
|
|
|
if bio_model_id is not None: |
|
|
|
|
|
_query_params.append(('bioModelID', bio_model_id)) |
|
|
|
|
|
if math_model_id is not None: |
|
|
|
|
|
_query_params.append(('mathModelID', math_model_id)) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
_header_params['Accept'] = self.api_client.select_header_accept( |
|
|
[ |
|
|
'application/json' |
|
|
] |
|
|
) |
|
|
|
|
|
|
|
|
|
|
|
_auth_settings: List[str] = [ |
|
|
'openId' |
|
|
] |
|
|
|
|
|
return self.api_client.param_serialize( |
|
|
method='GET', |
|
|
resource_path='/api/v1/Simulation/{simID}/simulationStatus', |
|
|
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 start_simulation( |
|
|
self, |
|
|
sim_id: StrictStr, |
|
|
_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[StatusMessage]: |
|
|
"""Start a simulation. |
|
|
|
|
|
|
|
|
:param sim_id: (required) |
|
|
:type sim_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 |
|
|
(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. |
|
|
""" |
|
|
|
|
|
_param = self._start_simulation_serialize( |
|
|
sim_id=sim_id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "List[StatusMessage]", |
|
|
'401': "VCellHTTPError", |
|
|
'403': "VCellHTTPError", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
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 start_simulation_with_http_info( |
|
|
self, |
|
|
sim_id: StrictStr, |
|
|
_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[StatusMessage]]: |
|
|
"""Start a simulation. |
|
|
|
|
|
|
|
|
:param sim_id: (required) |
|
|
:type sim_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 |
|
|
(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. |
|
|
""" |
|
|
|
|
|
_param = self._start_simulation_serialize( |
|
|
sim_id=sim_id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "List[StatusMessage]", |
|
|
'401': "VCellHTTPError", |
|
|
'403': "VCellHTTPError", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
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 start_simulation_without_preload_content( |
|
|
self, |
|
|
sim_id: StrictStr, |
|
|
_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: |
|
|
"""Start a simulation. |
|
|
|
|
|
|
|
|
:param sim_id: (required) |
|
|
:type sim_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 |
|
|
(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. |
|
|
""" |
|
|
|
|
|
_param = self._start_simulation_serialize( |
|
|
sim_id=sim_id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "List[StatusMessage]", |
|
|
'401': "VCellHTTPError", |
|
|
'403': "VCellHTTPError", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
response_data = self.api_client.call_api( |
|
|
*_param, |
|
|
_request_timeout=_request_timeout |
|
|
) |
|
|
return response_data.response |
|
|
|
|
|
|
|
|
def _start_simulation_serialize( |
|
|
self, |
|
|
sim_id, |
|
|
_request_auth, |
|
|
_content_type, |
|
|
_headers, |
|
|
_host_index, |
|
|
) -> Tuple: |
|
|
|
|
|
_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, str] = {} |
|
|
_body_params: Optional[bytes] = None |
|
|
|
|
|
|
|
|
if sim_id is not None: |
|
|
_path_params['simID'] = sim_id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
_header_params['Accept'] = self.api_client.select_header_accept( |
|
|
[ |
|
|
'application/json' |
|
|
] |
|
|
) |
|
|
|
|
|
|
|
|
|
|
|
_auth_settings: List[str] = [ |
|
|
'openId' |
|
|
] |
|
|
|
|
|
return self.api_client.param_serialize( |
|
|
method='POST', |
|
|
resource_path='/api/v1/Simulation/{simID}/startSimulation', |
|
|
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 stop_simulation( |
|
|
self, |
|
|
sim_id: StrictStr, |
|
|
_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[StatusMessage]: |
|
|
"""Stop a simulation. |
|
|
|
|
|
|
|
|
:param sim_id: (required) |
|
|
:type sim_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 |
|
|
(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. |
|
|
""" |
|
|
|
|
|
_param = self._stop_simulation_serialize( |
|
|
sim_id=sim_id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "List[StatusMessage]", |
|
|
'401': "VCellHTTPError", |
|
|
'403': "VCellHTTPError", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
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 stop_simulation_with_http_info( |
|
|
self, |
|
|
sim_id: StrictStr, |
|
|
_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[StatusMessage]]: |
|
|
"""Stop a simulation. |
|
|
|
|
|
|
|
|
:param sim_id: (required) |
|
|
:type sim_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 |
|
|
(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. |
|
|
""" |
|
|
|
|
|
_param = self._stop_simulation_serialize( |
|
|
sim_id=sim_id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "List[StatusMessage]", |
|
|
'401': "VCellHTTPError", |
|
|
'403': "VCellHTTPError", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
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 stop_simulation_without_preload_content( |
|
|
self, |
|
|
sim_id: StrictStr, |
|
|
_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: |
|
|
"""Stop a simulation. |
|
|
|
|
|
|
|
|
:param sim_id: (required) |
|
|
:type sim_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 |
|
|
(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. |
|
|
""" |
|
|
|
|
|
_param = self._stop_simulation_serialize( |
|
|
sim_id=sim_id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "List[StatusMessage]", |
|
|
'401': "VCellHTTPError", |
|
|
'403': "VCellHTTPError", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
response_data = self.api_client.call_api( |
|
|
*_param, |
|
|
_request_timeout=_request_timeout |
|
|
) |
|
|
return response_data.response |
|
|
|
|
|
|
|
|
def _stop_simulation_serialize( |
|
|
self, |
|
|
sim_id, |
|
|
_request_auth, |
|
|
_content_type, |
|
|
_headers, |
|
|
_host_index, |
|
|
) -> Tuple: |
|
|
|
|
|
_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, str] = {} |
|
|
_body_params: Optional[bytes] = None |
|
|
|
|
|
|
|
|
if sim_id is not None: |
|
|
_path_params['simID'] = sim_id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
_header_params['Accept'] = self.api_client.select_header_accept( |
|
|
[ |
|
|
'application/json' |
|
|
] |
|
|
) |
|
|
|
|
|
|
|
|
|
|
|
_auth_settings: List[str] = [ |
|
|
'openId' |
|
|
] |
|
|
|
|
|
return self.api_client.param_serialize( |
|
|
method='POST', |
|
|
resource_path='/api/v1/Simulation/{simID}/stopSimulation', |
|
|
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 |
|
|
) |
|
|
|
|
|
|
|
|
|
