CitraClient.Schemas.Task (citra_client v0.3.0)

View Source

Task schema for reading

Fields

  • :antenna_id — UUID String.t() (API key: antennaId) — Antenna this task is associated with
  • :antenna_name — String.t() (API key: antennaName) — Name of the antenna
  • :antenna_user_id — UUID String.t() (API key: antennaUserId) — User ID of the antenna owner
  • :assigned_filter_name — String.t() (API key: assignedFilterName) — Filter name for Characterization tasks
  • :collection_request_id — UUID String.t() (API key: collectionRequestId) — Collection request this task is associated with
  • :creation_epoch — DateTime.t() (API key: creationEpoch)
  • :frequency_max — number() (API key: frequencyMax) — Maximum frequency in Hz
  • :frequency_min — number() (API key: frequencyMin) — Minimum frequency in Hz
  • :ground_station_id — UUID String.t() (API key: groundStationId) — Ground station ID of the telescope or antenna
  • :ground_station_name — String.t() (API key: groundStationName) — Name of the ground station
  • :id — UUID String.t()
  • :priority — integer() — Scheduling priority (higher = more important)
  • :satellite_id — UUID String.t() (API key: satelliteId) — Satellite this task is associated with
  • :satellite_name — String.t() (API key: satelliteName) — Name of the satellite
  • :status — TaskStatus (see OpenAPI spec)
  • :task_start — DateTime.t() (API key: taskStart)
  • :task_stop — DateTime.t() (API key: taskStop)
  • :telescope_id — UUID String.t() (API key: telescopeId) — Telescope this task is associated with
  • :telescope_name — String.t() (API key: telescopeName) — Name of the telescope
  • :type — TaskType (see OpenAPI spec)
  • :update_epoch — DateTime.t() (API key: updateEpoch)
  • :user_id — UUID String.t() (API key: userId) — User who requested this task
  • :username — String.t() — Username of the user who requested this task

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.Task{
  antenna_id: String.t() | nil,
  antenna_name: String.t() | nil,
  antenna_user_id: String.t() | nil,
  assigned_filter_name: String.t() | nil,
  collection_request_id: String.t() | nil,
  creation_epoch: DateTime.t() | nil,
  frequency_max: number() | nil,
  frequency_min: number() | nil,
  ground_station_id: String.t() | nil,
  ground_station_name: String.t() | nil,
  id: String.t() | nil,
  priority: integer() | nil,
  satellite_id: String.t() | nil,
  satellite_name: String.t() | nil,
  status: map() | String.t() | nil,
  task_start: DateTime.t() | nil,
  task_stop: DateTime.t() | nil,
  telescope_id: String.t() | nil,
  telescope_name: String.t() | nil,
  type: map() | String.t() | nil,
  update_epoch: DateTime.t() | nil,
  user_id: String.t() | nil,
  username: 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.