Skip to main content

setAppComputeBudget

Set an app's compute allowance in units per minute. One unit is one millisecond of measured execution time; ck-exec work is converted from busy time and fuel. An over-ceiling value is REFUSED naming the ceiling (6000000 units per minute) rather than accepted and clamped, so the value reported back is always the value in force. Set enforce to true to pause the app's ck-exec code while its last settled minute is over the allowance; leave it false to record the allowance without pausing anything. Requires app-admin ('manage_apps').

setAppComputeBudget(
  appId: BigInt!
  unitsPerMinute: Int!
  enforce: Boolean = false
  note: String
): AppComputeBudgetInfo!

Arguments​

setAppComputeBudget.appId ● BigInt! non-null scalar​

The app (tenant) to set an allowance for.

setAppComputeBudget.unitsPerMinute ● Int! non-null scalar​

Compute units per minute; a positive integer no greater than 6000000.

setAppComputeBudget.enforce ● Boolean scalar​

True to pause the app's ck-exec code while it is over the allowance. False (the default) records the allowance and pauses nothing.

setAppComputeBudget.note ● String scalar​

Why this number was chosen. Recorded so the next operator can change it safely.

Type​

AppComputeBudgetInfo object​

An app's compute allowance in units per minute. Absent when no allowance has been set for the app, in which case its ck-exec code is never paused for its budget.