Package io.agentscope.core.agui.event

Record Class AguiEvent.Custom

java.lang.Object

java.lang.Record

io.agentscope.core.agui.event.AguiEvent.Custom

All Implemented Interfaces:

AguiEvent

Enclosing interface:

AguiEvent

public static record AguiEvent.Custom(String threadId, String runId, String name, Object value)
extends Record
implements AguiEvent

The Custom event provides an extension mechanism for implementing features not covered by the standard event types.

Nested Class Summary

Nested classes/interfaces inherited from interface io.agentscope.core.agui.event.AguiEvent

AguiEvent.Custom, AguiEvent.JsonPatchOperation, AguiEvent.Raw, AguiEvent.ReasoningEnd, AguiEvent.ReasoningMessageChunk, AguiEvent.ReasoningMessageContent, AguiEvent.ReasoningMessageEnd, AguiEvent.ReasoningMessageStart, AguiEvent.ReasoningStart, AguiEvent.RunFinished, AguiEvent.RunStarted, AguiEvent.StateDelta, AguiEvent.StateSnapshot, AguiEvent.TextMessageContent, AguiEvent.TextMessageEnd, AguiEvent.TextMessageStart, AguiEvent.ToolCallArgs, AguiEvent.ToolCallEnd, AguiEvent.ToolCallResult, AguiEvent.ToolCallStart

Constructor Summary

Constructors

Constructor	Description
Custom(String threadId, String runId, String name, Object value)	Creates an instance of a Custom record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	getRunId()	Get the run ID associated with this event.
String	getThreadId()	Get the thread ID associated with this event.
AguiEventType	getType()	Get the event type.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
String	runId()	Returns the value of the runId record component.
String	threadId()	Returns the value of the threadId record component.
final String	toString()	Returns a string representation of this record class.
Object	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Custom

public Custom(String threadId,
 String runId,
 String name,
 Object value)

Creates an instance of a Custom record class.

Parameters:

threadId - the value for the threadId record component

runId - the value for the runId record component

name - the value for the name record component

value - the value for the value record component

Method Details

getType

public AguiEventType getType()

Description copied from interface: AguiEvent

Get the event type.

Specified by:

getType in interface AguiEvent

Returns:

The event type

getThreadId

public String getThreadId()

Description copied from interface: AguiEvent

Get the thread ID associated with this event.

Specified by:

getThreadId in interface AguiEvent

Returns:

The thread ID

getRunId

public String getRunId()

Description copied from interface: AguiEvent

Get the run ID associated with this event.

Specified by:

getRunId in interface AguiEvent

Returns:

The run ID

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

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 Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

threadId

public String threadId()

Returns the value of the threadId record component.

Returns:

the value of the threadId record component

runId

public String runId()

Returns the value of the runId record component.

Returns:

the value of the runId record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

value

public Object value()

Returns the value of the value record component.

Returns:

the value of the value record component