Enum Error

pub enum Error {
    InvalidGatewayUri {
        message: String,
        uri: String,
    },
    Transport(Error),
    GRPC(Status),
    FileIo {
        resource_file: String,
        source: Error,
    },
    InvalidParameters(&'static str),
    DeserializationError(Error),
    MissingWorkerStateConfig,
    Auth(String),
}

The error type which is returned from zeebe processing failures.

The gRPC API for Zeebe is exposed through the gateway, which acts as a proxy for the broker. Generally, this means that the client executes an remote call on the gateway, which is then translated to special binary protocol that the gateway uses to communicate with the broker.

As a result of this proxying, any errors which occur between the gateway and the broker for which the client is not at fault (e.g. the gateway cannot deserialize the broker response, the broker is unavailable, etc.) are reported to the client using the following error codes.

• GRPC_STATUS_RESOURCE_EXHAUSTED: if the broker is receiving too many requests more than what it can handle, it kicks off back-pressure and rejects requests with this error code. In this case, it is possible to retry the requests with an appropriate retry strategy. If you receive many such errors with in a small time period, it indicates that the broker is constantly under high load. It is recommended to reduce the rate of requests. When the back-pressure kicks off, the broker may reject any request except CompleteJob RPC and FailJob RPC. These requests are white-listed for back-pressure and are always accepted by the broker even if it is receiving requests above its limits.
• GRPC_STATUS_UNAVAILABLE: if the gateway itself is in an invalid state (e.g. out of memory)
• GRPC_STATUS_INTERNAL: for any other internal errors that occurred between the gateway and the broker.

This behavior applies to every single possible RPC; in these cases, it is possible that retrying would succeed, but it is recommended to do so with an appropriate retry policy (e.g. a combination of exponential backoff or jitter wrapped in a circuit breaker).

In the documentation below, the documented errors are business logic errors, meaning errors which are a result of request processing logic, and not serialization, network, or other more general errors.

Variants

InvalidGatewayUri

Error returned from invalid client gateway configuration.

Fields

message: String

The error message.

uri: String

The invalid uri argument.

Transport(Error)

GRPC transport errors.

GRPC(Status)

GRPC result errors

FileIo

File I/O errors when reading processes from disk.

Fields

resource_file: String

The specified resource file

source: Error

The underlying io::Error.

InvalidParameters(&'static str)

Invalid method parameters

DeserializationError(Error)

Job payload deserialization error

MissingWorkerStateConfig

Missing worker state configuration

Auth(String)

Authentication errors

Trait Implementations

impl Debug for Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Error

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Status> for Error

fn from(source: Status) -> Self

Converts to this type from the input type.