Record Class HarnessEvent.TokenSpend
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.ai.HarnessEvent.TokenSpend
- Record Components:
inputTokens- input tokens billed for this single chat call.outputTokens- output tokens billed for this single chat call.
- All Implemented Interfaces:
HarnessEvent
- Enclosing interface:
HarnessEvent
public static record HarnessEvent.TokenSpend(int inputTokens, int outputTokens)
extends Record
implements HarnessEvent
Emitted after a chat response that reports token usage, carrying the input and output tokens
billed for that one call. Suppressed when the provider returns no usage information, so this
event is best-effort: a turn with no usage reports produces no
HarnessEvent.TokenSpend events at
all. Per-call deltas, not cumulative — consumers that want a session total sum these
themselves.
Sub-harness HarnessEvent.TokenSpend events are forwarded into the orchestrator's stream, so a
parent consumer sees one event per chat call across the entire orchestrator + subagent tree,
not one per chat call in the orchestrator's own loop. Subagent events arrive between the
enclosing HarnessEvent.SubagentStarted and HarnessEvent.SubagentFinished.
-
Nested Class Summary
Nested classes/interfaces inherited from interface HarnessEvent
HarnessEvent.ModelMessage, HarnessEvent.ModelThinking, HarnessEvent.ReplyRejected, HarnessEvent.ResponseTruncated, HarnessEvent.SubagentFinished, HarnessEvent.SubagentStarted, HarnessEvent.TokenSpend, HarnessEvent.ToolCallCompleted, HarnessEvent.ToolCallFailed, HarnessEvent.ToolCallRequested, HarnessEvent.TurnFinished, HarnessEvent.TurnStarted, HarnessEvent.WindowUsage -
Constructor Summary
ConstructorsConstructorDescriptionTokenSpend(int inputTokens, int outputTokens) Creates an instance of aTokenSpendrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.intReturns the value of theinputTokensrecord component.intReturns the value of theoutputTokensrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
TokenSpend
public TokenSpend(int inputTokens, int outputTokens) Creates an instance of aTokenSpendrecord class.- Parameters:
inputTokens- the value for theinputTokensrecord componentoutputTokens- the value for theoutputTokensrecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with thecomparemethod from their corresponding wrapper classes. -
inputTokens
public int inputTokens()Returns the value of theinputTokensrecord component.- Returns:
- the value of the
inputTokensrecord component
-
outputTokens
public int outputTokens()Returns the value of theoutputTokensrecord component.- Returns:
- the value of the
outputTokensrecord component
-