Class ResourcePoolResource

Resource pool API — pre-acquire and release composition units (Enterprise).

Acquire units ahead of a session with acquire, inspect them via list/get, and free idle units with release.

Index

Constructors

Methods

acquire get list release

Constructors

constructor

new ResourcePoolResource(http: HttpClient): ResourcePoolResource
Parameters
- http: HttpClient
Returns ResourcePoolResource

Methods

acquire

acquire(options: AcquireResourceOptions): Promise<ResourceUnit[]>
Pre-acquire N composition units (Enterprise tier only).
Parameters
- options: AcquireResourceOptions
Returns Promise<ResourceUnit[]>

get

get(id: string): Promise<ResourceUnit>
Parameters
- id: string
Returns Promise<ResourceUnit>

list

list(params?: ListResourcesParams): Promise<Page<ResourceUnit>>
Parameters
- params: ListResourcesParams = {}
Returns Promise<Page<ResourceUnit>>

release

release(ids: string[]): Promise<ReleaseResourceResult[]>
Release units by id (only idle units are released).
Parameters
- ids: string[]
Returns Promise<ReleaseResourceResult[]>