CitraClient.Schemas.CafCollectionRequestWithTimeline (citra_client v0.3.0)

View Source

A collection request extended with its aggregated CAF timeline data.

Fields

  • :antenna_ids — list of UUID String.t() (API key: antennaIds) — Target antenna IDs
  • :creation_epoch — DateTime.t() (API key: creationEpoch)
  • :ground_station_ids — list of UUID String.t() (API key: groundStationIds) — Target ground station IDs
  • :id — UUID String.t()
  • :params — map() — Type-specific parameters
  • :priority — integer() — Scheduling priority (higher = more important)
  • :satellite_id — UUID String.t() (API key: satelliteId) — Target satellite
  • :satellite_name — String.t() (API key: satelliteName) — Name of the target satellite
  • :status — CollectionRequestStatus (see OpenAPI spec)
  • :tasks — list of CitraClient.Schemas.Task.t() — Tasks spawned from this request
  • :telescope_ids — list of UUID String.t() (API key: telescopeIds) — Target telescope IDs
  • :timeline — list of CitraClient.Schemas.CafTimeBinSummary.t()
  • :type — CollectionRequestType (see OpenAPI spec)
  • :update_epoch — DateTime.t() (API key: updateEpoch)
  • :user_id — UUID String.t() (API key: userId) — User who created this request
  • :username — String.t() — Username of the requester
  • :window_start — DateTime.t() (API key: windowStart)
  • :window_stop — DateTime.t() (API key: windowStop)

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.CafCollectionRequestWithTimeline{
  antenna_ids: [String.t() | nil],
  creation_epoch: DateTime.t() | nil,
  ground_station_ids: [String.t() | nil],
  id: String.t() | nil,
  params: map() | nil,
  priority: integer() | nil,
  satellite_id: String.t() | nil,
  satellite_name: String.t() | nil,
  status: map() | String.t() | nil,
  tasks: [CitraClient.Schemas.Task.t() | map() | nil],
  telescope_ids: [String.t() | nil],
  timeline: [CitraClient.Schemas.CafTimeBinSummary.t() | map() | nil],
  type: map() | String.t() | nil,
  update_epoch: DateTime.t() | nil,
  user_id: String.t() | nil,
  username: String.t() | nil,
  window_start: DateTime.t() | nil,
  window_stop: DateTime.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.