CitraClient.Schemas.IQUpload (citra_client v0.3.0)

View Source

Full IQ upload record schema.

Fields

  • :antenna_id — UUID String.t() (API key: antennaId)
  • :bandwidth_hz — number() (API key: bandwidthHz)
  • :capture_epoch_ns — integer() (API key: captureEpochNs)
  • :center_frequency_hz — number() (API key: centerFrequencyHz)
  • :creation_epoch — DateTime.t() (API key: creationEpoch)
  • :duration_seconds — number() (API key: durationSeconds)
  • :file_size — integer() (API key: fileSize)
  • :id — UUID String.t()
  • :original_filename — String.t() (API key: originalFilename)
  • :s3_key — String.t() (API key: s3Key)
  • :sample_rate_hz — number() (API key: sampleRateHz)
  • :task_id — UUID String.t() (API key: taskId)
  • :user_id — UUID String.t() (API key: userId)

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.IQUpload{
  antenna_id: String.t() | nil,
  bandwidth_hz: number() | nil,
  capture_epoch_ns: integer() | nil,
  center_frequency_hz: number() | nil,
  creation_epoch: DateTime.t() | nil,
  duration_seconds: number() | nil,
  file_size: integer() | nil,
  id: String.t() | nil,
  original_filename: String.t() | nil,
  s3_key: String.t() | nil,
  sample_rate_hz: number() | nil,
  task_id: String.t() | nil,
  user_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.