Class ClusterWaiter

Hierarchy

ClusterWaiter

Constructors

constructor

Properties

Methods

forCluster

Constructors

constructor

new ClusterWaiter(client: ClusterClient, config?: WaiterConfiguration): ClusterWaiter

- Defined in lib/ocvp/lib/cluster-waiter.ts:22
Parameters
- client: ClusterClient
- Optional config: WaiterConfiguration
Returns ClusterWaiter

Properties

Private client

client: ClusterClient

Private Optional Readonly config

config: WaiterConfiguration

Methods

forCluster

forCluster(request: GetClusterRequest, ...targetStates: LifecycleStates[]): Promise<GetClusterResponse | null>

- Defined in lib/ocvp/lib/cluster-waiter.ts:35
Waits forCluster till it reaches any of the provided states

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

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