AuthenticationError
Thrown when authentication fails.Extended by
GitAuthError
Constructors
Parameters
Returns
AuthenticationError
BuildError
Thrown when the build fails.Extended by
FileUploadError
Constructors
Parameters
Returns
BuildError
FileNotFoundError
Thrown when a file or directory is not found inside a sandbox.Constructors
Parameters
Returns
FileNotFoundError
Properties
FileUploadError
Thrown when the file upload fails.Constructors
Parameters
Returns
FileUploadError
GitAuthError
Thrown when git authentication fails.
Deprecated
Run git withsandbox.commands.run() instead. The git module will be removed in the next major version.
Constructors
Parameters
Returns
GitAuthError
GitUpstreamError
Thrown when git upstream tracking is missing.
Deprecated
Run git withsandbox.commands.run() instead. The git module will be removed in the next major version.
Constructors
Parameters
Returns
GitUpstreamError
Properties
InvalidArgumentError
Thrown when an invalid argument is provided.Constructors
Parameters
Returns
InvalidArgumentError
Properties
NotEnoughSpaceError
Thrown when there is not enough disk space.Constructors
Parameters
Returns
NotEnoughSpaceError
Properties
NotFoundError
Thrown when a resource is not found.
Deprecated
Use FileNotFoundError or SandboxNotFoundError instead. This class will be removed in the next major version.Extended by
FileNotFoundErrorSandboxNotFoundError
Constructors
Parameters
Returns
NotFoundError
Properties
RateLimitError
Thrown when the API rate limit is exceeded.Constructors
Parameters
Returns
RateLimitError
Properties
SandboxError
Base class for all sandbox errors. Thrown when general sandbox errors occur.Extended by
TimeoutErrorInvalidArgumentErrorNotEnoughSpaceErrorNotFoundErrorGitUpstreamErrorTemplateErrorRateLimitError
Constructors
Parameters
Returns
SandboxError
Properties
SandboxNotFoundError
Thrown when a sandbox is not found (e.g. it doesn’t exist or is no longer running).Constructors
Parameters
Returns
SandboxNotFoundError
Properties
SandboxNotRunningError
Thrown when the sandbox is not running anymore: the proxy in front of it answered a request (or the health probe run after a request failed at the connection level) with the sandbox not found — it was killed, paused or reached its timeout. Retrying the request will not help; create or resume a sandbox. The split fromSandboxUnreachableError is only as good as the proxy’s answer
and the health probe: a sandbox that is gone but could not be asked about is a
SandboxUnreachableError. SandboxNotFoundError is only raised by the control
plane API (e.g. Sandbox.connect() to a sandbox that does not exist).
Subclass of TimeoutError, which this case surfaced as before.
Constructors
Parameters
Returns
SandboxNotRunningError
Properties
SandboxUnreachableError
Thrown when the sandbox could not be reached while it is not confirmed to be stopped: the proxy in front of the sandbox reports it running but envd’s port not open (e.g. the sandbox’s network is down), the proxy or envd answered with an unavailability the health probe could not resolve (e.g. the connection to the sandbox was lost mid-stream while the probe found it running), or a request failed at the connection level (the connection could not be established or was dropped mid-request) and the follow-up health probe got no answer from the sandbox either. A sandbox confirmed stopped (or paused) is aSandboxNotRunningError — but only as far as the probe can tell: a sandbox
that is gone and could not be asked about surfaces here.
This usually means the sandbox’s network is down, envd inside it is not up
(yet), or a network issue between the client and the sandbox. Check the
sandbox state with Sandbox.getInfo().
Subclass of TimeoutError, which these cases surfaced as before.
Constructors
Parameters
Returns
SandboxUnreachableError
Properties
SecretError
Base class for all secret errors. Thrown when general secret errors occur.Extended by
SecretNotFoundError
Constructors
Parameters
Returns
SecretError
SecretNotFoundError
Thrown when a secret is not found.Constructors
Parameters
Returns
SecretNotFoundError
ServiceBusyError
Thrown when the API refused the operation because the service is temporarily busy (HTTP 503): no capacity to place a sandbox right now, or the node running the sandbox declined a request it cannot serve yet. Nothing was changed by the refused call: for example a refused pause leaves the sandbox running with its state intact, so the same call can be retried after a short wait. Like AuthenticationError and unlike the other API errors, this is not a SandboxError: it is raised for every 503 whatever the operation, so catch it explicitly.Constructors
Parameters
Returns
ServiceBusyError
Properties
TemplateError
Thrown when the template uses old envd version. It isn’t compatible with the new SDK.Constructors
Parameters
Returns
TemplateError
Properties
TimeoutError
Thrown when a timeout error occurs. The [unavailable] error type is caused by sandbox timeout. The [canceled] error type is caused by exceeding request timeout. The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly.Extended by
SandboxNotRunningErrorSandboxUnreachableError
Constructors
Parameters
Returns
TimeoutError
Properties
VolumeError
Base class for all volume errors. Thrown when general volume errors occur.Extended by
VolumeNotFoundErrorVolumePathNotFoundError
Constructors
Parameters
Returns
VolumeError
VolumeNotFoundError
Thrown when a volume is not found.Constructors
Parameters
Returns
VolumeNotFoundError
VolumePathNotFoundError
Thrown when a file or directory is not found inside a volume.Constructors
Parameters
Returns
VolumePathNotFoundError
Functions
formatSandboxUnavailableError()
SandboxNotRunningError; the sandbox
running but envd’s port not open (e.g. its network is down) a
SandboxUnreachableError; any other message (e.g. envd ending a stream because
the connection to the sandbox was lost) a SandboxUnreachableError too, with the
sandbox state reported as unknown.
Parameters
Returns
Error
isSandboxNotFoundMessage()
Parameters
Returns
boolean
isSandboxPortNotOpenMessage()
Parameters
Returns
boolean