Recovery Objective methods: drill
The Recovery Objective Verbs drill as typed SDK methods, with inputs, result, refusals and an example.
Reference for Recovery Objective, one group of Recovery Objective methods.
RecoveryObjective.drill
Drill restores one Capability’s records into an isolated namespace and records whether the restore met both objectives. Verb page.
interface RecoveryObjectiveVerbs {
drill(input: RecoveryObjectiveDrillInput, options?: SB.CallOptions): SB.Call<RecoveryObjective>
}Emits RecoveryObjective.drilled.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
objective | Recovery Objective | required | The Recovery Objective to prove. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
objective | Recovery Objective | required | The objective with its last drill result. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const objective = await $.RecoveryObjective.drill({ objective: 'recovery_MSAgl5dysq' })