Astarte.Core.Triggers.Policy (astarte_core v1.3.0)

Copy Markdown View Source

Summary

Types

t()

Functions

changeset(policy, params \\ %{})
from_policy_proto(policy_proto)

Creates a Policy from a PolicyProto. Returns {:ok, %Policy{}} on success, {:error, :invalid_policy_data} on failure

from_policy_proto!(policy_proto)

Creates a Policy from a PolicyProto.

to_policy_proto(policy)

Creates a PolicyProto from a Policy.

valid_name?(name)

Types

t()

@type t() :: %Astarte.Core.Triggers.Policy{
  error_handlers: [Astarte.Core.Triggers.Policy.Handler.t()],
  event_ttl: integer() | nil,
  maximum_capacity: integer() | nil,
  name: String.t() | nil,
  prefetch_count: integer() | nil,
  retry_times: integer() | nil
}

Functions

changeset(policy, params \\ %{})

from_policy_proto(policy_proto)

Creates a Policy from a PolicyProto. Returns {:ok, %Policy{}} on success, {:error, :invalid_policy_data} on failure

from_policy_proto!(policy_proto)

Creates a Policy from a PolicyProto.

Returns the %Policy{} on success, raises on failure

to_policy_proto(policy)

Creates a PolicyProto from a Policy.

It is assumed that the Policy is valid and constructed using Policy.changeset

Returns a %PolicyProto{}

valid_name?(name)