import { APIResource } from "../../resource.js"; import * as Core from "../../core.js"; import * as QueuesAPI from "./queues.js"; import * as Shared from "../shared.js"; export declare class Queues extends APIResource { /** * Creates a new work pool queue. If a work pool queue with the same name already * exists, an error will be raised. */ create(workPoolName: string, params: QueueCreateParams, options?: Core.RequestOptions): Core.APIPromise; /** * Read a work pool queue */ retrieve(workPoolName: string, name: string, params?: QueueRetrieveParams, options?: Core.RequestOptions): Core.APIPromise; retrieve(workPoolName: string, name: string, options?: Core.RequestOptions): Core.APIPromise; /** * Update a work pool queue */ update(workPoolName: string, params: QueueUpdateParams, options?: Core.RequestOptions): Core.APIPromise; /** * Delete a work pool queue */ delete(workPoolName: string, name: string, params?: QueueDeleteParams, options?: Core.RequestOptions): Core.APIPromise; delete(workPoolName: string, name: string, options?: Core.RequestOptions): Core.APIPromise; /** * Read all work pool queues */ filter(workPoolName: string, params?: QueueFilterParams, options?: Core.RequestOptions): Core.APIPromise; filter(workPoolName: string, options?: Core.RequestOptions): Core.APIPromise; } export type QueueFilterResponse = Array; export interface QueueCreateParams { /** * Body param: The name of the work queue. */ name: string; /** * Body param: The work queue's concurrency limit. */ concurrency_limit?: number | null; /** * Body param: An optional description for the work queue. */ description?: string | null; /** * Body param: Filter criteria definition for a work queue. */ filter?: QueueCreateParams.Filter | null; /** * Body param: Whether or not the work queue is paused. */ is_paused?: boolean; /** * Body param: The queue's priority. Lower values are higher priority (1 is the * highest). */ priority?: number | null; /** * Header param: */ 'x-prefect-api-version'?: string; } export declare namespace QueueCreateParams { /** * @deprecated: Filter criteria definition for a work queue. */ interface Filter { /** * Only include flow runs from these deployments in the work queue. */ deployment_ids?: Array | null; /** * Only include flow runs with these tags in the work queue. */ tags?: Array | null; } } export interface QueueRetrieveParams { 'x-prefect-api-version'?: string; } export interface QueueUpdateParams { /** * Path param: The work pool queue name */ path_name: string; /** * Body param: */ concurrency_limit?: number | null; /** * Body param: */ description?: string | null; /** * Body param: Filter criteria definition for a work queue. */ filter?: QueueUpdateParams.Filter | null; /** * Body param: Whether or not the work queue is paused. */ is_paused?: boolean; /** * Body param: */ last_polled?: string | null; /** * Body param: */ body_name?: string | null; /** * Body param: */ priority?: number | null; /** * Header param: */ 'x-prefect-api-version'?: string; } export declare namespace QueueUpdateParams { /** * @deprecated: Filter criteria definition for a work queue. */ interface Filter { /** * Only include flow runs from these deployments in the work queue. */ deployment_ids?: Array | null; /** * Only include flow runs with these tags in the work queue. */ tags?: Array | null; } } export interface QueueDeleteParams { 'x-prefect-api-version'?: string; } export interface QueueFilterParams { /** * Body param: Defaults to PREFECT_API_DEFAULT_LIMIT if not provided. */ limit?: number; /** * Body param: */ offset?: number; /** * Body param: Filter work queues. Only work queues matching all criteria will be * returned */ work_queues?: QueueFilterParams.WorkQueues; /** * Header param: */ 'x-prefect-api-version'?: string; } export declare namespace QueueFilterParams { /** * Filter work queues. Only work queues matching all criteria will be returned */ interface WorkQueues { /** * Filter by `WorkQueue.id`. */ id?: WorkQueues.ID | null; /** * Filter by `WorkQueue.name`. */ name?: WorkQueues.Name | null; /** * Operator for combining filter criteria. Defaults to 'and\_'. */ operator?: 'and_' | 'or_'; } namespace WorkQueues { /** * Filter by `WorkQueue.id`. */ interface ID { /** * A list of work queue ids to include */ any_?: Array | null; } /** * Filter by `WorkQueue.name`. */ interface Name { /** * A list of work queue names to include */ any_?: Array | null; /** * A list of case-insensitive starts-with matches. For example, passing 'marvin' * will match 'marvin', and 'Marvin-robot', but not 'sad-marvin'. */ startswith_?: Array | null; } } } export declare namespace Queues { export import QueueFilterResponse = QueuesAPI.QueueFilterResponse; export import QueueCreateParams = QueuesAPI.QueueCreateParams; export import QueueRetrieveParams = QueuesAPI.QueueRetrieveParams; export import QueueUpdateParams = QueuesAPI.QueueUpdateParams; export import QueueDeleteParams = QueuesAPI.QueueDeleteParams; export import QueueFilterParams = QueuesAPI.QueueFilterParams; } //# sourceMappingURL=queues.d.ts.map