OptionalcauseReadonlycodeMachine-readable reason. Branch on this, never on the text.
ReadonlyhintWhat to do instead. For a fan-out refusal this names the metrics defined at the grain where the question is well defined.
ReadonlyreasonOne sentence stating what was wrong.
ReadonlyretryHow to treat this refusal. Prefer Refused.shouldModify, Refused.shouldWait and Refused.isFinal to comparing it.
OptionalstackReadonlystatusThe HTTP status that carried the refusal. 0 when it came from a job.
StaticstackThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
No version of this request from this caller will succeed.
Usually a denial. Say so rather than substituting a different metric that answers a different question.
The request is answerable, but not as written.
Change the arguments and try again. Repeating it unchanged will not work. The hint usually names what to change.
Nothing about the request is wrong.
Something outside it failed, such as the policy source being unreachable, or this caller is at their concurrency limit. The same request may succeed shortly.
StaticcaptureCreates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
OptionalconstructorOpt: FunctionStaticfromBuild a refusal from an engine error body.
Unrecognised values fall back to never, which stops a caller rather than
inviting it to loop on something this client did not understand.
Staticprepare
The engine declined the request and said why.