Lambda reference table
======================

This page contains a comprehensive reference table of all functions, classes, and constants
available for lambda development, categorized by lambda type.

.. note::
   This table provides a quick reference. For detailed descriptions, follow the links to
   the corresponding documentation pages.

Common (all lambda types)
-------------------------

.. list-table::
   :header-rows: 1

   * - Function/Class/Constant
     - Required
     - Description Link
   * - `logger`
     - Optional
     - `Logger documentation <./development.html#logger>`_
   * - `UserCtx`
     - Optional
     - `User context documentation <./development.html#user-context>`_
   * - `UserCtx.onStart`
     - Optional
     - `User context documentation <./development.html#user-context>`_
   * - `UserCtx.onShutdown`
     - Optional
     - `User context documentation <./development.html#user-context>`_
   * - `UserException`
     - Optional
     - `Lambda exceptions documentation <./development.html#lambda-exceptions>`_
   * - `LambdaUserHandler`
     - Optional
     - `Additional routes documentation <./development.html#additional-routes>`_
   * - `ROUTES_TO_ADD`
     - Optional
     - `Additional routes documentation <./development.html#additional-routes>`_
   * - `lambda_config.yml`
     - Optional
     - `User configuration file <./development.html#user-configuration-file>`_
   * - `requirements.txt` / `pyproject.toml`
     - Optional
     - `Lambda requirements <./lambda_requirements.html>`_

Standalone Lambda
-----------------

.. list-table::
   :header-rows: 1

   * - Function/Class/Constant
     - Required
     - Description Link
   * - `StandaloneLambdaRequest`
     - Required
     - `Standalone request <./standalone.html#standalone-lambda-development>`_
   * - `main(request: StandaloneLambdaRequest)`
     - Required
     - `Standalone request <./standalone.html#standalone-lambda-development>`_
   * - `request.json`
     - Optional
     - `Standalone request <./standalone.html#standalone-lambda-development>`_
   * - `request.getBody()`
     - Optional
     - `Standalone request <./standalone.html#standalone-lambda-development>`_
   * - `request.headers`
     - Optional
     - `Standalone request <./standalone.html#standalone-lambda-development>`_
   * - `request.args`
     - Optional
     - `Standalone request <./standalone.html#standalone-lambda-development>`_
   * - `request.clients`
     - Optional
     - `Luna services clients <./development.html#luna-services-clients>`_
   * - `request.eventsEnabled`
     - Optional
     - `Luna services clients <./development.html#luna-services-clients>`_
   * - `request.senderEnabled`
     - Optional
     - `Luna services clients <./development.html#luna-services-clients>`_
   * - `request.handlersEnabled`
     - Optional
     - `Luna services clients <./development.html#luna-services-clients>`_
   * - `Clients`
     - Optional
     - `Luna clients documentation <./luna_clients.html>`_

Handlers Lambda
---------------

.. list-table::
   :header-rows: 1

   * - Function/Class/Constant
     - Required
     - Description Link
   * - `HandlersLambdaRequest`
     - Required
     - `Handlers request usage <./handlers.html#handlers-lambda-request-usage>`_
   * - `main(request: HandlersLambdaRequest)`
     - Required
     - `Handlers request usage <./handlers.html#handlers-lambda-request-usage>`_
   * - `request.data`
     - Optional
     - `Handlers incoming data <./handlers.html#handlers-lambda-incoming-data>`_
   * - `request.data.sources`
     - Optional
     - `Handlers incoming data <./handlers.html#handlers-lambda-incoming-data>`_
   * - `request.handlerId`
     - Optional
     - `Handlers request usage <./handlers.html#handlers-lambda-request-usage>`_
   * - `request.headers`
     - Optional
     - `Handlers request usage <./handlers.html#handlers-lambda-request-usage>`_
   * - `request.args`
     - Optional
     - `Handlers request usage <./handlers.html#handlers-lambda-request-usage>`_
   * - `request.clients`
     - Optional
     - `Luna services clients <./development.html#luna-services-clients>`_
   * - `HandlerDataSchema`
     - Optional
     - `Handler schemas <./handlers.html#handlers-lambda-incoming-data>`_
   * - `HandlerSource`
     - Optional
     - `Handler schemas <./handlers.html#handlers-lambda-incoming-data>`_

Agent Lambda
------------

.. list-table::
   :header-rows: 1

   * - Function/Class/Constant
     - Required
     - Description Link
   * - `AVAILABLE_ANALYTICS`
     - Required
     - `Agent lambda development <./agent.html#agent-lambda-development>`_
   * - `ANALYTICS_LICENSE_FEATURES`
     - Optional
     - `Agent lambda development <./agent.html#agent-lambda-development>`_
   * - `ESTIMATORS_TO_INITIALIZE`
     - Optional
     - `Agent lambda development <./agent.html#agent-lambda-development>`_
   * - `ESTIMATORS_TARGETS`
     - Optional
     - `Agent lambda development <./agent.html#agent-lambda-development>`_
   * - `REGISTRATION_ATTEMPT_COUNT`
     - Optional
     - `Agent lambda development <./agent.html#agent-lambda-development>`_
   * - `REGISTRATION_ATTEMPT_DELAY`
     - Optional
     - `Agent lambda development <./agent.html#agent-lambda-development>`_
   * - `FEEDBACK_MAX_BATCH_COUNT`
     - Optional
     - `Agent lambda development <./agent.html#agent-lambda-development>`_
   * - `WSCODE_GOING_AWAY`
     - Optional
     - `Agent lambda development <./agent.html#agent-lambda-development>`_
   * - `AGENT_NAME`
     - Optional
     - `Agent lambda development <./agent.html#agent-lambda-development>`_
   * - `AGENT_DESCRIPTION`
     - Optional
     - `Agent lambda development <./agent.html#agent-lambda-development>`_
   * - `AgentClients`
     - Optional
     - `Luna clients documentation <./luna_clients.html>`_
   * - `ROUTES_TO_ADD`
     - Optional
     - `Additional routes documentation <./development.html#additional-routes>`_
   * - `LambdaUserHandler`
     - Optional
     - `Additional routes documentation <./development.html#additional-routes>`_
   * - Analytics module (`analytics.py`)
     - Required
     - `Video analytics development <./agent.html#agent-video-analytics-development>`_
   * - Analytics module (`common.py`)
     - Required
     - `Video analytics development <./agent.html#agent-video-analytics-development>`_
   * - Analytics module (`classes.py`)
     - Required
     - `Video analytics development <./agent.html#agent-video-analytics-development>`_
   * - Analytics module (`models.py`)
     - Optional
     - `Video analytics development <./agent.html#agent-video-analytics-development>`_
   * - `getDocumentation()`
     - Required
     - `Video analytics development <./agent.html#agent-video-analytics-development>`_

Tasks Lambda
------------

.. list-table::
   :header-rows: 1

   * - Function/Class/Constant
     - Required
     - Description Link
   * - `BaseLambdaTask`
     - Required
     - `Subtask processing <./tasks.html#subtask-processing>`_
   * - `LambdaTask` (user class inheriting `BaseLambdaTask`)
     - Required
     - `Subtask processing <./tasks.html#subtask-processing>`_
   * - `splitTasksContent(content: dict)`
     - Required
     - `Task content separation <./tasks.html#task-content-separation-process>`_
   * - `executeSubtask(subtaskContent: dict)`
     - Required
     - `Subtask processing <./tasks.html#subtask-processing>`_
   * - `UserTaskLambdaException`
     - Optional
     - `Task error processing <./tasks.html#task-error-processing>`_
   * - `self.clients`
     - Optional
     - `Subtask processing <./tasks.html#subtask-processing>`_
   * - `TasksClients`
     - Optional
     - `Luna clients documentation <./luna_clients.html>`_
   * - `ROUTES_TO_ADD`
     - Optional
     - `Additional routes documentation <./development.html#additional-routes>`_
   * - `LambdaUserHandler`
     - Optional
     - `Additional routes documentation <./development.html#additional-routes>`_

Luna Services Clients (common for all types)
--------------------------------------------

.. list-table::
   :header-rows: 1

   * - Client
     - Required
     - Description Link
   * - `clients.faces` (Faces)
     - Optional
     - `Luna clients documentation <./luna_clients.html>`_
   * - `clients.events` (Events)
     - Optional
     - `Luna clients documentation <./luna_clients.html>`_
   * - `clients.handlers` (Handlers)
     - Optional
     - `Luna clients documentation <./luna_clients.html>`_
   * - `clients.sender` (Sender)
     - Optional
     - `Luna clients documentation <./luna_clients.html>`_
   * - `clients.lis` (Image Store)
     - Optional
     - `Luna clients documentation <./luna_clients.html>`_
   * - `clients.lpm` (Python Matcher)
     - Optional
     - `Luna clients documentation <./luna_clients.html>`_
   * - `clients.lrs` (Remote SDK)
     - Optional
     - `Luna clients documentation <./luna_clients.html>`_
   * - `clients.lva` (Video Manager)
     - Optional
     - `Luna clients documentation <./luna_clients.html>`_
   * - `clients.lunavl` (LUNA SDK)
     - Optional
     - `Luna clients documentation <./luna_clients.html>`_
   * - `clients.api` (Luna API)
     - Optional
     - `Luna API client <./luna_clients.html#luna-api-client>`_