Oban Pro
v0.14.2

Oban.Pro.Cloud behaviour (Oban Pro v0.14.2)

A behaviour for interacting with cloud hosting providers.

Link to this section 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.

Link to this section Types

Link to this type

conf()

@type conf() :: term()
Link to this type

opts()

@type opts() :: keyword()
Link to this type

quantity()

@type quantity() :: non_neg_integer()

Link to this section Callbacks

Link to this callback

init(opts)

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

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

Link to this callback

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.