AshOban.Info (ash_oban v0.4.9)

View Source

Introspection for AshOban

Summary

Functions

The Domain to use when calling actions on this resource. Defaults to the resource's domain.

The Domain to use when calling actions on this resource. Defaults to the resource's domain.

A list of tenants or a function behaviour that returns a list of tenants a trigger should be run for. Can be overwritten on the trigger level.

A list of tenants or a function behaviour that returns a list of tenants a trigger should be run for. Can be overwritten on the trigger level.

oban.scheduled_actions DSL entities

oban.triggers DSL entities

Functions

oban_domain(dsl_or_extended)

@spec oban_domain(dsl_or_extended :: module() | map()) :: {:ok, module()} | :error

The Domain to use when calling actions on this resource. Defaults to the resource's domain.

oban_domain!(dsl_or_extended)

@spec oban_domain!(dsl_or_extended :: module() | map()) :: module() | no_return()

The Domain to use when calling actions on this resource. Defaults to the resource's domain.

oban_list_tenants(dsl_or_extended)

@spec oban_list_tenants(dsl_or_extended :: module() | map()) ::
  {:ok, [any()] | module() | tuple() | (-> any())} | :error

A list of tenants or a function behaviour that returns a list of tenants a trigger should be run for. Can be overwritten on the trigger level.

oban_list_tenants!(dsl_or_extended)

@spec oban_list_tenants!(dsl_or_extended :: module() | map()) ::
  ([any()] | module() | tuple() | (-> any())) | no_return()

A list of tenants or a function behaviour that returns a list of tenants a trigger should be run for. Can be overwritten on the trigger level.

oban_options(dsl_or_extended)

@spec oban_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

oban DSL options

Returns a map containing the and any configured or default values.

oban_scheduled_action(resource, name)

@spec oban_scheduled_action(Ash.Resource.t() | Spark.Dsl.t(), atom()) ::
  nil | AshOban.Schedule.t()

oban_scheduled_actions(dsl_or_extended)

@spec oban_scheduled_actions(dsl_or_extended :: module() | map()) :: [struct()]

oban.scheduled_actions DSL entities

oban_trigger(resource, name)

@spec oban_trigger(Ash.Resource.t() | Spark.Dsl.t(), atom()) ::
  nil | AshOban.Trigger.t()

oban_triggers(dsl_or_extended)

@spec oban_triggers(dsl_or_extended :: module() | map()) :: [struct()]

oban.triggers DSL entities

oban_triggers_and_scheduled_actions(resource)

@spec oban_triggers_and_scheduled_actions(Ash.Resource.t() | Spark.Dsl.t()) :: [
  AshOban.Trigger.t() | AshOban.Schedule.t()
]

pro?()