Class RecoverDeletedKeyPoller

Package version

Class that deletes a poller that waits until a key finishes being deleted

Hierarchy

Poller<RecoverDeletedKeyPollOperationState, KeyVaultKey>
- RecoverDeletedKeyPoller

Implements

PollerLike<RecoverDeletedKeyPollOperationState, KeyVaultKey>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RecoverDeletedKeyPoller(options: RecoverDeletedKeyPollerOptions): RecoverDeletedKeyPoller

Overrides Poller.__constructor
- Defined in sdk/keyvault/keyvault-keys/src/lro/recover/poller.ts:31
Parameters
- options: RecoverDeletedKeyPollerOptions
Returns RecoverDeletedKeyPoller

Properties

intervalInMs

intervalInMs: number

Defines how much time the poller is going to wait before making a new request to the service.

memberof: RecoverDeletedKeyPoller

Protected operation

operation: PollOperation<RecoverDeletedKeyPollOperationState, KeyVaultKey>

Methods

cancelOperation

cancelOperation(options?: undefined | { abortSignal?: AbortSignal }): Promise<void>

Inherited from DeleteKeyPoller.cancelOperation
- Defined in sdk/core/core-lro/types/core-lro.d.ts:28
Parameters
- Optional options: undefined | { abortSignal?: AbortSignal }
Returns Promise<void>

delay

delay(): Promise<void>

Overrides Poller.delay
- Defined in sdk/keyvault/keyvault-keys/src/lro/recover/poller.ts:58
The method used by the poller to wait before attempting to update its operation.

memberof

RecoverDeletedKeyPoller

Returns Promise<void>

getOperationState

getOperationState(): PollOperationState<KeyVaultKey>

Inherited from DeleteKeyPoller.getOperationState
- Defined in sdk/core/core-lro/types/core-lro.d.ts:31
Returns PollOperationState<KeyVaultKey>

getResult

getResult(): KeyVaultKey | undefined

Inherited from DeleteKeyPoller.getResult
- Defined in sdk/core/core-lro/types/core-lro.d.ts:32
Returns KeyVaultKey | undefined

isDone

isDone(): boolean

Inherited from DeleteKeyPoller.isDone
- Defined in sdk/core/core-lro/types/core-lro.d.ts:25
Returns boolean

isStopped

isStopped(): boolean

Inherited from DeleteKeyPoller.isStopped
- Defined in sdk/core/core-lro/types/core-lro.d.ts:27
Returns boolean

onProgress

onProgress(callback: (state: RecoverDeletedKeyPollOperationState) => void): CancelOnProgress

Inherited from DeleteKeyPoller.onProgress
- Defined in sdk/core/core-lro/types/core-lro.d.ts:24
Parameters
- callback: (state: RecoverDeletedKeyPollOperationState) => void
  - - (state: RecoverDeletedKeyPollOperationState): void
    - Parameters
      - state: RecoverDeletedKeyPollOperationState
      Returns void
Returns CancelOnProgress

poll

poll(options?: undefined | { abortSignal?: AbortSignal }): Promise<void>

Inherited from DeleteKeyPoller.poll
- Defined in sdk/core/core-lro/types/core-lro.d.ts:20
Parameters
- Optional options: undefined | { abortSignal?: AbortSignal }
Returns Promise<void>

pollUntilDone

pollUntilDone(): Promise<KeyVaultKey>

Inherited from DeleteKeyPoller.pollUntilDone
- Defined in sdk/core/core-lro/types/core-lro.d.ts:23
Returns Promise<KeyVaultKey>

stopPolling

stopPolling(): void

Inherited from DeleteKeyPoller.stopPolling
- Defined in sdk/core/core-lro/types/core-lro.d.ts:26
Returns void

toString

toString(): string

Inherited from DeleteKeyPoller.toString
- Defined in sdk/core/core-lro/types/core-lro.d.ts:33
Returns string

Generated using TypeDoc