|
|
|
|
|
|
|
|
""" |
|
|
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 Field |
|
|
from typing_extensions import Annotated |
|
|
from pydantic import StrictBool, StrictStr |
|
|
|
|
|
from typing import List, Optional |
|
|
|
|
|
from vcell_client.models.vc_image_summary import VCImageSummary |
|
|
|
|
|
from vcell_client.api_client import ApiClient |
|
|
from vcell_client.api_response import ApiResponse |
|
|
from vcell_client.rest import RESTResponseType |
|
|
|
|
|
|
|
|
class VCImageResourceApi: |
|
|
"""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 delete_image_vcml( |
|
|
self, |
|
|
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, |
|
|
) -> None: |
|
|
"""delete_image_vcml |
|
|
|
|
|
Remove specific image VCML. |
|
|
|
|
|
:param id: (required) |
|
|
:type 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._delete_image_vcml_serialize( |
|
|
id=id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
|
|
|
} |
|
|
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 delete_image_vcml_with_http_info( |
|
|
self, |
|
|
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[None]: |
|
|
"""delete_image_vcml |
|
|
|
|
|
Remove specific image VCML. |
|
|
|
|
|
:param id: (required) |
|
|
:type 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._delete_image_vcml_serialize( |
|
|
id=id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
|
|
|
} |
|
|
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 delete_image_vcml_without_preload_content( |
|
|
self, |
|
|
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: |
|
|
"""delete_image_vcml |
|
|
|
|
|
Remove specific image VCML. |
|
|
|
|
|
:param id: (required) |
|
|
:type 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._delete_image_vcml_serialize( |
|
|
id=id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
|
|
|
} |
|
|
response_data = self.api_client.call_api( |
|
|
*_param, |
|
|
_request_timeout=_request_timeout |
|
|
) |
|
|
return response_data.response |
|
|
|
|
|
|
|
|
def _delete_image_vcml_serialize( |
|
|
self, |
|
|
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 id is not None: |
|
|
_path_params['id'] = id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
_header_params['Accept'] = self.api_client.select_header_accept( |
|
|
[ |
|
|
'application/json' |
|
|
] |
|
|
) |
|
|
|
|
|
|
|
|
|
|
|
_auth_settings: List[str] = [ |
|
|
] |
|
|
|
|
|
return self.api_client.param_serialize( |
|
|
method='DELETE', |
|
|
resource_path='/api/v1/image/{id}', |
|
|
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 get_image_summaries( |
|
|
self, |
|
|
include_public_and_shared: Annotated[Optional[StrictBool], Field(description="Include Image summaries that are public and shared with the requester. Default is true.")] = 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, |
|
|
) -> List[VCImageSummary]: |
|
|
"""get_image_summaries |
|
|
|
|
|
Return Image summaries. |
|
|
|
|
|
:param include_public_and_shared: Include Image summaries that are public and shared with the requester. Default is true. |
|
|
:type include_public_and_shared: bool |
|
|
: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_image_summaries_serialize( |
|
|
include_public_and_shared=include_public_and_shared, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "List[VCImageSummary]", |
|
|
'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_image_summaries_with_http_info( |
|
|
self, |
|
|
include_public_and_shared: Annotated[Optional[StrictBool], Field(description="Include Image summaries that are public and shared with the requester. Default is true.")] = 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[List[VCImageSummary]]: |
|
|
"""get_image_summaries |
|
|
|
|
|
Return Image summaries. |
|
|
|
|
|
:param include_public_and_shared: Include Image summaries that are public and shared with the requester. Default is true. |
|
|
:type include_public_and_shared: bool |
|
|
: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_image_summaries_serialize( |
|
|
include_public_and_shared=include_public_and_shared, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "List[VCImageSummary]", |
|
|
'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_image_summaries_without_preload_content( |
|
|
self, |
|
|
include_public_and_shared: Annotated[Optional[StrictBool], Field(description="Include Image summaries that are public and shared with the requester. Default is true.")] = 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_image_summaries |
|
|
|
|
|
Return Image summaries. |
|
|
|
|
|
:param include_public_and_shared: Include Image summaries that are public and shared with the requester. Default is true. |
|
|
:type include_public_and_shared: bool |
|
|
: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_image_summaries_serialize( |
|
|
include_public_and_shared=include_public_and_shared, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "List[VCImageSummary]", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
response_data = self.api_client.call_api( |
|
|
*_param, |
|
|
_request_timeout=_request_timeout |
|
|
) |
|
|
return response_data.response |
|
|
|
|
|
|
|
|
def _get_image_summaries_serialize( |
|
|
self, |
|
|
include_public_and_shared, |
|
|
_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 include_public_and_shared is not None: |
|
|
|
|
|
_query_params.append(('includePublicAndShared', include_public_and_shared)) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
_header_params['Accept'] = self.api_client.select_header_accept( |
|
|
[ |
|
|
'application/json' |
|
|
] |
|
|
) |
|
|
|
|
|
|
|
|
|
|
|
_auth_settings: List[str] = [ |
|
|
] |
|
|
|
|
|
return self.api_client.param_serialize( |
|
|
method='GET', |
|
|
resource_path='/api/v1/image/summaries', |
|
|
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 get_image_summary( |
|
|
self, |
|
|
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, |
|
|
) -> VCImageSummary: |
|
|
"""get_image_summary |
|
|
|
|
|
All of the miscellaneous information about an Image (Extent, ISize, preview, etc...), but not the actual Image itself. |
|
|
|
|
|
:param id: (required) |
|
|
:type 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_image_summary_serialize( |
|
|
id=id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "VCImageSummary", |
|
|
'403': "VCellHTTPError", |
|
|
'404': "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_image_summary_with_http_info( |
|
|
self, |
|
|
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[VCImageSummary]: |
|
|
"""get_image_summary |
|
|
|
|
|
All of the miscellaneous information about an Image (Extent, ISize, preview, etc...), but not the actual Image itself. |
|
|
|
|
|
:param id: (required) |
|
|
:type 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_image_summary_serialize( |
|
|
id=id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "VCImageSummary", |
|
|
'403': "VCellHTTPError", |
|
|
'404': "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_image_summary_without_preload_content( |
|
|
self, |
|
|
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: |
|
|
"""get_image_summary |
|
|
|
|
|
All of the miscellaneous information about an Image (Extent, ISize, preview, etc...), but not the actual Image itself. |
|
|
|
|
|
:param id: (required) |
|
|
:type 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_image_summary_serialize( |
|
|
id=id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "VCImageSummary", |
|
|
'403': "VCellHTTPError", |
|
|
'404': "VCellHTTPError", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
response_data = self.api_client.call_api( |
|
|
*_param, |
|
|
_request_timeout=_request_timeout |
|
|
) |
|
|
return response_data.response |
|
|
|
|
|
|
|
|
def _get_image_summary_serialize( |
|
|
self, |
|
|
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 id is not None: |
|
|
_path_params['id'] = id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
_header_params['Accept'] = self.api_client.select_header_accept( |
|
|
[ |
|
|
'application/json' |
|
|
] |
|
|
) |
|
|
|
|
|
|
|
|
|
|
|
_auth_settings: List[str] = [ |
|
|
] |
|
|
|
|
|
return self.api_client.param_serialize( |
|
|
method='GET', |
|
|
resource_path='/api/v1/image/summary/{id}', |
|
|
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 get_image_vcml( |
|
|
self, |
|
|
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, |
|
|
) -> str: |
|
|
"""get_image_vcml |
|
|
|
|
|
Get specific image VCML. |
|
|
|
|
|
:param id: (required) |
|
|
:type 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_image_vcml_serialize( |
|
|
id=id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "str", |
|
|
'403': "VCellHTTPError", |
|
|
'404': "VCellHTTPError", |
|
|
'422': "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_image_vcml_with_http_info( |
|
|
self, |
|
|
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[str]: |
|
|
"""get_image_vcml |
|
|
|
|
|
Get specific image VCML. |
|
|
|
|
|
:param id: (required) |
|
|
:type 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_image_vcml_serialize( |
|
|
id=id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "str", |
|
|
'403': "VCellHTTPError", |
|
|
'404': "VCellHTTPError", |
|
|
'422': "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_image_vcml_without_preload_content( |
|
|
self, |
|
|
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: |
|
|
"""get_image_vcml |
|
|
|
|
|
Get specific image VCML. |
|
|
|
|
|
:param id: (required) |
|
|
:type 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_image_vcml_serialize( |
|
|
id=id, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "str", |
|
|
'403': "VCellHTTPError", |
|
|
'404': "VCellHTTPError", |
|
|
'422': "VCellHTTPError", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
response_data = self.api_client.call_api( |
|
|
*_param, |
|
|
_request_timeout=_request_timeout |
|
|
) |
|
|
return response_data.response |
|
|
|
|
|
|
|
|
def _get_image_vcml_serialize( |
|
|
self, |
|
|
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 id is not None: |
|
|
_path_params['id'] = id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
_header_params['Accept'] = self.api_client.select_header_accept( |
|
|
[ |
|
|
'text/plain', |
|
|
'application/json' |
|
|
] |
|
|
) |
|
|
|
|
|
|
|
|
|
|
|
_auth_settings: List[str] = [ |
|
|
] |
|
|
|
|
|
return self.api_client.param_serialize( |
|
|
method='GET', |
|
|
resource_path='/api/v1/image/{id}', |
|
|
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 save_image_vcml( |
|
|
self, |
|
|
body: StrictStr, |
|
|
name: Annotated[Optional[StrictStr], Field(description="Name to save new ImageVCML under. Leave blank if re-saving existing ImageVCML.")] = 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, |
|
|
) -> str: |
|
|
"""save_image_vcml |
|
|
|
|
|
Save the VCML representation of an image. |
|
|
|
|
|
:param body: (required) |
|
|
:type body: str |
|
|
:param name: Name to save new ImageVCML under. Leave blank if re-saving existing ImageVCML. |
|
|
:type name: 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._save_image_vcml_serialize( |
|
|
body=body, |
|
|
name=name, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "str", |
|
|
'401': "VCellHTTPError", |
|
|
'422': "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 save_image_vcml_with_http_info( |
|
|
self, |
|
|
body: StrictStr, |
|
|
name: Annotated[Optional[StrictStr], Field(description="Name to save new ImageVCML under. Leave blank if re-saving existing ImageVCML.")] = 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[str]: |
|
|
"""save_image_vcml |
|
|
|
|
|
Save the VCML representation of an image. |
|
|
|
|
|
:param body: (required) |
|
|
:type body: str |
|
|
:param name: Name to save new ImageVCML under. Leave blank if re-saving existing ImageVCML. |
|
|
:type name: 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._save_image_vcml_serialize( |
|
|
body=body, |
|
|
name=name, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "str", |
|
|
'401': "VCellHTTPError", |
|
|
'422': "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 save_image_vcml_without_preload_content( |
|
|
self, |
|
|
body: StrictStr, |
|
|
name: Annotated[Optional[StrictStr], Field(description="Name to save new ImageVCML under. Leave blank if re-saving existing ImageVCML.")] = 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: |
|
|
"""save_image_vcml |
|
|
|
|
|
Save the VCML representation of an image. |
|
|
|
|
|
:param body: (required) |
|
|
:type body: str |
|
|
:param name: Name to save new ImageVCML under. Leave blank if re-saving existing ImageVCML. |
|
|
:type name: 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._save_image_vcml_serialize( |
|
|
body=body, |
|
|
name=name, |
|
|
_request_auth=_request_auth, |
|
|
_content_type=_content_type, |
|
|
_headers=_headers, |
|
|
_host_index=_host_index |
|
|
) |
|
|
|
|
|
_response_types_map: Dict[str, Optional[str]] = { |
|
|
'200': "str", |
|
|
'401': "VCellHTTPError", |
|
|
'422': "VCellHTTPError", |
|
|
'500': "VCellHTTPError" |
|
|
|
|
|
} |
|
|
response_data = self.api_client.call_api( |
|
|
*_param, |
|
|
_request_timeout=_request_timeout |
|
|
) |
|
|
return response_data.response |
|
|
|
|
|
|
|
|
def _save_image_vcml_serialize( |
|
|
self, |
|
|
body, |
|
|
name, |
|
|
_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 name is not None: |
|
|
|
|
|
_query_params.append(('name', name)) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
if body is not None: |
|
|
_body_params = body |
|
|
|
|
|
|
|
|
|
|
|
_header_params['Accept'] = self.api_client.select_header_accept( |
|
|
[ |
|
|
'text/plain', |
|
|
'application/json' |
|
|
] |
|
|
) |
|
|
|
|
|
|
|
|
if _content_type: |
|
|
_header_params['Content-Type'] = _content_type |
|
|
else: |
|
|
_default_content_type = ( |
|
|
self.api_client.select_header_content_type( |
|
|
[ |
|
|
'application/json' |
|
|
] |
|
|
) |
|
|
) |
|
|
if _default_content_type is not None: |
|
|
_header_params['Content-Type'] = _default_content_type |
|
|
|
|
|
|
|
|
_auth_settings: List[str] = [ |
|
|
] |
|
|
|
|
|
return self.api_client.param_serialize( |
|
|
method='POST', |
|
|
resource_path='/api/v1/image', |
|
|
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 |
|
|
) |
|
|
|
|
|
|
|
|
|
