] = None,
        default_response_class: Annotated[
            type[Response],
            Doc(
                """
                The default response class to be used.

                Read more in the
                [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).

                **Example**

                ```python

    client = TestClient(app)
    return client


@needs_py310
def test_get(client: TestClient):
    response = client.get("/users")
    assert response.json() == {"username": "alice", "role": "admin"}


@needs_py310
def test_openapi_schema(client: TestClient):
    response = client.get("openapi.json")
    assert response.json() == snapshot(
        {
            "openapi": "3.1.0",

from .param_functions import Path as Path
from .param_functions import Query as Query
from .param_functions import Security as Security
from .requests import Request as Request
from .responses import Response as Response
from .routing import APIRouter as APIRouter
from .websockets import WebSocket as WebSocket

            return (String) accessType;
        }
        return Constants.SEARCH_LOG_ACCESS_TYPE_WEB;
    }

    /**
     * Adds documents in the response to the search log.
     *
     * @param queryResponseList The list of query responses.
     * @param searchLog The search log.
     */
    protected void addDocumentsInResponse(final QueryResponseList queryResponseList, final SearchLog searchLog) {

            try (CurlResponse response = ComponentUtil.getCurlHelper().get("/_" + v1 + "/" + v2).execute()) {
                CopyUtil.copy(response.getContentAsStream(), zos);
            }
        } catch (final Exception e) {
            logger.warn("Failed to access /_{}/{}", v1, v2, e);
        }
    }

    /**
     * Writes OpenSearch CAT API responses to the ZIP output stream.
     *

* Add support for declaring a `Response` parameter:
    * This allows declaring:
        * [Response Cookies](https://fastapi.tiangolo.com/advanced/response-cookies/).
        * [Response Headers](https://fastapi.tiangolo.com/advanced/response-headers/).
        * An HTTP Status Code different than the default: [Response - Change Status Code](https://fastapi.tiangolo.com/advanced/response-change-status-code/).

/**
 * This class represents the base response structure for API results.
 * It encapsulates the API response and provides methods to build different types of API responses.
 */
public class ApiResult {

    /**
     * The API response object.
     */
    protected ApiResponse response = null;

    /**
     * Constructs an ApiResult with the specified ApiResponse.
     * @param response The API response object.
     */

    - advanced/path-operation-advanced-configuration.md
    - advanced/additional-status-codes.md
    - advanced/response-directly.md
    - advanced/custom-response.md
    - advanced/additional-responses.md
    - advanced/response-cookies.md
    - advanced/response-headers.md
    - advanced/response-change-status-code.md
    - advanced/advanced-dependencies.md
    - Advanced Security:
      - advanced/security/index.md

     * @param <Response> the response type
     * @param action     the action to execute
     * @param request    the action request
     * @return a future for the action response
     */
    @Override
    public <Request extends ActionRequest, Response extends ActionResponse> ActionFuture<Response> execute(
            final ActionType<Response> action, final Request request) {

        final ApiStartJobResponse response = new ApiStartJobResponse();
        final ApiStartJobResponse returned = response.jobLogId("abc123def456");
        assertSame(response, returned);
        assertEquals("abc123def456", response.jobLogId);
    }

    @Test
    public void test_ApiStartJobResponse_withNullJobLogId() {
        final ApiStartJobResponse response = new ApiStartJobResponse();