regula-facesdk-webclient 7.2.388.dev0__py3-none-any.whl → 8.1.433.dev0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- regula/facesdk/webclient/__init__.py +5 -5
- regula/facesdk/webclient/ext/api/group_api.py +2 -27
- regula/facesdk/webclient/ext/api/match_api.py +3 -29
- regula/facesdk/webclient/ext/api/person_api.py +8 -34
- regula/facesdk/webclient/ext/api/sdk.py +5 -3
- regula/facesdk/webclient/ext/api/search_api.py +2 -6
- regula/facesdk/webclient/ext/models/detect_request.py +6 -5
- regula/facesdk/webclient/ext/models/match_image.py +3 -3
- regula/facesdk/webclient/ext/models/match_request.py +7 -5
- regula/facesdk/webclient/gen/__init__.py +349 -18
- regula/facesdk/webclient/gen/api/__init__.py +30 -3
- regula/facesdk/webclient/gen/api/group_api.py +1854 -799
- regula/facesdk/webclient/gen/api/healthcheck_api.py +475 -215
- regula/facesdk/webclient/gen/api/liveness20_api.py +565 -0
- regula/facesdk/webclient/gen/api/match_api.py +801 -355
- regula/facesdk/webclient/gen/api/person_api.py +2399 -1039
- regula/facesdk/webclient/gen/api/search_api.py +286 -130
- regula/facesdk/webclient/gen/api_client.py +577 -476
- regula/facesdk/webclient/gen/api_response.py +21 -0
- regula/facesdk/webclient/gen/configuration.py +231 -105
- regula/facesdk/webclient/gen/exceptions.py +82 -33
- regula/facesdk/webclient/gen/models/__init__.py +202 -95
- regula/facesdk/webclient/gen/models/add_image_to_person_request.py +96 -0
- regula/facesdk/webclient/gen/models/add_image_to_person_request_data.py +92 -0
- regula/facesdk/webclient/gen/models/add_image_to_person_request_image.py +92 -0
- regula/facesdk/webclient/gen/models/add_image_to_person_response.py +92 -0
- regula/facesdk/webclient/gen/models/attribute_config.py +83 -0
- regula/facesdk/webclient/gen/models/attributes_data.py +82 -0
- regula/facesdk/webclient/gen/models/crop.py +88 -0
- regula/facesdk/webclient/gen/models/detail_item.py +136 -0
- regula/facesdk/webclient/gen/models/detect_attributes_details.py +84 -0
- regula/facesdk/webclient/gen/models/detect_details_meta.py +86 -0
- regula/facesdk/webclient/gen/models/detect_meta_data.py +84 -0
- regula/facesdk/webclient/gen/models/detect_request.py +94 -0
- regula/facesdk/webclient/gen/models/detect_request_data.py +90 -0
- regula/facesdk/webclient/gen/models/detect_response.py +89 -0
- regula/facesdk/webclient/gen/models/detect_response_results.py +86 -0
- regula/facesdk/webclient/gen/models/detect_result.py +98 -0
- regula/facesdk/webclient/gen/models/detection.py +98 -0
- regula/facesdk/webclient/gen/models/detection_attributes.py +92 -0
- regula/facesdk/webclient/gen/models/detection_attributes_details_inner.py +132 -0
- regula/facesdk/webclient/gen/models/detection_face.py +90 -0
- regula/facesdk/webclient/gen/models/detection_quality.py +107 -0
- regula/facesdk/webclient/gen/models/device_info.py +111 -0
- regula/facesdk/webclient/gen/models/face_attribute.py +40 -0
- regula/facesdk/webclient/gen/models/face_image_quality_align_type.py +32 -0
- regula/facesdk/webclient/gen/models/face_image_quality_groups.py +35 -0
- regula/facesdk/webclient/gen/models/face_image_quality_groups_strings.py +35 -0
- regula/facesdk/webclient/gen/models/face_image_quality_status.py +30 -0
- regula/facesdk/webclient/gen/models/face_quality_config_name.py +75 -0
- regula/facesdk/webclient/gen/models/face_quality_scenarios.py +37 -0
- regula/facesdk/webclient/gen/models/face_sdk_result.py +83 -0
- regula/facesdk/webclient/gen/models/face_sdk_result_code.py +68 -0
- regula/facesdk/webclient/gen/models/faces_response.py +100 -0
- regula/facesdk/webclient/gen/models/faces_response_data.py +90 -0
- regula/facesdk/webclient/gen/models/filter_op.py +29 -0
- regula/facesdk/webclient/gen/models/filter_search_request.py +87 -0
- regula/facesdk/webclient/gen/models/group.py +89 -0
- regula/facesdk/webclient/gen/models/group_data.py +85 -0
- regula/facesdk/webclient/gen/models/group_page.py +94 -0
- regula/facesdk/webclient/gen/models/group_page_items.py +90 -0
- regula/facesdk/webclient/gen/models/group_response.py +84 -0
- regula/facesdk/webclient/gen/models/group_to_create.py +86 -0
- regula/facesdk/webclient/gen/models/image.py +96 -0
- regula/facesdk/webclient/gen/models/image_fields.py +100 -0
- regula/facesdk/webclient/gen/models/image_fields_image.py +92 -0
- regula/facesdk/webclient/gen/models/image_page.py +94 -0
- regula/facesdk/webclient/gen/models/image_page_items.py +90 -0
- regula/facesdk/webclient/gen/models/image_source.py +34 -0
- regula/facesdk/webclient/gen/models/liveness_type.py +29 -0
- regula/facesdk/webclient/gen/models/match_and_search_request.py +103 -0
- regula/facesdk/webclient/gen/models/match_and_search_request_images_item.py +87 -0
- regula/facesdk/webclient/gen/models/match_and_search_response.py +107 -0
- regula/facesdk/webclient/gen/models/match_and_search_response_data.py +104 -0
- regula/facesdk/webclient/gen/models/match_and_search_response_data_detections_item.py +95 -0
- regula/facesdk/webclient/gen/models/match_image.py +89 -0
- regula/facesdk/webclient/gen/models/match_image_detection.py +95 -0
- regula/facesdk/webclient/gen/models/match_image_result.py +97 -0
- regula/facesdk/webclient/gen/models/match_request.py +102 -0
- regula/facesdk/webclient/gen/models/match_request_data.py +98 -0
- regula/facesdk/webclient/gen/models/match_response.py +105 -0
- regula/facesdk/webclient/gen/models/match_response_data.py +102 -0
- regula/facesdk/webclient/gen/models/operation_log.py +88 -0
- regula/facesdk/webclient/gen/models/output_image_params.py +89 -0
- regula/facesdk/webclient/gen/models/page.py +84 -0
- regula/facesdk/webclient/gen/models/person.py +97 -0
- regula/facesdk/webclient/gen/models/person_data.py +87 -0
- regula/facesdk/webclient/gen/models/person_fields.py +91 -0
- regula/facesdk/webclient/gen/models/person_items.py +90 -0
- regula/facesdk/webclient/gen/models/person_to_update_fields.py +89 -0
- regula/facesdk/webclient/gen/models/person_with_images.py +107 -0
- regula/facesdk/webclient/gen/models/person_with_images_data.py +90 -0
- regula/facesdk/webclient/gen/models/persons_page.py +94 -0
- regula/facesdk/webclient/gen/models/process_param.py +103 -0
- regula/facesdk/webclient/gen/models/process_param_attributes.py +90 -0
- regula/facesdk/webclient/gen/models/quality_config.py +86 -0
- regula/facesdk/webclient/gen/models/quality_detail.py +94 -0
- regula/facesdk/webclient/gen/models/quality_details_groups.py +90 -0
- regula/facesdk/webclient/gen/models/quality_request.py +93 -0
- regula/facesdk/webclient/gen/models/recognize_image.py +100 -0
- regula/facesdk/webclient/gen/models/recognize_image_data.py +84 -0
- regula/facesdk/webclient/gen/models/resize_options.py +86 -0
- regula/facesdk/webclient/gen/models/search_bad_params.py +86 -0
- regula/facesdk/webclient/gen/models/search_detection.py +102 -0
- regula/facesdk/webclient/gen/models/search_parameters.py +95 -0
- regula/facesdk/webclient/gen/models/search_parameters_create_person.py +86 -0
- regula/facesdk/webclient/gen/models/search_person.py +113 -0
- regula/facesdk/webclient/gen/models/search_person_data.py +96 -0
- regula/facesdk/webclient/gen/models/search_request.py +119 -0
- regula/facesdk/webclient/gen/models/search_result.py +92 -0
- regula/facesdk/webclient/gen/models/transaction_info.py +99 -0
- regula/facesdk/webclient/gen/models/transaction_labels.py +84 -0
- regula/facesdk/webclient/gen/models/update_group.py +85 -0
- regula/facesdk/webclient/gen/py.typed +0 -0
- regula/facesdk/webclient/gen/rest.py +136 -232
- {regula_facesdk_webclient-7.2.388.dev0.dist-info → regula_facesdk_webclient-8.1.433.dev0.dist-info}/METADATA +7 -4
- regula_facesdk_webclient-8.1.433.dev0.dist-info/RECORD +125 -0
- {regula_facesdk_webclient-7.2.388.dev0.dist-info → regula_facesdk_webclient-8.1.433.dev0.dist-info}/WHEEL +1 -1
- regula/facesdk/webclient/gen/api/diagnostics_api.py +0 -162
- regula/facesdk/webclient/gen/api/liveness_2_0_api.py +0 -306
- regula/facesdk/webclient/gen/api/liveness_api.py +0 -424
- regula/facesdk/webclient/gen/apis/__init__.py +0 -22
- regula/facesdk/webclient/gen/model/__init__.py +0 -5
- regula/facesdk/webclient/gen/model/add_image_to_person_request.py +0 -261
- regula/facesdk/webclient/gen/model/add_image_to_person_request_image.py +0 -204
- regula/facesdk/webclient/gen/model/add_image_to_person_response.py +0 -262
- regula/facesdk/webclient/gen/model/attribute_config.py +0 -120
- regula/facesdk/webclient/gen/model/attribute_config_list.py +0 -92
- regula/facesdk/webclient/gen/model/crop.py +0 -180
- regula/facesdk/webclient/gen/model/detect_attributes_details.py +0 -150
- regula/facesdk/webclient/gen/model/detect_details_meta.py +0 -178
- regula/facesdk/webclient/gen/model/detect_request.py +0 -232
- regula/facesdk/webclient/gen/model/detect_request_attributes.py +0 -120
- regula/facesdk/webclient/gen/model/detect_response.py +0 -147
- regula/facesdk/webclient/gen/model/detect_response_all_of.py +0 -120
- regula/facesdk/webclient/gen/model/detect_result.py +0 -235
- regula/facesdk/webclient/gen/model/detection.py +0 -230
- regula/facesdk/webclient/gen/model/detection_attributes.py +0 -150
- regula/facesdk/webclient/gen/model/detection_face.py +0 -232
- regula/facesdk/webclient/gen/model/detection_quality.py +0 -234
- regula/facesdk/webclient/gen/model/device_info.py +0 -231
- regula/facesdk/webclient/gen/model/face_align_type_quality.py +0 -109
- regula/facesdk/webclient/gen/model/face_attribute.py +0 -133
- regula/facesdk/webclient/gen/model/face_image_quality_align_type.py +0 -109
- regula/facesdk/webclient/gen/model/face_image_quality_groups.py +0 -118
- regula/facesdk/webclient/gen/model/face_image_quality_groups_strings.py +0 -118
- regula/facesdk/webclient/gen/model/face_image_quality_status.py +0 -103
- regula/facesdk/webclient/gen/model/face_quality_config_name.py +0 -238
- regula/facesdk/webclient/gen/model/face_quality_scenarios.py +0 -124
- regula/facesdk/webclient/gen/model/face_quality_status.py +0 -103
- regula/facesdk/webclient/gen/model/face_rectangular.py +0 -92
- regula/facesdk/webclient/gen/model/face_sdk_result.py +0 -121
- regula/facesdk/webclient/gen/model/face_sdk_result_code.py +0 -217
- regula/facesdk/webclient/gen/model/faces_response.py +0 -258
- regula/facesdk/webclient/gen/model/faces_response_all_of.py +0 -148
- regula/facesdk/webclient/gen/model/filter_op.py +0 -100
- regula/facesdk/webclient/gen/model/filter_search_request.py +0 -176
- regula/facesdk/webclient/gen/model/group.py +0 -206
- regula/facesdk/webclient/gen/model/group_all_of.py +0 -150
- regula/facesdk/webclient/gen/model/group_page.py +0 -178
- regula/facesdk/webclient/gen/model/group_page_all_of.py +0 -122
- regula/facesdk/webclient/gen/model/group_response.py +0 -150
- regula/facesdk/webclient/gen/model/group_to_create.py +0 -180
- regula/facesdk/webclient/gen/model/image.py +0 -318
- regula/facesdk/webclient/gen/model/image_fields.py +0 -258
- regula/facesdk/webclient/gen/model/image_fields_image.py +0 -204
- regula/facesdk/webclient/gen/model/image_page.py +0 -176
- regula/facesdk/webclient/gen/model/image_page_all_of.py +0 -120
- regula/facesdk/webclient/gen/model/image_source.py +0 -115
- regula/facesdk/webclient/gen/model/liveness_transaction.py +0 -334
- regula/facesdk/webclient/gen/model/liveness_type.py +0 -100
- regula/facesdk/webclient/gen/model/match_and_search_request.py +0 -290
- regula/facesdk/webclient/gen/model/match_and_search_request_all_of.py +0 -234
- regula/facesdk/webclient/gen/model/match_and_search_request_all_of_images.py +0 -148
- regula/facesdk/webclient/gen/model/match_and_search_request_images.py +0 -176
- regula/facesdk/webclient/gen/model/match_and_search_response.py +0 -233
- regula/facesdk/webclient/gen/model/match_and_search_response_all_of.py +0 -206
- regula/facesdk/webclient/gen/model/match_and_search_response_all_of_detections.py +0 -176
- regula/facesdk/webclient/gen/model/match_image.py +0 -205
- regula/facesdk/webclient/gen/model/match_image_detection.py +0 -178
- regula/facesdk/webclient/gen/model/match_image_result.py +0 -316
- regula/facesdk/webclient/gen/model/match_request.py +0 -233
- regula/facesdk/webclient/gen/model/match_request_output_image_params.py +0 -148
- regula/facesdk/webclient/gen/model/match_request_output_image_params_crop.py +0 -212
- regula/facesdk/webclient/gen/model/match_response.py +0 -205
- regula/facesdk/webclient/gen/model/match_response_all_of.py +0 -178
- regula/facesdk/webclient/gen/model/operation_log.py +0 -206
- regula/facesdk/webclient/gen/model/output_image_params.py +0 -146
- regula/facesdk/webclient/gen/model/page.py +0 -150
- regula/facesdk/webclient/gen/model/person.py +0 -319
- regula/facesdk/webclient/gen/model/person_all_of.py +0 -206
- regula/facesdk/webclient/gen/model/person_created_response.py +0 -178
- regula/facesdk/webclient/gen/model/person_fields.py +0 -235
- regula/facesdk/webclient/gen/model/person_to_update_fields.py +0 -206
- regula/facesdk/webclient/gen/model/person_with_images.py +0 -347
- regula/facesdk/webclient/gen/model/person_with_images_all_of.py +0 -122
- regula/facesdk/webclient/gen/model/persons_page.py +0 -176
- regula/facesdk/webclient/gen/model/persons_page_all_of.py +0 -120
- regula/facesdk/webclient/gen/model/persons_request.py +0 -291
- regula/facesdk/webclient/gen/model/persons_request_all_of.py +0 -150
- regula/facesdk/webclient/gen/model/process_param.py +0 -226
- regula/facesdk/webclient/gen/model/process_param_attributes.py +0 -120
- regula/facesdk/webclient/gen/model/quality_config.py +0 -154
- regula/facesdk/webclient/gen/model/quality_config_list.py +0 -92
- regula/facesdk/webclient/gen/model/quality_detail.py +0 -234
- regula/facesdk/webclient/gen/model/quality_details_groups.py +0 -202
- regula/facesdk/webclient/gen/model/quality_request.py +0 -146
- regula/facesdk/webclient/gen/model/recognize_image.py +0 -374
- regula/facesdk/webclient/gen/model/recognize_image_all_of.py +0 -150
- regula/facesdk/webclient/gen/model/resize_options.py +0 -178
- regula/facesdk/webclient/gen/model/rgb.py +0 -92
- regula/facesdk/webclient/gen/model/search_bad_params.py +0 -172
- regula/facesdk/webclient/gen/model/search_detection.py +0 -398
- regula/facesdk/webclient/gen/model/search_parameters.py +0 -174
- regula/facesdk/webclient/gen/model/search_parameters_create_person.py +0 -177
- regula/facesdk/webclient/gen/model/search_person.py +0 -373
- regula/facesdk/webclient/gen/model/search_person_all_of.py +0 -148
- regula/facesdk/webclient/gen/model/search_request.py +0 -394
- regula/facesdk/webclient/gen/model/search_request_all_of.py +0 -150
- regula/facesdk/webclient/gen/model/search_result.py +0 -150
- regula/facesdk/webclient/gen/model/search_result_all_of.py +0 -122
- regula/facesdk/webclient/gen/model/transaction_config.py +0 -92
- regula/facesdk/webclient/gen/model/transaction_info.py +0 -344
- regula/facesdk/webclient/gen/model/update_group.py +0 -150
- regula/facesdk/webclient/gen/model_utils.py +0 -2037
- regula_facesdk_webclient-7.2.388.dev0.dist-info/RECORD +0 -138
- {regula_facesdk_webclient-7.2.388.dev0.dist-info → regula_facesdk_webclient-8.1.433.dev0.dist-info}/top_level.txt +0 -0
|
@@ -1,287 +1,547 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
Regula Face SDK Web API
|
|
5
|
-
|
|
6
|
-
<a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core # noqa: E501
|
|
7
|
-
|
|
8
|
-
The version of the OpenAPI document: 7.2.0
|
|
9
4
|
Generated by: https://openapi-generator.tech
|
|
10
5
|
"""
|
|
6
|
+
import warnings
|
|
7
|
+
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
|
8
|
+
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
9
|
+
from typing_extensions import Annotated
|
|
11
10
|
|
|
11
|
+
from pydantic import Field, StrictStr
|
|
12
|
+
from typing import Optional
|
|
13
|
+
from typing_extensions import Annotated
|
|
14
|
+
from regula.facesdk.webclient.gen.models.device_info import DeviceInfo
|
|
12
15
|
|
|
13
|
-
from
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
# python 2 and python 3 compatibility library
|
|
18
|
-
import six
|
|
19
|
-
|
|
20
|
-
from regula.facesdk.webclient.gen.api_client import ApiClient
|
|
21
|
-
from regula.facesdk.webclient.gen.exceptions import ( # noqa: F401
|
|
22
|
-
ApiTypeError,
|
|
23
|
-
ApiValueError
|
|
24
|
-
)
|
|
16
|
+
from regula.facesdk.webclient.gen.api_client import ApiClient, RequestSerialized
|
|
17
|
+
from regula.facesdk.webclient.gen.api_response import ApiResponse
|
|
18
|
+
from regula.facesdk.webclient.gen.rest import RESTResponseType
|
|
25
19
|
|
|
26
20
|
|
|
27
|
-
class HealthcheckApi
|
|
21
|
+
class HealthcheckApi:
|
|
28
22
|
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
29
23
|
Ref: https://openapi-generator.tech
|
|
30
24
|
|
|
31
25
|
Do not edit the class manually.
|
|
32
26
|
"""
|
|
33
27
|
|
|
34
|
-
def __init__(self, api_client=None):
|
|
28
|
+
def __init__(self, api_client=None) -> None:
|
|
35
29
|
if api_client is None:
|
|
36
|
-
api_client = ApiClient()
|
|
30
|
+
api_client = ApiClient.get_default()
|
|
37
31
|
self.api_client = api_client
|
|
38
32
|
|
|
39
|
-
def healthz(self, **kwargs): # noqa: E501
|
|
40
|
-
"""Server healthcheck # noqa: E501
|
|
41
33
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
34
|
+
@validate_call
|
|
35
|
+
def healthz(
|
|
36
|
+
self,
|
|
37
|
+
x_request_id: Annotated[Optional[StrictStr], Field(description="Request header label.")] = None,
|
|
38
|
+
_request_timeout: Union[
|
|
39
|
+
None,
|
|
40
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
41
|
+
Tuple[
|
|
42
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
43
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
44
|
+
]
|
|
45
|
+
] = None,
|
|
46
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
47
|
+
_content_type: Optional[StrictStr] = None,
|
|
48
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
49
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
50
|
+
) -> DeviceInfo:
|
|
51
|
+
"""Server healthcheck
|
|
45
52
|
|
|
46
|
-
|
|
47
|
-
>>> result = thread.get()
|
|
53
|
+
The `/api/healthz` endpoint performs a server health check, providing details such as the application name, license ID, serial number, validity, and product version. <br><br>Comprehensive information about service diagnostics is available on the [Monitoring page](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/monitoring/).
|
|
48
54
|
|
|
49
55
|
:param x_request_id: Request header label.
|
|
50
56
|
:type x_request_id: str
|
|
51
|
-
:param async_req: Whether to execute the request asynchronously.
|
|
52
|
-
:type async_req: bool, optional
|
|
53
|
-
:param _preload_content: if False, the urllib3.HTTPResponse object will
|
|
54
|
-
be returned without reading/decoding response
|
|
55
|
-
data. Default is True.
|
|
56
|
-
:type _preload_content: bool, optional
|
|
57
57
|
:param _request_timeout: timeout setting for this request. If one
|
|
58
58
|
number provided, it will be total request
|
|
59
59
|
timeout. It can also be a pair (tuple) of
|
|
60
60
|
(connection, read) timeouts.
|
|
61
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
62
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
63
|
+
request; this effectively ignores the
|
|
64
|
+
authentication in the spec for a single request.
|
|
65
|
+
:type _request_auth: dict, optional
|
|
66
|
+
:param _content_type: force content-type for the request.
|
|
67
|
+
:type _content_type: str, Optional
|
|
68
|
+
:param _headers: set to override the headers for a single
|
|
69
|
+
request; this effectively ignores the headers
|
|
70
|
+
in the spec for a single request.
|
|
71
|
+
:type _headers: dict, optional
|
|
72
|
+
:param _host_index: set to override the host_index for a single
|
|
73
|
+
request; this effectively ignores the host_index
|
|
74
|
+
in the spec for a single request.
|
|
75
|
+
:type _host_index: int, optional
|
|
61
76
|
:return: Returns the result object.
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
77
|
+
""" # noqa: E501
|
|
78
|
+
|
|
79
|
+
_param = self._healthz_serialize(
|
|
80
|
+
x_request_id=x_request_id,
|
|
81
|
+
_request_auth=_request_auth,
|
|
82
|
+
_content_type=_content_type,
|
|
83
|
+
_headers=_headers,
|
|
84
|
+
_host_index=_host_index
|
|
85
|
+
)
|
|
71
86
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
87
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
88
|
+
'200': "DeviceInfo",
|
|
89
|
+
}
|
|
90
|
+
response_data = self.api_client.call_api(
|
|
91
|
+
*_param,
|
|
92
|
+
_request_timeout=_request_timeout
|
|
93
|
+
)
|
|
94
|
+
response_data.read()
|
|
95
|
+
return self.api_client.response_deserialize(
|
|
96
|
+
response_data=response_data,
|
|
97
|
+
response_types_map=_response_types_map,
|
|
98
|
+
).data
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
@validate_call
|
|
102
|
+
def healthz_with_http_info(
|
|
103
|
+
self,
|
|
104
|
+
x_request_id: Annotated[Optional[StrictStr], Field(description="Request header label.")] = None,
|
|
105
|
+
_request_timeout: Union[
|
|
106
|
+
None,
|
|
107
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
108
|
+
Tuple[
|
|
109
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
110
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
111
|
+
]
|
|
112
|
+
] = None,
|
|
113
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
114
|
+
_content_type: Optional[StrictStr] = None,
|
|
115
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
116
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
117
|
+
) -> ApiResponse[DeviceInfo]:
|
|
118
|
+
"""Server healthcheck
|
|
75
119
|
|
|
76
|
-
|
|
77
|
-
>>> result = thread.get()
|
|
120
|
+
The `/api/healthz` endpoint performs a server health check, providing details such as the application name, license ID, serial number, validity, and product version. <br><br>Comprehensive information about service diagnostics is available on the [Monitoring page](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/monitoring/).
|
|
78
121
|
|
|
79
122
|
:param x_request_id: Request header label.
|
|
80
123
|
:type x_request_id: str
|
|
81
|
-
:param async_req: Whether to execute the request asynchronously.
|
|
82
|
-
:type async_req: bool, optional
|
|
83
|
-
:param _return_http_data_only: response data without head status code
|
|
84
|
-
and headers
|
|
85
|
-
:type _return_http_data_only: bool, optional
|
|
86
|
-
:param _preload_content: if False, the urllib3.HTTPResponse object will
|
|
87
|
-
be returned without reading/decoding response
|
|
88
|
-
data. Default is True.
|
|
89
|
-
:type _preload_content: bool, optional
|
|
90
124
|
:param _request_timeout: timeout setting for this request. If one
|
|
91
125
|
number provided, it will be total request
|
|
92
126
|
timeout. It can also be a pair (tuple) of
|
|
93
127
|
(connection, read) timeouts.
|
|
128
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
94
129
|
:param _request_auth: set to override the auth_settings for an a single
|
|
95
|
-
request; this effectively ignores the
|
|
96
|
-
in the spec for a single request.
|
|
130
|
+
request; this effectively ignores the
|
|
131
|
+
authentication in the spec for a single request.
|
|
97
132
|
:type _request_auth: dict, optional
|
|
133
|
+
:param _content_type: force content-type for the request.
|
|
134
|
+
:type _content_type: str, Optional
|
|
135
|
+
:param _headers: set to override the headers for a single
|
|
136
|
+
request; this effectively ignores the headers
|
|
137
|
+
in the spec for a single request.
|
|
138
|
+
:type _headers: dict, optional
|
|
139
|
+
:param _host_index: set to override the host_index for a single
|
|
140
|
+
request; this effectively ignores the host_index
|
|
141
|
+
in the spec for a single request.
|
|
142
|
+
:type _host_index: int, optional
|
|
98
143
|
:return: Returns the result object.
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
144
|
+
""" # noqa: E501
|
|
145
|
+
|
|
146
|
+
_param = self._healthz_serialize(
|
|
147
|
+
x_request_id=x_request_id,
|
|
148
|
+
_request_auth=_request_auth,
|
|
149
|
+
_content_type=_content_type,
|
|
150
|
+
_headers=_headers,
|
|
151
|
+
_host_index=_host_index
|
|
152
|
+
)
|
|
153
|
+
|
|
154
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
155
|
+
'200': "DeviceInfo",
|
|
156
|
+
}
|
|
157
|
+
response_data = self.api_client.call_api(
|
|
158
|
+
*_param,
|
|
159
|
+
_request_timeout=_request_timeout
|
|
160
|
+
)
|
|
161
|
+
response_data.read()
|
|
162
|
+
return self.api_client.response_deserialize(
|
|
163
|
+
response_data=response_data,
|
|
164
|
+
response_types_map=_response_types_map,
|
|
165
|
+
)
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
@validate_call
|
|
169
|
+
def healthz_without_preload_content(
|
|
170
|
+
self,
|
|
171
|
+
x_request_id: Annotated[Optional[StrictStr], Field(description="Request header label.")] = None,
|
|
172
|
+
_request_timeout: Union[
|
|
173
|
+
None,
|
|
174
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
175
|
+
Tuple[
|
|
176
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
177
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
178
|
+
]
|
|
179
|
+
] = None,
|
|
180
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
181
|
+
_content_type: Optional[StrictStr] = None,
|
|
182
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
183
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
184
|
+
) -> RESTResponseType:
|
|
185
|
+
"""Server healthcheck
|
|
186
|
+
|
|
187
|
+
The `/api/healthz` endpoint performs a server health check, providing details such as the application name, license ID, serial number, validity, and product version. <br><br>Comprehensive information about service diagnostics is available on the [Monitoring page](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/monitoring/).
|
|
103
188
|
|
|
104
|
-
|
|
189
|
+
:param x_request_id: Request header label.
|
|
190
|
+
:type x_request_id: str
|
|
191
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
192
|
+
number provided, it will be total request
|
|
193
|
+
timeout. It can also be a pair (tuple) of
|
|
194
|
+
(connection, read) timeouts.
|
|
195
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
196
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
197
|
+
request; this effectively ignores the
|
|
198
|
+
authentication in the spec for a single request.
|
|
199
|
+
:type _request_auth: dict, optional
|
|
200
|
+
:param _content_type: force content-type for the request.
|
|
201
|
+
:type _content_type: str, Optional
|
|
202
|
+
:param _headers: set to override the headers for a single
|
|
203
|
+
request; this effectively ignores the headers
|
|
204
|
+
in the spec for a single request.
|
|
205
|
+
:type _headers: dict, optional
|
|
206
|
+
:param _host_index: set to override the host_index for a single
|
|
207
|
+
request; this effectively ignores the host_index
|
|
208
|
+
in the spec for a single request.
|
|
209
|
+
:type _host_index: int, optional
|
|
210
|
+
:return: Returns the result object.
|
|
211
|
+
""" # noqa: E501
|
|
212
|
+
|
|
213
|
+
_param = self._healthz_serialize(
|
|
214
|
+
x_request_id=x_request_id,
|
|
215
|
+
_request_auth=_request_auth,
|
|
216
|
+
_content_type=_content_type,
|
|
217
|
+
_headers=_headers,
|
|
218
|
+
_host_index=_host_index
|
|
219
|
+
)
|
|
105
220
|
|
|
106
|
-
|
|
107
|
-
'
|
|
221
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
222
|
+
'200': "DeviceInfo",
|
|
223
|
+
}
|
|
224
|
+
response_data = self.api_client.call_api(
|
|
225
|
+
*_param,
|
|
226
|
+
_request_timeout=_request_timeout
|
|
227
|
+
)
|
|
228
|
+
return response_data.response
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
def _healthz_serialize(
|
|
232
|
+
self,
|
|
233
|
+
x_request_id,
|
|
234
|
+
_request_auth,
|
|
235
|
+
_content_type,
|
|
236
|
+
_headers,
|
|
237
|
+
_host_index,
|
|
238
|
+
) -> RequestSerialized:
|
|
239
|
+
|
|
240
|
+
_host = None
|
|
241
|
+
|
|
242
|
+
_collection_formats: Dict[str, str] = {
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
_path_params: Dict[str, str] = {}
|
|
246
|
+
_query_params: List[Tuple[str, str]] = []
|
|
247
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
248
|
+
_form_params: List[Tuple[str, str]] = []
|
|
249
|
+
_files: Dict[
|
|
250
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
251
|
+
] = {}
|
|
252
|
+
_body_params: Optional[bytes] = None
|
|
253
|
+
|
|
254
|
+
# process the path parameters
|
|
255
|
+
# process the query parameters
|
|
256
|
+
# process the header parameters
|
|
257
|
+
if x_request_id is not None:
|
|
258
|
+
_header_params['X-RequestID'] = x_request_id
|
|
259
|
+
# process the form parameters
|
|
260
|
+
# process the body parameter
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
# set the HTTP header `Accept`
|
|
264
|
+
if 'Accept' not in _header_params:
|
|
265
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
266
|
+
[
|
|
267
|
+
'application/json'
|
|
268
|
+
]
|
|
269
|
+
)
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
# authentication setting
|
|
273
|
+
_auth_settings: List[str] = [
|
|
108
274
|
]
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
275
|
+
|
|
276
|
+
return self.api_client.param_serialize(
|
|
277
|
+
method='GET',
|
|
278
|
+
resource_path='/api/healthz',
|
|
279
|
+
path_params=_path_params,
|
|
280
|
+
query_params=_query_params,
|
|
281
|
+
header_params=_header_params,
|
|
282
|
+
body=_body_params,
|
|
283
|
+
post_params=_form_params,
|
|
284
|
+
files=_files,
|
|
285
|
+
auth_settings=_auth_settings,
|
|
286
|
+
collection_formats=_collection_formats,
|
|
287
|
+
_host=_host,
|
|
288
|
+
_request_auth=_request_auth
|
|
289
|
+
)
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
@validate_call
|
|
295
|
+
def readyz(
|
|
296
|
+
self,
|
|
297
|
+
x_request_id: Annotated[Optional[StrictStr], Field(description="Request header label.")] = None,
|
|
298
|
+
_request_timeout: Union[
|
|
299
|
+
None,
|
|
300
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
301
|
+
Tuple[
|
|
302
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
303
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
116
304
|
]
|
|
305
|
+
] = None,
|
|
306
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
307
|
+
_content_type: Optional[StrictStr] = None,
|
|
308
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
309
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
310
|
+
) -> None:
|
|
311
|
+
"""License healthcheck
|
|
312
|
+
|
|
313
|
+
The `/api/readyz` endpoint checks the license's health to determine if the application is ready for operation. It validates the license and returns a response indicating whether the license is valid (`200`) or invalid (`400`).
|
|
314
|
+
|
|
315
|
+
:param x_request_id: Request header label.
|
|
316
|
+
:type x_request_id: str
|
|
317
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
318
|
+
number provided, it will be total request
|
|
319
|
+
timeout. It can also be a pair (tuple) of
|
|
320
|
+
(connection, read) timeouts.
|
|
321
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
322
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
323
|
+
request; this effectively ignores the
|
|
324
|
+
authentication in the spec for a single request.
|
|
325
|
+
:type _request_auth: dict, optional
|
|
326
|
+
:param _content_type: force content-type for the request.
|
|
327
|
+
:type _content_type: str, Optional
|
|
328
|
+
:param _headers: set to override the headers for a single
|
|
329
|
+
request; this effectively ignores the headers
|
|
330
|
+
in the spec for a single request.
|
|
331
|
+
:type _headers: dict, optional
|
|
332
|
+
:param _host_index: set to override the host_index for a single
|
|
333
|
+
request; this effectively ignores the host_index
|
|
334
|
+
in the spec for a single request.
|
|
335
|
+
:type _host_index: int, optional
|
|
336
|
+
:return: Returns the result object.
|
|
337
|
+
""" # noqa: E501
|
|
338
|
+
|
|
339
|
+
_param = self._readyz_serialize(
|
|
340
|
+
x_request_id=x_request_id,
|
|
341
|
+
_request_auth=_request_auth,
|
|
342
|
+
_content_type=_content_type,
|
|
343
|
+
_headers=_headers,
|
|
344
|
+
_host_index=_host_index
|
|
117
345
|
)
|
|
118
346
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
body=body_params,
|
|
155
|
-
post_params=form_params,
|
|
156
|
-
files=local_var_files,
|
|
157
|
-
response_type='DeviceInfo', # noqa: E501
|
|
158
|
-
auth_settings=auth_settings,
|
|
159
|
-
async_req=local_var_params.get('async_req'),
|
|
160
|
-
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
|
|
161
|
-
_preload_content=local_var_params.get('_preload_content', True),
|
|
162
|
-
_request_timeout=local_var_params.get('_request_timeout'),
|
|
163
|
-
collection_formats=collection_formats,
|
|
164
|
-
_request_auth=local_var_params.get('_request_auth'))
|
|
165
|
-
|
|
166
|
-
def readyz(self, **kwargs): # noqa: E501
|
|
167
|
-
"""License healthcheck # noqa: E501
|
|
168
|
-
|
|
169
|
-
The `/api/readyz` endpoint checks the license's health to determine if the application is ready for operation. It validates the license and returns a response indicating whether the license is valid (`200`) or invalid (`400`). # noqa: E501
|
|
170
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
171
|
-
asynchronous HTTP request, please pass async_req=True
|
|
172
|
-
|
|
173
|
-
>>> thread = api.readyz(async_req=True)
|
|
174
|
-
>>> result = thread.get()
|
|
347
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
348
|
+
'200': None,
|
|
349
|
+
'400': None,
|
|
350
|
+
}
|
|
351
|
+
response_data = self.api_client.call_api(
|
|
352
|
+
*_param,
|
|
353
|
+
_request_timeout=_request_timeout
|
|
354
|
+
)
|
|
355
|
+
response_data.read()
|
|
356
|
+
return self.api_client.response_deserialize(
|
|
357
|
+
response_data=response_data,
|
|
358
|
+
response_types_map=_response_types_map,
|
|
359
|
+
).data
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
@validate_call
|
|
363
|
+
def readyz_with_http_info(
|
|
364
|
+
self,
|
|
365
|
+
x_request_id: Annotated[Optional[StrictStr], Field(description="Request header label.")] = None,
|
|
366
|
+
_request_timeout: Union[
|
|
367
|
+
None,
|
|
368
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
369
|
+
Tuple[
|
|
370
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
371
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
372
|
+
]
|
|
373
|
+
] = None,
|
|
374
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
375
|
+
_content_type: Optional[StrictStr] = None,
|
|
376
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
377
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
378
|
+
) -> ApiResponse[None]:
|
|
379
|
+
"""License healthcheck
|
|
380
|
+
|
|
381
|
+
The `/api/readyz` endpoint checks the license's health to determine if the application is ready for operation. It validates the license and returns a response indicating whether the license is valid (`200`) or invalid (`400`).
|
|
175
382
|
|
|
176
383
|
:param x_request_id: Request header label.
|
|
177
384
|
:type x_request_id: str
|
|
178
|
-
:param async_req: Whether to execute the request asynchronously.
|
|
179
|
-
:type async_req: bool, optional
|
|
180
|
-
:param _preload_content: if False, the urllib3.HTTPResponse object will
|
|
181
|
-
be returned without reading/decoding response
|
|
182
|
-
data. Default is True.
|
|
183
|
-
:type _preload_content: bool, optional
|
|
184
385
|
:param _request_timeout: timeout setting for this request. If one
|
|
185
386
|
number provided, it will be total request
|
|
186
387
|
timeout. It can also be a pair (tuple) of
|
|
187
388
|
(connection, read) timeouts.
|
|
389
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
390
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
391
|
+
request; this effectively ignores the
|
|
392
|
+
authentication in the spec for a single request.
|
|
393
|
+
:type _request_auth: dict, optional
|
|
394
|
+
:param _content_type: force content-type for the request.
|
|
395
|
+
:type _content_type: str, Optional
|
|
396
|
+
:param _headers: set to override the headers for a single
|
|
397
|
+
request; this effectively ignores the headers
|
|
398
|
+
in the spec for a single request.
|
|
399
|
+
:type _headers: dict, optional
|
|
400
|
+
:param _host_index: set to override the host_index for a single
|
|
401
|
+
request; this effectively ignores the host_index
|
|
402
|
+
in the spec for a single request.
|
|
403
|
+
:type _host_index: int, optional
|
|
188
404
|
:return: Returns the result object.
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
405
|
+
""" # noqa: E501
|
|
406
|
+
|
|
407
|
+
_param = self._readyz_serialize(
|
|
408
|
+
x_request_id=x_request_id,
|
|
409
|
+
_request_auth=_request_auth,
|
|
410
|
+
_content_type=_content_type,
|
|
411
|
+
_headers=_headers,
|
|
412
|
+
_host_index=_host_index
|
|
413
|
+
)
|
|
195
414
|
|
|
196
|
-
|
|
197
|
-
|
|
415
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
416
|
+
'200': None,
|
|
417
|
+
'400': None,
|
|
418
|
+
}
|
|
419
|
+
response_data = self.api_client.call_api(
|
|
420
|
+
*_param,
|
|
421
|
+
_request_timeout=_request_timeout
|
|
422
|
+
)
|
|
423
|
+
response_data.read()
|
|
424
|
+
return self.api_client.response_deserialize(
|
|
425
|
+
response_data=response_data,
|
|
426
|
+
response_types_map=_response_types_map,
|
|
427
|
+
)
|
|
198
428
|
|
|
199
|
-
The `/api/readyz` endpoint checks the license's health to determine if the application is ready for operation. It validates the license and returns a response indicating whether the license is valid (`200`) or invalid (`400`). # noqa: E501
|
|
200
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
201
|
-
asynchronous HTTP request, please pass async_req=True
|
|
202
429
|
|
|
203
|
-
|
|
204
|
-
|
|
430
|
+
@validate_call
|
|
431
|
+
def readyz_without_preload_content(
|
|
432
|
+
self,
|
|
433
|
+
x_request_id: Annotated[Optional[StrictStr], Field(description="Request header label.")] = None,
|
|
434
|
+
_request_timeout: Union[
|
|
435
|
+
None,
|
|
436
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
437
|
+
Tuple[
|
|
438
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
439
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
440
|
+
]
|
|
441
|
+
] = None,
|
|
442
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
443
|
+
_content_type: Optional[StrictStr] = None,
|
|
444
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
445
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
446
|
+
) -> RESTResponseType:
|
|
447
|
+
"""License healthcheck
|
|
448
|
+
|
|
449
|
+
The `/api/readyz` endpoint checks the license's health to determine if the application is ready for operation. It validates the license and returns a response indicating whether the license is valid (`200`) or invalid (`400`).
|
|
205
450
|
|
|
206
451
|
:param x_request_id: Request header label.
|
|
207
452
|
:type x_request_id: str
|
|
208
|
-
:param async_req: Whether to execute the request asynchronously.
|
|
209
|
-
:type async_req: bool, optional
|
|
210
|
-
:param _return_http_data_only: response data without head status code
|
|
211
|
-
and headers
|
|
212
|
-
:type _return_http_data_only: bool, optional
|
|
213
|
-
:param _preload_content: if False, the urllib3.HTTPResponse object will
|
|
214
|
-
be returned without reading/decoding response
|
|
215
|
-
data. Default is True.
|
|
216
|
-
:type _preload_content: bool, optional
|
|
217
453
|
:param _request_timeout: timeout setting for this request. If one
|
|
218
454
|
number provided, it will be total request
|
|
219
455
|
timeout. It can also be a pair (tuple) of
|
|
220
456
|
(connection, read) timeouts.
|
|
457
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
221
458
|
:param _request_auth: set to override the auth_settings for an a single
|
|
222
|
-
request; this effectively ignores the
|
|
223
|
-
in the spec for a single request.
|
|
459
|
+
request; this effectively ignores the
|
|
460
|
+
authentication in the spec for a single request.
|
|
224
461
|
:type _request_auth: dict, optional
|
|
462
|
+
:param _content_type: force content-type for the request.
|
|
463
|
+
:type _content_type: str, Optional
|
|
464
|
+
:param _headers: set to override the headers for a single
|
|
465
|
+
request; this effectively ignores the headers
|
|
466
|
+
in the spec for a single request.
|
|
467
|
+
:type _headers: dict, optional
|
|
468
|
+
:param _host_index: set to override the host_index for a single
|
|
469
|
+
request; this effectively ignores the host_index
|
|
470
|
+
in the spec for a single request.
|
|
471
|
+
:type _host_index: int, optional
|
|
225
472
|
:return: Returns the result object.
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
473
|
+
""" # noqa: E501
|
|
474
|
+
|
|
475
|
+
_param = self._readyz_serialize(
|
|
476
|
+
x_request_id=x_request_id,
|
|
477
|
+
_request_auth=_request_auth,
|
|
478
|
+
_content_type=_content_type,
|
|
479
|
+
_headers=_headers,
|
|
480
|
+
_host_index=_host_index
|
|
481
|
+
)
|
|
482
|
+
|
|
483
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
484
|
+
'200': None,
|
|
485
|
+
'400': None,
|
|
486
|
+
}
|
|
487
|
+
response_data = self.api_client.call_api(
|
|
488
|
+
*_param,
|
|
489
|
+
_request_timeout=_request_timeout
|
|
490
|
+
)
|
|
491
|
+
return response_data.response
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
def _readyz_serialize(
|
|
495
|
+
self,
|
|
496
|
+
x_request_id,
|
|
497
|
+
_request_auth,
|
|
498
|
+
_content_type,
|
|
499
|
+
_headers,
|
|
500
|
+
_host_index,
|
|
501
|
+
) -> RequestSerialized:
|
|
230
502
|
|
|
231
|
-
|
|
503
|
+
_host = None
|
|
232
504
|
|
|
233
|
-
|
|
234
|
-
|
|
505
|
+
_collection_formats: Dict[str, str] = {
|
|
506
|
+
}
|
|
507
|
+
|
|
508
|
+
_path_params: Dict[str, str] = {}
|
|
509
|
+
_query_params: List[Tuple[str, str]] = []
|
|
510
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
511
|
+
_form_params: List[Tuple[str, str]] = []
|
|
512
|
+
_files: Dict[
|
|
513
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
514
|
+
] = {}
|
|
515
|
+
_body_params: Optional[bytes] = None
|
|
516
|
+
|
|
517
|
+
# process the path parameters
|
|
518
|
+
# process the query parameters
|
|
519
|
+
# process the header parameters
|
|
520
|
+
if x_request_id is not None:
|
|
521
|
+
_header_params['X-RequestID'] = x_request_id
|
|
522
|
+
# process the form parameters
|
|
523
|
+
# process the body parameter
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
# authentication setting
|
|
529
|
+
_auth_settings: List[str] = [
|
|
235
530
|
]
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
531
|
+
|
|
532
|
+
return self.api_client.param_serialize(
|
|
533
|
+
method='GET',
|
|
534
|
+
resource_path='/api/readyz',
|
|
535
|
+
path_params=_path_params,
|
|
536
|
+
query_params=_query_params,
|
|
537
|
+
header_params=_header_params,
|
|
538
|
+
body=_body_params,
|
|
539
|
+
post_params=_form_params,
|
|
540
|
+
files=_files,
|
|
541
|
+
auth_settings=_auth_settings,
|
|
542
|
+
collection_formats=_collection_formats,
|
|
543
|
+
_host=_host,
|
|
544
|
+
_request_auth=_request_auth
|
|
244
545
|
)
|
|
245
546
|
|
|
246
|
-
|
|
247
|
-
if key not in all_params:
|
|
248
|
-
raise ApiTypeError(
|
|
249
|
-
"Got an unexpected keyword argument '%s'"
|
|
250
|
-
" to method readyz" % key
|
|
251
|
-
)
|
|
252
|
-
local_var_params[key] = val
|
|
253
|
-
del local_var_params['kwargs']
|
|
254
|
-
|
|
255
|
-
collection_formats = {}
|
|
256
|
-
|
|
257
|
-
path_params = {}
|
|
258
|
-
|
|
259
|
-
query_params = []
|
|
260
|
-
|
|
261
|
-
header_params = {}
|
|
262
|
-
if 'x_request_id' in local_var_params:
|
|
263
|
-
header_params['X-RequestID'] = local_var_params['x_request_id'] # noqa: E501
|
|
264
|
-
|
|
265
|
-
form_params = []
|
|
266
|
-
local_var_files = {}
|
|
267
|
-
|
|
268
|
-
body_params = None
|
|
269
|
-
# Authentication setting
|
|
270
|
-
auth_settings = [] # noqa: E501
|
|
271
|
-
|
|
272
|
-
return self.api_client.call_api(
|
|
273
|
-
'/api/readyz', 'GET',
|
|
274
|
-
path_params,
|
|
275
|
-
query_params,
|
|
276
|
-
header_params,
|
|
277
|
-
body=body_params,
|
|
278
|
-
post_params=form_params,
|
|
279
|
-
files=local_var_files,
|
|
280
|
-
response_type=None, # noqa: E501
|
|
281
|
-
auth_settings=auth_settings,
|
|
282
|
-
async_req=local_var_params.get('async_req'),
|
|
283
|
-
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
|
|
284
|
-
_preload_content=local_var_params.get('_preload_content', True),
|
|
285
|
-
_request_timeout=local_var_params.get('_request_timeout'),
|
|
286
|
-
collection_formats=collection_formats,
|
|
287
|
-
_request_auth=local_var_params.get('_request_auth'))
|
|
547
|
+
|