eval-studio-client 1.2.4a2__py3-none-any.whl → 1.3.0__py3-none-any.whl

eval_studio_client/api/api/dashboard_test_case_annotation_service_api.py

@@ -0,0 +1,611 @@
+# coding: utf-8
+
+"""
+    ai/h2o/eval_studio/v1/insight.proto
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: version not set
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictStr, field_validator
+from typing import Optional
+from typing_extensions import Annotated
+from eval_studio_client.api.models.required_the_dashboard_test_case_annotation_to_update import RequiredTheDashboardTestCaseAnnotationToUpdate
+from eval_studio_client.api.models.v1_list_dashboard_test_case_annotations_response import V1ListDashboardTestCaseAnnotationsResponse
+from eval_studio_client.api.models.v1_update_dashboard_test_case_annotation_response import V1UpdateDashboardTestCaseAnnotationResponse
+
+from eval_studio_client.api.api_client import ApiClient, RequestSerialized
+from eval_studio_client.api.api_response import ApiResponse
+from eval_studio_client.api.rest import RESTResponseType
+
+
+class DashboardTestCaseAnnotationServiceApi:
+    """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 dashboard_test_case_annotation_service_list_dashboard_test_case_annotations(
+        self,
+        parent: Annotated[str, Field(strict=True, description="Required. The parent resource name. Format: `dashboards/{dashboard}/testCases/{test_case}`.  Wildcard support: Use the special value `-` for test_case to list annotations across all test cases within the specified dashboard: `dashboards/{dashboard}/testCases/-`  See https://google.aip.dev/159 for more details on collection identifiers.")],
+        _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,
+    ) -> V1ListDashboardTestCaseAnnotationsResponse:
+        """dashboard_test_case_annotation_service_list_dashboard_test_case_annotations
+
+
+        :param parent: Required. The parent resource name. Format: `dashboards/{dashboard}/testCases/{test_case}`.  Wildcard support: Use the special value `-` for test_case to list annotations across all test cases within the specified dashboard: `dashboards/{dashboard}/testCases/-`  See https://google.aip.dev/159 for more details on collection identifiers. (required)
+        :type parent: 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.
+        """ # noqa: E501
+
+        _param = self._dashboard_test_case_annotation_service_list_dashboard_test_case_annotations_serialize(
+            parent=parent,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "V1ListDashboardTestCaseAnnotationsResponse",
+        }
+        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 dashboard_test_case_annotation_service_list_dashboard_test_case_annotations_with_http_info(
+        self,
+        parent: Annotated[str, Field(strict=True, description="Required. The parent resource name. Format: `dashboards/{dashboard}/testCases/{test_case}`.  Wildcard support: Use the special value `-` for test_case to list annotations across all test cases within the specified dashboard: `dashboards/{dashboard}/testCases/-`  See https://google.aip.dev/159 for more details on collection identifiers.")],
+        _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[V1ListDashboardTestCaseAnnotationsResponse]:
+        """dashboard_test_case_annotation_service_list_dashboard_test_case_annotations
+
+
+        :param parent: Required. The parent resource name. Format: `dashboards/{dashboard}/testCases/{test_case}`.  Wildcard support: Use the special value `-` for test_case to list annotations across all test cases within the specified dashboard: `dashboards/{dashboard}/testCases/-`  See https://google.aip.dev/159 for more details on collection identifiers. (required)
+        :type parent: 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.
+        """ # noqa: E501
+
+        _param = self._dashboard_test_case_annotation_service_list_dashboard_test_case_annotations_serialize(
+            parent=parent,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "V1ListDashboardTestCaseAnnotationsResponse",
+        }
+        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 dashboard_test_case_annotation_service_list_dashboard_test_case_annotations_without_preload_content(
+        self,
+        parent: Annotated[str, Field(strict=True, description="Required. The parent resource name. Format: `dashboards/{dashboard}/testCases/{test_case}`.  Wildcard support: Use the special value `-` for test_case to list annotations across all test cases within the specified dashboard: `dashboards/{dashboard}/testCases/-`  See https://google.aip.dev/159 for more details on collection identifiers.")],
+        _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:
+        """dashboard_test_case_annotation_service_list_dashboard_test_case_annotations
+
+
+        :param parent: Required. The parent resource name. Format: `dashboards/{dashboard}/testCases/{test_case}`.  Wildcard support: Use the special value `-` for test_case to list annotations across all test cases within the specified dashboard: `dashboards/{dashboard}/testCases/-`  See https://google.aip.dev/159 for more details on collection identifiers. (required)
+        :type parent: 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.
+        """ # noqa: E501
+
+        _param = self._dashboard_test_case_annotation_service_list_dashboard_test_case_annotations_serialize(
+            parent=parent,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "V1ListDashboardTestCaseAnnotationsResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _dashboard_test_case_annotation_service_list_dashboard_test_case_annotations_serialize(
+        self,
+        parent,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, Union[str, bytes]] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if parent is not None:
+            _path_params['parent'] = parent
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v1/{parent}/annotations',
+            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 dashboard_test_case_annotation_service_update_dashboard_test_case_annotation(
+        self,
+        dashboard_test_case_annotation_name: Annotated[str, Field(strict=True, description="Output only. Name of the DashboardTestCaseAnnotation resource. e.g.: \"dashboards/<UUID>/testCases/<UUID>/annotations/<UUID>\"")],
+        dashboard_test_case_annotation: Annotated[RequiredTheDashboardTestCaseAnnotationToUpdate, Field(description="Required. The DashboardTestCaseAnnotation to update.")],
+        update_mask: Annotated[Optional[StrictStr], Field(description="Optional. The list of fields to update. If empty, all modifiable fields will be updated. The following fields can be updated:  - value")] = None,
+        allow_missing: Annotated[Optional[StrictBool], Field(description="Optional. If true, the request is allowed to create a new DashboardTestCaseAnnotation if it is not found.")] = 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,
+    ) -> V1UpdateDashboardTestCaseAnnotationResponse:
+        """dashboard_test_case_annotation_service_update_dashboard_test_case_annotation
+
+
+        :param dashboard_test_case_annotation_name: Output only. Name of the DashboardTestCaseAnnotation resource. e.g.: \"dashboards/<UUID>/testCases/<UUID>/annotations/<UUID>\" (required)
+        :type dashboard_test_case_annotation_name: str
+        :param dashboard_test_case_annotation: Required. The DashboardTestCaseAnnotation to update. (required)
+        :type dashboard_test_case_annotation: RequiredTheDashboardTestCaseAnnotationToUpdate
+        :param update_mask: Optional. The list of fields to update. If empty, all modifiable fields will be updated. The following fields can be updated:  - value
+        :type update_mask: str
+        :param allow_missing: Optional. If true, the request is allowed to create a new DashboardTestCaseAnnotation if it is not found.
+        :type allow_missing: 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.
+        """ # noqa: E501
+
+        _param = self._dashboard_test_case_annotation_service_update_dashboard_test_case_annotation_serialize(
+            dashboard_test_case_annotation_name=dashboard_test_case_annotation_name,
+            dashboard_test_case_annotation=dashboard_test_case_annotation,
+            update_mask=update_mask,
+            allow_missing=allow_missing,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "V1UpdateDashboardTestCaseAnnotationResponse",
+        }
+        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 dashboard_test_case_annotation_service_update_dashboard_test_case_annotation_with_http_info(
+        self,
+        dashboard_test_case_annotation_name: Annotated[str, Field(strict=True, description="Output only. Name of the DashboardTestCaseAnnotation resource. e.g.: \"dashboards/<UUID>/testCases/<UUID>/annotations/<UUID>\"")],
+        dashboard_test_case_annotation: Annotated[RequiredTheDashboardTestCaseAnnotationToUpdate, Field(description="Required. The DashboardTestCaseAnnotation to update.")],
+        update_mask: Annotated[Optional[StrictStr], Field(description="Optional. The list of fields to update. If empty, all modifiable fields will be updated. The following fields can be updated:  - value")] = None,
+        allow_missing: Annotated[Optional[StrictBool], Field(description="Optional. If true, the request is allowed to create a new DashboardTestCaseAnnotation if it is not found.")] = 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[V1UpdateDashboardTestCaseAnnotationResponse]:
+        """dashboard_test_case_annotation_service_update_dashboard_test_case_annotation
+
+
+        :param dashboard_test_case_annotation_name: Output only. Name of the DashboardTestCaseAnnotation resource. e.g.: \"dashboards/<UUID>/testCases/<UUID>/annotations/<UUID>\" (required)
+        :type dashboard_test_case_annotation_name: str
+        :param dashboard_test_case_annotation: Required. The DashboardTestCaseAnnotation to update. (required)
+        :type dashboard_test_case_annotation: RequiredTheDashboardTestCaseAnnotationToUpdate
+        :param update_mask: Optional. The list of fields to update. If empty, all modifiable fields will be updated. The following fields can be updated:  - value
+        :type update_mask: str
+        :param allow_missing: Optional. If true, the request is allowed to create a new DashboardTestCaseAnnotation if it is not found.
+        :type allow_missing: 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.
+        """ # noqa: E501
+
+        _param = self._dashboard_test_case_annotation_service_update_dashboard_test_case_annotation_serialize(
+            dashboard_test_case_annotation_name=dashboard_test_case_annotation_name,
+            dashboard_test_case_annotation=dashboard_test_case_annotation,
+            update_mask=update_mask,
+            allow_missing=allow_missing,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "V1UpdateDashboardTestCaseAnnotationResponse",
+        }
+        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 dashboard_test_case_annotation_service_update_dashboard_test_case_annotation_without_preload_content(
+        self,
+        dashboard_test_case_annotation_name: Annotated[str, Field(strict=True, description="Output only. Name of the DashboardTestCaseAnnotation resource. e.g.: \"dashboards/<UUID>/testCases/<UUID>/annotations/<UUID>\"")],
+        dashboard_test_case_annotation: Annotated[RequiredTheDashboardTestCaseAnnotationToUpdate, Field(description="Required. The DashboardTestCaseAnnotation to update.")],
+        update_mask: Annotated[Optional[StrictStr], Field(description="Optional. The list of fields to update. If empty, all modifiable fields will be updated. The following fields can be updated:  - value")] = None,
+        allow_missing: Annotated[Optional[StrictBool], Field(description="Optional. If true, the request is allowed to create a new DashboardTestCaseAnnotation if it is not found.")] = 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:
+        """dashboard_test_case_annotation_service_update_dashboard_test_case_annotation
+
+
+        :param dashboard_test_case_annotation_name: Output only. Name of the DashboardTestCaseAnnotation resource. e.g.: \"dashboards/<UUID>/testCases/<UUID>/annotations/<UUID>\" (required)
+        :type dashboard_test_case_annotation_name: str
+        :param dashboard_test_case_annotation: Required. The DashboardTestCaseAnnotation to update. (required)
+        :type dashboard_test_case_annotation: RequiredTheDashboardTestCaseAnnotationToUpdate
+        :param update_mask: Optional. The list of fields to update. If empty, all modifiable fields will be updated. The following fields can be updated:  - value
+        :type update_mask: str
+        :param allow_missing: Optional. If true, the request is allowed to create a new DashboardTestCaseAnnotation if it is not found.
+        :type allow_missing: 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.
+        """ # noqa: E501
+
+        _param = self._dashboard_test_case_annotation_service_update_dashboard_test_case_annotation_serialize(
+            dashboard_test_case_annotation_name=dashboard_test_case_annotation_name,
+            dashboard_test_case_annotation=dashboard_test_case_annotation,
+            update_mask=update_mask,
+            allow_missing=allow_missing,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "V1UpdateDashboardTestCaseAnnotationResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _dashboard_test_case_annotation_service_update_dashboard_test_case_annotation_serialize(
+        self,
+        dashboard_test_case_annotation_name,
+        dashboard_test_case_annotation,
+        update_mask,
+        allow_missing,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, Union[str, bytes]] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if dashboard_test_case_annotation_name is not None:
+            _path_params['dashboardTestCaseAnnotation.name'] = dashboard_test_case_annotation_name
+        # process the query parameters
+        if update_mask is not None:
+            
+            _query_params.append(('updateMask', update_mask))
+            
+        if allow_missing is not None:
+            
+            _query_params.append(('allowMissing', allow_missing))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if dashboard_test_case_annotation is not None:
+            _body_params = dashboard_test_case_annotation
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        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
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/v1/{dashboardTestCaseAnnotation.name}',
+            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
+        )
+
+