import { ExternalTaskError } from './ExternalTaskErrors'; /** * @swagger * components: * schemas: * ExtendLockRequestPayload: * description: Describes the payload that must be send with a extendLock HTTP POST request. * type: object * required: * - workerId * - additionalDuration * properties: * workerId: * description: The ID of the worker that wants to extend the lock. * type: string * additionalDuration: * description: The additional duration in milliseconds that the lock should be extended. * type: number */ /** * Describes the payload that must be send with a extendLock HTTP POST request. */ export declare type ExtendLockRequestPayload = { workerId: string; additionalDuration: number; }; /** * @swagger * components: * schemas: * FetchAndLockRequestPayload: * description: Describes the payload that must be send with a fetchAndLock HTTP POST request. * type: object * required: * - workerId * - topicName * - maxTasks * - longPollingTimeout * - lockDuration * - payloadFilter * properties: * workerId: * description: The ID of the worker that wants to fetch and lock tasks. * type: string * topicName: * description: The topic of the tasks to fetch and lock. * oneOf: * - type: string * - type: array * items: * type: string * maxTasks: * description: The maximum number of tasks to fetch and lock. * type: number * longPollingTimeout: * description: The timeout for the long polling request. * type: number * lockDuration: * description: The duration for which the tasks should be locked. * type: number * payloadFilter: * description: A filter for the payload of the tasks. * type: string */ /** * Describes the payload that must be send with a fetchAndLock HTTP POST request. */ export declare type FetchAndLockRequestPayload = { workerId: string; topicName: string | Array; maxTasks: number; longPollingTimeout: number; lockDuration: number; payloadFilter: string; }; /** * @swagger * components: * schemas: * FinishExternalTaskRequestPayload: * description: Describes the payload that must be send with a finishExternalTask HTTP POST request. * type: object * required: * - workerId * - result * properties: * workerId: * description: The ID of the worker that wants to finish the task. * type: string * result: * description: The result of the task. * type: object * example: * foo: bar */ /** * Describes the payload that must be send with a finishExternalTask HTTP POST request. */ export declare type FinishExternalTaskRequestPayload = { workerId: string; result: TResult; }; /** * @swagger * components: * schemas: * HandleExternalTaskErrorRequestPayload: * description: Describes the payload that must be send with a handleExternalTaskError HTTP POST request. * type: object * required: * - workerId * - bpmnError * properties: * workerId: * description: The ID of the worker that wants to handle the BPMN error. * type: string * error: * description: The error to handle. * $ref: '#/components/schemas/ExternalTaskError' */ /** * Describes the payload that must be send with a handleExternalTaskError HTTP POST request. */ export declare type HandleExternalTaskErrorRequestPayload = { workerId: string; error: ExternalTaskError; };