Ex4pmDomain.Event (ex4pm v26.9.9)

Copy Markdown View Source

Ash Resource representing an OCEL 2.0 observed event.

Summary

Types

t()

Functions

default_short_name()
input(opts)

Validates that the keys in the provided input are valid for at least one action on the resource.

input(opts, action)

Same as input/1, except restricts the keys to values accepted by the action provided.

primary_key_matches?(left, right)

Types

t()

@type t() :: %Ex4pmDomain.Event{
  __lateral_join_source__: term(),
  __meta__: term(),
  __metadata__: term(),
  __order__: term(),
  activity: term(),
  activity_id_num: term(),
  agent: term(),
  agent_id: term(),
  aggregates: term(),
  attributes: term(),
  calculations: term(),
  event_id_num: term(),
  event_objects: term(),
  id: term(),
  ocel_event: term(),
  run: term(),
  run_id: term(),
  sequence: term(),
  subject_hash: term(),
  timestamp: term()
}

Functions

default_short_name()

input(opts)

@spec input(values :: map() | Keyword.t()) :: map() | no_return()

Validates that the keys in the provided input are valid for at least one action on the resource.

Raises a KeyError error at compile time if not. This exists because generally a struct should only ever be created by Ash as a result of a successful action. You should not be creating records manually in code, e.g %MyResource{value: 1, value: 2}. Generally that is fine, but often with embedded resources it is nice to be able to validate the keys that are being provided, e.g

Resource
|> Ash.Changeset.for_create(:create, %{embedded: EmbeddedResource.input(foo: 1, bar: 2)})
|> Ash.create()

input(opts, action)

@spec input(values :: map() | Keyword.t(), action :: atom()) :: map() | no_return()

Same as input/1, except restricts the keys to values accepted by the action provided.

primary_key_matches?(left, right)