retrostash-ktor/dev.logickoder.retrostash.ktor/RetrostashKtorMetadata

RetrostashKtorMetadata

data class RetrostashKtorMetadata(val scopeName: String, val queryTemplate: String? = null, val maxAgeMs: Long = 0, val bindings: Map<String, String> = emptyMap(), val bodyBytes: ByteArray? = null, val invalidateTemplates: List<String> = emptyList(), val tagTemplates: List<String> = emptyList(), val invalidateTagTemplates: List<String> = emptyList())

Per-request Retrostash metadata attached to a Ktor HttpRequestBuilder via retrostash, retrostashQuery, or retrostashMutate. Read by RetrostashPlugin on request and response hooks to drive cache lookup, persistence, and invalidation.

Constructors

constructor(scopeName: String, queryTemplate: String? = null, maxAgeMs: Long = 0, bindings: Map<String, String> = emptyMap(), bodyBytes: ByteArray? = null, invalidateTemplates: List<String> = emptyList(), tagTemplates: List<String> = emptyList(), invalidateTagTemplates: List<String> = emptyList())

Properties

bindings

val bindings: Map<String, String>

Pre-extracted placeholder values for queryTemplate / invalidateTemplates.

bodyBytes

val bodyBytes: ByteArray?

Optional raw request body — fallback source for placeholders not in bindings (matched via JSON field lookup).

invalidateTagTemplates

val invalidateTagTemplates: List<String>

Tag templates resolved on mutation success and matched against per-entry tag sets in the store.

invalidateTemplates

val invalidateTemplates: List<String>

Templates to clear after a successful mutation. Resolved against bindings / bodyBytes before being passed to the store.

maxAgeMs

val maxAgeMs: Long

TTL for persisted entries in milliseconds. 0 disables persistence even when queryTemplate is set.

queryTemplate

val queryTemplate: String?

Cache template (e.g. "feed/{id}"). Non-null marks the request as a query candidate for cache lookup and (when maxAgeMs> 0) persistence.

scopeName

val scopeName: String

Logical namespace (typically the API interface name) — prevents key collisions between unrelated APIs sharing template shapes.

tagTemplates

val tagTemplates: List<String>

Tag templates persisted with the cached entry on the query side. Resolved against bindings / bodyBytes at write time.