CitraClient.Schemas.CollectionRequestCreate (citra_client v0.3.0)

View Source

CollectionRequest schema for creation

Fields

  • :params — map() — Type-specific parameters
  • :priority — integer() — Scheduling priority 0-10 (higher = more important)
  • :satellite_id — UUID String.t() (API key: satelliteId) — Target satellite
  • :type — CollectionRequestType (see OpenAPI spec) — Type of collection request (determines window generation logic)
  • :window_start — DateTime.t() (API key: windowStart) — Start of the collection window
  • :window_stop — DateTime.t() (API key: windowStop) — End of the collection window

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.CollectionRequestCreate{
  params: map() | nil,
  priority: integer() | nil,
  satellite_id: String.t() | nil,
  type: map() | 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.