CitraClient.Schemas.TaskCreate (citra_client v0.3.0)

View Source

Task schema for creation

Fields

  • :antenna_id — UUID String.t() (API key: antennaId) — Antenna this task is associated with
  • :satellite_id — UUID String.t() (API key: satelliteId) — Satellite this task is associated with
  • :task_start — DateTime.t() (API key: taskStart) — Time the task can start to be collected
  • :task_stop — DateTime.t() (API key: taskStop) — Time the task should stop being collected
  • :telescope_id — UUID String.t() (API key: telescopeId) — Telescope this task is associated with

Summary

Types

t()

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.

Types

t()

@type t() :: %CitraClient.Schemas.TaskCreate{
  antenna_id: String.t() | nil,
  satellite_id: String.t() | nil,
  task_start: DateTime.t() | nil,
  task_stop: DateTime.t() | nil,
  telescope_id: String.t() | nil
}

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.