WriteOperationError
A local write refusal. operationIndex is the refused operation’s position
in the submission (or the builder); it is undefined when the refusal is
about the whole batch, such as a builder that was already submitted.
code is VALIDATION_ERROR unless the refusal names another:
NOT_FOUND (a keepShapes target that does not exist), RESERVED_NAME,
ILLEGAL_OP_SEQUENCE, or a Shape-name preflight code.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WriteOperationError(
operationIndex,message,code?):WriteOperationError
Parameters
Section titled “Parameters”operationIndex
Section titled “operationIndex”number | undefined
message
Section titled “message”string
string = 'VALIDATION_ERROR'
Returns
Section titled “Returns”WriteOperationError
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlycode:string
Stable SDK error code or pass-through backend domain code. Branch on this (or the alias kind) to handle expected failure modes.
Inherited from
Section titled “Inherited from”status?
Section titled “status?”
readonlyoptionalstatus?:number
HTTP status from the failing response when one was available.
Inherited from
Section titled “Inherited from”
readonlyoptionalhint?:string
Optional human-readable hint surfaced by the backend.
Inherited from
Section titled “Inherited from”retryAfter?
Section titled “retryAfter?”
readonlyoptionalretryAfter?:number
Seconds the caller should wait before retrying. Present on RATE_LIMITED
responses and other backend signals that carry a Retry-After header.
Inherited from
Section titled “Inherited from”errorCode?
Section titled “errorCode?”
readonlyoptionalerrorCode?:string
Canonical domain error code from the response body. Set iff the backend wire
carried a structured error.code string. Use this when the question is
“did the backend specifically say this?”. For best-effort labelling that
also covers SDK-local transport codes (NETWORK, CANCELLED, the
generic BACKEND fallback), branch on code or kind.
Inherited from
Section titled “Inherited from”backendCode?
Section titled “backendCode?”
readonlyoptionalbackendCode?:string
Inherited from
Section titled “Inherited from”details?
Section titled “details?”
readonlyoptionaldetails?:WarmHubErrorDetails
Structured backend error details, when the response carried them. Branch on
details.reason: an expected_version_mismatch carries
expectedVersion/currentVersion so an optimistic-concurrency caller can
re-read HEAD and retry (#3624); a lease_held carries leaseExpiresAt so a
caller can back off until the lease expires (#3625). Present only when the
backend wire carried data.warmhub.details. See WarmHubErrorDetails.
Inherited from
Section titled “Inherited from”decorationFailure?
Section titled “decorationFailure?”
readonlyoptionaldecorationFailure?:true
Present (true) when this error came from the response-decoration
label lookup rather than the read itself — the read may have succeeded.
Set by the decoration link (see
WarmHubClientOptions.decorateResponses); surfaces use it to
suggest retrying without decoration. declare: assigned by the link,
never by this constructor.
Inherited from
Section titled “Inherited from”WarmHubError.decorationFailure
operationIndex
Section titled “operationIndex”
readonlyoperationIndex:number|undefined
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get kind():
ErrorKind