smart_city v5.4.5 SmartCity.EventLog View Source

Struct defining an event log event.

const EventLog = {
  "title": "",
  "timestamp", "",
  "source": "",
  "description": "",
  "dataset_id": "",
  "ingestion_id": ""
}

Link to this section Summary

Functions

Returns a new SmartCity.EventLog. Can be created from Map with string or atom keys. Raises an ArgumentError when passed invalid input

Link to this section Types

Link to this type

not_required(type)

View Source
not_required(type) :: type | nil
Link to this type

t()

View Source
t() :: %SmartCity.EventLog{
  dataset_id: String.t(),
  description: String.t(),
  ingestion_id: not_required(String.t()),
  source: String.t(),
  timestamp: DateTime.t(),
  title: String.t()
}

Link to this section Functions

Link to this function

get(struct, key, default \\ nil)

View Source
Link to this function

new(msg)

View Source
new(map()) :: t()
new(map()) :: t()
new(map()) :: t()
new(map()) :: t()

Returns a new SmartCity.EventLog. Can be created from Map with string or atom keys. Raises an ArgumentError when passed invalid input

Parameters

  • msg: Map with string or atom keys that defines the event log metadata

Required Keys:

- title
- timestamp
- source
- description
- dataset_id