Class QueueAdminWaiter

Hierarchy

QueueAdminWaiter

Constructors

constructor

Properties

Methods

Constructors

constructor

new QueueAdminWaiter(client: QueueAdminClient, config?: WaiterConfiguration): QueueAdminWaiter

- Defined in lib/queue/lib/queueadmin-waiter.ts:20
Parameters
- client: QueueAdminClient
- Optional config: WaiterConfiguration
Returns QueueAdminWaiter

Properties

Private client

client: QueueAdminClient

Private Optional Readonly config

config: WaiterConfiguration

Methods

forQueue

forQueue(request: GetQueueRequest, ...targetStates: LifecycleState[]): Promise<GetQueueResponse | null>

- Defined in lib/queue/lib/queueadmin-waiter.ts:33
Waits forQueue till it reaches any of the provided states

Parameters
- request: GetQueueRequest
  
  the request to send
- Rest ...targetStates: LifecycleState[]
  
  the desired states to wait for. The waiter will return once the resource reaches any of the provided states
Returns Promise<GetQueueResponse | null>

response returns GetQueueResponse | null (null in case of 404 response)

forWorkRequest

forWorkRequest(request: GetWorkRequestRequest): Promise<GetWorkRequestResponse>

- Defined in lib/queue/lib/queueadmin-waiter.ts:51
Waits forWorkRequest

Parameters
- request: GetWorkRequestRequest
  
  the request to send
Returns Promise<GetWorkRequestResponse>

response returns GetWorkRequestResponse