apache-airflow-providers-edge3 1.1.3__py3-none-any.whl → 1.2.0__py3-none-any.whl

airflow/providers/edge3/plugins/www/openapi-gen/requests/services.gen.ts

@@ -0,0 +1,289 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { CancelablePromise } from './core/CancelablePromise';
+import { OpenAPI } from './core/OpenAPI';
+import { request as __request } from './core/request';
+import type { FetchData, FetchResponse, StateData, StateResponse, LogfilePathData, LogfilePathResponse, PushLogsData, PushLogsResponse, RegisterData, RegisterResponse, SetStateData, SetStateResponse, UpdateQueuesData, UpdateQueuesResponse, HealthResponse, WorkerResponse, JobsResponse } from './types.gen';
+
+export class JobsService {
+    /**
+     * Fetch
+     * Fetch a job to execute on the edge worker.
+     * @param data The data for the request.
+     * @param data.workerName
+     * @param data.authorization JWT Authorization Token
+     * @param data.requestBody
+     * @returns unknown Successful Response
+     * @throws ApiError
+     */
+    public static fetch(data: FetchData): CancelablePromise<FetchResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/edge_worker/v1/jobs/fetch/{worker_name}',
+            path: {
+                worker_name: data.workerName
+            },
+            headers: {
+                authorization: data.authorization
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Bad Request',
+                403: 'Forbidden',
+                422: 'Validation Error'
+            }
+        });
+    }
+    
+    /**
+     * State
+     * Update the state of a job running on the edge worker.
+     * @param data The data for the request.
+     * @param data.dagId Identifier of the DAG to which the task belongs.
+     * @param data.taskId Task name in the DAG.
+     * @param data.runId Run ID of the DAG execution.
+     * @param data.tryNumber The number of attempt to execute this task.
+     * @param data.mapIndex For dynamically mapped tasks the mapping number, -1 if the task is not mapped.
+     * @param data.state State of the assigned task under execution.
+     * @param data.authorization JWT Authorization Token
+     * @returns null Successful Response
+     * @throws ApiError
+     */
+    public static state(data: StateData): CancelablePromise<StateResponse> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/edge_worker/v1/jobs/state/{dag_id}/{task_id}/{run_id}/{try_number}/{map_index}/{state}',
+            path: {
+                dag_id: data.dagId,
+                task_id: data.taskId,
+                run_id: data.runId,
+                try_number: data.tryNumber,
+                map_index: data.mapIndex,
+                state: data.state
+            },
+            headers: {
+                authorization: data.authorization
+            },
+            errors: {
+                400: 'Bad Request',
+                403: 'Forbidden',
+                422: 'Validation Error'
+            }
+        });
+    }
+    
+}
+
+export class LogsService {
+    /**
+     * Logfile Path
+     * Elaborate the path and filename to expect from task execution.
+     * @param data The data for the request.
+     * @param data.dagId Identifier of the DAG to which the task belongs.
+     * @param data.taskId Task name in the DAG.
+     * @param data.runId Run ID of the DAG execution.
+     * @param data.tryNumber The number of attempt to execute this task.
+     * @param data.mapIndex For dynamically mapped tasks the mapping number, -1 if the task is not mapped.
+     * @param data.authorization JWT Authorization Token
+     * @returns string Successful Response
+     * @throws ApiError
+     */
+    public static logfilePath(data: LogfilePathData): CancelablePromise<LogfilePathResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/edge_worker/v1/logs/logfile_path/{dag_id}/{task_id}/{run_id}/{try_number}/{map_index}',
+            path: {
+                dag_id: data.dagId,
+                task_id: data.taskId,
+                run_id: data.runId,
+                try_number: data.tryNumber,
+                map_index: data.mapIndex
+            },
+            headers: {
+                authorization: data.authorization
+            },
+            errors: {
+                400: 'Bad Request',
+                403: 'Forbidden',
+                422: 'Validation Error'
+            }
+        });
+    }
+    
+    /**
+     * Push Logs
+     * Push an incremental log chunk from Edge Worker to central site.
+     * @param data The data for the request.
+     * @param data.dagId Identifier of the DAG to which the task belongs.
+     * @param data.taskId Task name in the DAG.
+     * @param data.runId Run ID of the DAG execution.
+     * @param data.tryNumber The number of attempt to execute this task.
+     * @param data.mapIndex For dynamically mapped tasks the mapping number, -1 if the task is not mapped.
+     * @param data.authorization JWT Authorization Token
+     * @param data.requestBody
+     * @returns null Successful Response
+     * @throws ApiError
+     */
+    public static pushLogs(data: PushLogsData): CancelablePromise<PushLogsResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/edge_worker/v1/logs/push/{dag_id}/{task_id}/{run_id}/{try_number}/{map_index}',
+            path: {
+                dag_id: data.dagId,
+                task_id: data.taskId,
+                run_id: data.runId,
+                try_number: data.tryNumber,
+                map_index: data.mapIndex
+            },
+            headers: {
+                authorization: data.authorization
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Bad Request',
+                403: 'Forbidden',
+                422: 'Validation Error'
+            }
+        });
+    }
+    
+}
+
+export class WorkerService {
+    /**
+     * Register
+     * Register a new worker to the backend.
+     * @param data The data for the request.
+     * @param data.workerName Hostname or instance name of the worker
+     * @param data.authorization JWT Authorization Token
+     * @param data.requestBody
+     * @returns WorkerRegistrationReturn Successful Response
+     * @throws ApiError
+     */
+    public static register(data: RegisterData): CancelablePromise<RegisterResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/edge_worker/v1/worker/{worker_name}',
+            path: {
+                worker_name: data.workerName
+            },
+            headers: {
+                authorization: data.authorization
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Bad Request',
+                403: 'Forbidden',
+                422: 'Validation Error'
+            }
+        });
+    }
+    
+    /**
+     * Set State
+     * Set state of worker and returns the current assigned queues.
+     * @param data The data for the request.
+     * @param data.workerName Hostname or instance name of the worker
+     * @param data.authorization JWT Authorization Token
+     * @param data.requestBody
+     * @returns WorkerSetStateReturn Successful Response
+     * @throws ApiError
+     */
+    public static setState(data: SetStateData): CancelablePromise<SetStateResponse> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/edge_worker/v1/worker/{worker_name}',
+            path: {
+                worker_name: data.workerName
+            },
+            headers: {
+                authorization: data.authorization
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Bad Request',
+                403: 'Forbidden',
+                422: 'Validation Error'
+            }
+        });
+    }
+    
+    /**
+     * Update Queues
+     * @param data The data for the request.
+     * @param data.workerName Hostname or instance name of the worker
+     * @param data.authorization JWT Authorization Token
+     * @param data.requestBody
+     * @returns null Successful Response
+     * @throws ApiError
+     */
+    public static updateQueues(data: UpdateQueuesData): CancelablePromise<UpdateQueuesResponse> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/edge_worker/v1/worker/queues/{worker_name}',
+            path: {
+                worker_name: data.workerName
+            },
+            headers: {
+                authorization: data.authorization
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Bad Request',
+                403: 'Forbidden',
+                422: 'Validation Error'
+            }
+        });
+    }
+    
+}
+
+export class MonitorService {
+    /**
+     * Health
+     * Report API Health.
+     * @returns string Successful Response
+     * @throws ApiError
+     */
+    public static health(): CancelablePromise<HealthResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/edge_worker/v1/health'
+        });
+    }
+    
+}
+
+export class UiService {
+    /**
+     * Worker
+     * Return Edge Workers.
+     * @returns WorkerCollectionResponse Successful Response
+     * @throws ApiError
+     */
+    public static worker(): CancelablePromise<WorkerResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/edge_worker/ui/worker'
+        });
+    }
+    
+    /**
+     * Jobs
+     * Return Edge Jobs.
+     * @returns JobCollectionResponse Successful Response
+     * @throws ApiError
+     */
+    public static jobs(): CancelablePromise<JobsResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/edge_worker/ui/jobs'
+        });
+    }
+    
+}