Class OdaWaiter

Hierarchy

OdaWaiter

Constructors

constructor

Properties

Methods

Constructors

constructor

new OdaWaiter(client: OdaClient, config?: WaiterConfiguration): OdaWaiter

- Defined in lib/oda/lib/oda-waiter.ts:20
Parameters
- client: OdaClient
- Optional config: WaiterConfiguration
Returns OdaWaiter

Properties

Private client

client: OdaClient

Private Optional Readonly config

config: WaiterConfiguration

Methods

forOdaInstance

forOdaInstance(request: GetOdaInstanceRequest, ...targetStates: LifecycleState[]): Promise<GetOdaInstanceResponse | null>

- Defined in lib/oda/lib/oda-waiter.ts:30
Waits forOdaInstance till it reaches any of the provided states

Parameters
- request: GetOdaInstanceRequest
  
  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<GetOdaInstanceResponse | null>

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

forOdaInstanceAttachment

forOdaInstanceAttachment(request: GetOdaInstanceAttachmentRequest, ...targetStates: LifecycleState[]): Promise<GetOdaInstanceAttachmentResponse>

- Defined in lib/oda/lib/oda-waiter.ts:49
Waits forOdaInstanceAttachment till it reaches any of the provided states

Parameters
- request: GetOdaInstanceAttachmentRequest
  
  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<GetOdaInstanceAttachmentResponse>

response returns GetOdaInstanceAttachmentResponse

forWorkRequest

forWorkRequest(request: GetWorkRequestRequest): Promise<GetWorkRequestResponse>

- Defined in lib/oda/lib/oda-waiter.ts:66
Waits forWorkRequest

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

response returns GetWorkRequestResponse