CitraClient.Schemas.BatchCollectionRequestCreate (citra_client v0.3.0)

View Source

Schema for batch creation of collection requests across multiple satellites.

Fields

  • :discover_visible — boolean() (API key: discoverVisible) — When True, the backend discovers satellites visible from the ground station(s) in params.ground_station_ids and populates satellite_ids automatically.
  • :exclude_types — list of String.t() (API key: excludeTypes) — Satellite types to exclude (e.g. 'Debris', 'Rocket Body')
  • :include_orbit_regimes — list of String.t() (API key: includeOrbitRegimes) — Only include satellites in these orbit regimes (e.g. 'GEO', 'LEO')
  • :params — map() — Type-specific parameters
  • :priority — integer() — Scheduling priority 0-10 (higher = more important)
  • :revisit — boolean() — Whether to create multiple observation opportunities per satellite. When True, the window is subdivided into sub-windows based on satellite count and observation duration.
  • :satellite_group_ids — list of UUID String.t() (API key: satelliteGroupIds) — Satellite group IDs to resolve satellites from
  • :satellite_ids — list of UUID String.t() (API key: satelliteIds) — Direct list of satellite IDs to task
  • :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.BatchCollectionRequestCreate{
  discover_visible: boolean() | nil,
  exclude_types: [String.t() | nil],
  include_orbit_regimes: [String.t() | nil],
  params: map() | nil,
  priority: integer() | nil,
  revisit: boolean() | nil,
  satellite_group_ids: [String.t() | nil],
  satellite_ids: [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.