CitraClient.Schemas.BatchCollectionRequestResponse (citra_client v0.3.0)

View Source

Response schema for batch collection request creation.

Fields

  • :collection_request_ids — list of UUID String.t() (API key: collectionRequestIds) — IDs of created collection requests
  • :created_count — integer() (API key: createdCount) — Total number of collection requests created
  • :revisit_count — integer() (API key: revisitCount) — Number of sub-windows per satellite
  • :satellite_count — integer() (API key: satelliteCount) — Number of unique satellites tasked
  • :skipped_satellite_ids — list of UUID String.t() (API key: skippedSatelliteIds) — Satellite IDs that were filtered out

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.BatchCollectionRequestResponse{
  collection_request_ids: [String.t() | nil],
  created_count: integer() | nil,
  revisit_count: integer() | nil,
  satellite_count: integer() | nil,
  skipped_satellite_ids: [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.