Package com.axelor.ai.chat.stream

Record Class StreamEvent.Finish

java.lang.Object

java.lang.Record

com.axelor.ai.chat.stream.StreamEvent.Finish

All Implemented Interfaces:

StreamEvent

Enclosing interface:

StreamEvent

public static record StreamEvent.Finish(FinishReason finishReason, Object messageMetadata)
extends Record
implements StreamEvent

Nested Class Summary

Nested classes/interfaces inherited from interface com.axelor.ai.chat.stream.StreamEvent

StreamEvent.Abort, StreamEvent.Custom, StreamEvent.Data, StreamEvent.Error, StreamEvent.File, StreamEvent.Finish, StreamEvent.FinishStep, StreamEvent.MessageMetadata, StreamEvent.ReasoningDelta, StreamEvent.ReasoningEnd, StreamEvent.ReasoningFile, StreamEvent.ReasoningStart, StreamEvent.ResetStep, StreamEvent.SourceDocument, StreamEvent.SourceUrl, StreamEvent.Start, StreamEvent.StartStep, StreamEvent.TextDelta, StreamEvent.TextEnd, StreamEvent.TextStart, StreamEvent.ToolApprovalRequest, StreamEvent.ToolApprovalResponse, StreamEvent.ToolInputAvailable, StreamEvent.ToolInputDelta, StreamEvent.ToolInputError, StreamEvent.ToolInputStart, StreamEvent.ToolOutputAvailable, StreamEvent.ToolOutputDenied, StreamEvent.ToolOutputError, StreamEvent.TypeResolver

Constructor Summary

Constructors

Constructor	Description
Finish(FinishReason finishReason, Object messageMetadata)	Creates an instance of a Finish record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
FinishReason	finishReason()	Returns the value of the finishReason record component.
final int	hashCode()	Returns a hash code value for this object.
Object	messageMetadata()	Returns the value of the messageMetadata record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Finish

public Finish(FinishReason finishReason,
 Object messageMetadata)

Creates an instance of a Finish record class.

Parameters:

finishReason - the value for the finishReason record component

messageMetadata - the value for the messageMetadata record component

Method Details

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.

finishReason

public FinishReason finishReason()

Returns the value of the finishReason record component.

Returns:

the value of the finishReason record component

messageMetadata

public Object messageMetadata()

Returns the value of the messageMetadata record component.

Returns:

the value of the messageMetadata record component