ApiKeyRing class final

A rotating view over one provider's API-key stack.

Not synchronized: the harness drives agents single-threaded per run, and backoff timestamps make cross-run sharing benign.

Constructors

ApiKeyRing({required String baseName, required List<ApiKeyCredential> credentials, int? startIndex, DateTime now()?}): Creates a ring over credentials (must be non-empty), starting at a round-robin offset for baseName unless startIndex pins one (tests).

availableCredential → ApiKeyCredential?: The affinity credential: the current position unless it is in backoff, in which case the next non-benched credential (round-robin order). null when every credential is benched.
no setter
baseName → String: The secrets-store base name this ring rotates (e.g. OPENAI_API_KEY).
final
currentCredential → ApiKeyCredential: The credential at the current position, ignoring backoff.
no setter
earliestBackoffEnd → DateTime?: The earliest moment any benched credential frees up, or null when no credential is in backoff. Used to wait out a fully benched stack (omp's sibling-credential wait).
no setter
hashCode → int: The hash code for this object.
no setterinherited
length → int: The number of credentials in the stack.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

isInBackoff(String name) → bool: Whether name is benched right now.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
reportRateLimited(String name, Duration backoff) → void: Benches the credential name for backoff from now.
rotate(String from) → ApiKeyCredential?: Advances the affinity position past from to the next non-benched credential (round-robin), returning it; null when all are benched.
stickTo(ApiKeyCredential credential) → void: Advances the affinity position to credential (session affinity: a switched key stays current until it fails).
toString() → String: A string representation of this object.
inherited

fromSecrets(Map<String, String> secrets, String baseName, {int? startIndex, DateTime now()?}) → ApiKeyRing?: Builds a ring from secrets for baseName; returns null when the stack is empty (no key configured).