Recovery Objective methods: create, get, list
The Recovery Objective Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.
Reference for Recovery Objective, one group of Recovery Objective methods.
RecoveryObjective.create
Creates a Recovery Objective. Verb page.
interface RecoveryObjectiveVerbs {
create(input: RecoveryObjectiveCreateInput, options?: SB.CallOptions): SB.Call<RecoveryObjective>
}Emits RecoveryObjective.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
recoveryPoint | string | required | The most data a failure may lose, as a window such as 15m. |
recoveryTime | string | required | How fast the Capability returns after a failure, as a window such as 4h. |
drillEvery | string | required | The restore drill cadence, such as quarterly. |
lastDrill | datetime | When the last restore drill met both objectives. | |
capability | Capability | The Capability the objective restores. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
recoveryObjective | Recovery Objective | required | The Recovery Objective. |
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 recoveryObjective = await $.RecoveryObjective.create({ recoveryPoint: 'Example recovery point', recoveryTime: 'Example recovery time', drillEvery: 'Example drill every' })RecoveryObjective.get
Returns one Recovery Objective by id. Verb page.
interface RecoveryObjectiveVerbs {
get(input: RecoveryObjectiveGetInput, options?: SB.CallOptions): SB.Call<RecoveryObjective>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Recovery Objective. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
recoveryObjective | Recovery Objective | required | The Recovery Objective. |
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 recoveryObjective = await $.RecoveryObjective.get({ id: 'recovery_MSAgl5dysq' })RecoveryObjective.list
Returns Recovery Objectives, newest first, one page at a time. Verb page.
interface RecoveryObjectiveVerbs {
list(input?: RecoveryObjectiveListInput, options?: SB.CallOptions): SB.ListCall<RecoveryObjective>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
recoveryObjectives | list of Recovery Objective | required | One page of Recovery Objectives. |
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 recoveryObjectives = await $.RecoveryObjective.list({ limit: 20 })