Oban.Pro.Cloud behaviour (Oban Pro v1.5.0-rc.3)

A behaviour for interacting with cloud hosting providers.

Summary

Types

conf()

opts()

quantity()

Callbacks

init(opts)

Executed once at runtime to gather, normalize, and transform options.

scale(quantity, conf)

Called to horizontally scale a cloud resource up or down.

Types

conf()

@type conf() :: term()

opts()

@type opts() :: keyword()

quantity()

@type quantity() :: non_neg_integer()

Callbacks

init(opts)

@callback init(opts()) :: conf()

Executed once at runtime to gather, normalize, and transform options.

scale(quantity, conf)

@callback scale(quantity(), conf()) :: {:ok, conf()} | {:error, term()}

Called to horizontally scale a cloud resource up or down.

Successful scaling requests must return a new conf to be used during the next call to scale/2. That allows cloud modules to track responses for additional control and introspection.