Package io.camunda.client.protocol.rest

Class AgentInstanceHistoryItemResult

java.lang.Object

io.camunda.client.protocol.rest.AgentInstanceHistoryItemResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class AgentInstanceHistoryItemResult
extends Object

A single conversation history item belonging to an agent instance.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AGENT_INSTANCE_KEY
static final String	JSON_PROPERTY_COMMIT_STATUS
static final String	JSON_PROPERTY_CONTENT
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_HISTORY_ITEM_KEY
static final String	JSON_PROPERTY_JOB_KEY
static final String	JSON_PROPERTY_JOB_LEASE
static final String	JSON_PROPERTY_LOOP_ITERATION
static final String	JSON_PROPERTY_METRICS
static final String	JSON_PROPERTY_PRODUCED_AT
static final String	JSON_PROPERTY_ROLE
static final String	JSON_PROPERTY_TOOL_CALLS

Constructor Summary

Constructors

Constructor	Description
AgentInstanceHistoryItemResult()

Method Summary

Modifier and Type	Method	Description
AgentInstanceHistoryItemResult	addContentItem(AgentInstanceMessageContent contentItem)
AgentInstanceHistoryItemResult	addToolCallsItem(AgentInstanceToolCall toolCallsItem)
AgentInstanceHistoryItemResult	agentInstanceKey(String agentInstanceKey)
AgentInstanceHistoryItemResult	commitStatus(AgentInstanceHistoryCommitStatusEnum commitStatus)
AgentInstanceHistoryItemResult	content(List<AgentInstanceMessageContent> content)
AgentInstanceHistoryItemResult	elementInstanceKey(String elementInstanceKey)
boolean	equals(Object o)
String	getAgentInstanceKey()	The key of the agent instance this item belongs to.
AgentInstanceHistoryCommitStatusEnum	getCommitStatus()	The commit status of this history item.
List<AgentInstanceMessageContent>	getContent()	The content blocks of this history item.
String	getElementInstanceKey()	The key of the AI Agent Task or ad-hoc sub-process element instance under which this item was produced.
String	getHistoryItemKey()	The unique key for this history item.
String	getJobKey()	The key of the job activation during which this item was produced.
String	getJobLease()	The lease token of the activation that produced this item.
Integer	getLoopIteration()	The loopIteration this item belongs to.
AgentInstanceHistoryItemMetrics	getMetrics()	Per-call token and latency metrics.
String	getProducedAt()	The connector-side timestamp of when this message was produced.
AgentInstanceHistoryRoleEnum	getRole()	The role of this history item in the conversation.
List<AgentInstanceToolCall>	getToolCalls()	Tool calls for this item.
int	hashCode()
AgentInstanceHistoryItemResult	historyItemKey(String historyItemKey)
AgentInstanceHistoryItemResult	jobKey(String jobKey)
AgentInstanceHistoryItemResult	jobLease(String jobLease)
AgentInstanceHistoryItemResult	loopIteration(Integer loopIteration)
AgentInstanceHistoryItemResult	metrics(AgentInstanceHistoryItemMetrics metrics)
AgentInstanceHistoryItemResult	producedAt(String producedAt)
AgentInstanceHistoryItemResult	role(AgentInstanceHistoryRoleEnum role)
void	setAgentInstanceKey(String agentInstanceKey)
void	setCommitStatus(AgentInstanceHistoryCommitStatusEnum commitStatus)
void	setContent(List<AgentInstanceMessageContent> content)
void	setElementInstanceKey(String elementInstanceKey)
void	setHistoryItemKey(String historyItemKey)
void	setJobKey(String jobKey)
void	setJobLease(String jobLease)
void	setLoopIteration(Integer loopIteration)
void	setMetrics(AgentInstanceHistoryItemMetrics metrics)
void	setProducedAt(String producedAt)
void	setRole(AgentInstanceHistoryRoleEnum role)
void	setToolCalls(List<AgentInstanceToolCall> toolCalls)
AgentInstanceHistoryItemResult	toolCalls(List<AgentInstanceToolCall> toolCalls)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_HISTORY_ITEM_KEY

public static final String JSON_PROPERTY_HISTORY_ITEM_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_AGENT_INSTANCE_KEY

public static final String JSON_PROPERTY_AGENT_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_INSTANCE_KEY

public static final String JSON_PROPERTY_ELEMENT_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_JOB_KEY

public static final String JSON_PROPERTY_JOB_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_JOB_LEASE

public static final String JSON_PROPERTY_JOB_LEASE

See Also:

• Constant Field Values

JSON_PROPERTY_LOOP_ITERATION

public static final String JSON_PROPERTY_LOOP_ITERATION

See Also:

• Constant Field Values

JSON_PROPERTY_ROLE

public static final String JSON_PROPERTY_ROLE

See Also:

• Constant Field Values

JSON_PROPERTY_CONTENT

public static final String JSON_PROPERTY_CONTENT

See Also:

• Constant Field Values

JSON_PROPERTY_TOOL_CALLS

public static final String JSON_PROPERTY_TOOL_CALLS

See Also:

• Constant Field Values

JSON_PROPERTY_METRICS

public static final String JSON_PROPERTY_METRICS

See Also:

• Constant Field Values

JSON_PROPERTY_COMMIT_STATUS

public static final String JSON_PROPERTY_COMMIT_STATUS

See Also:

• Constant Field Values

JSON_PROPERTY_PRODUCED_AT

public static final String JSON_PROPERTY_PRODUCED_AT

See Also:

• Constant Field Values

Constructor Details

AgentInstanceHistoryItemResult

public AgentInstanceHistoryItemResult()

Method Details

historyItemKey

public AgentInstanceHistoryItemResult historyItemKey(@Nonnull
 String historyItemKey)

getHistoryItemKey

@Nonnull
public String getHistoryItemKey()

The unique key for this history item. Stable and sortable by creation order.

Returns:

historyItemKey

setHistoryItemKey

public void setHistoryItemKey(@Nonnull
 String historyItemKey)

agentInstanceKey

public AgentInstanceHistoryItemResult agentInstanceKey(@Nonnull
 String agentInstanceKey)

getAgentInstanceKey

@Nonnull
public String getAgentInstanceKey()

The key of the agent instance this item belongs to.

Returns:

agentInstanceKey

setAgentInstanceKey

public void setAgentInstanceKey(@Nonnull
 String agentInstanceKey)

elementInstanceKey

public AgentInstanceHistoryItemResult elementInstanceKey(@Nonnull
 String elementInstanceKey)

getElementInstanceKey

@Nonnull
public String getElementInstanceKey()

The key of the AI Agent Task or ad-hoc sub-process element instance under which this item was produced.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nonnull
 String elementInstanceKey)

jobKey

public AgentInstanceHistoryItemResult jobKey(@Nonnull
 String jobKey)

getJobKey

@Nonnull
public String getJobKey()

The key of the job activation during which this item was produced.

Returns:

jobKey

setJobKey

public void setJobKey(@Nonnull
 String jobKey)

jobLease

public AgentInstanceHistoryItemResult jobLease(@Nonnull
 String jobLease)

getJobLease

@Nonnull
public String getJobLease()

The lease token of the activation that produced this item.

Returns:

jobLease

setJobLease

public void setJobLease(@Nonnull
 String jobLease)

loopIteration

public AgentInstanceHistoryItemResult loopIteration(@Nullable
 Integer loopIteration)

getLoopIteration

@Nullable
public Integer getLoopIteration()

The loopIteration this item belongs to. A loopIteration is one pass through the agent feedback loop: one LLM call, its tool dispatches, and their results. Null if not provided by the connector. minimum: 1

Returns:

loopIteration

setLoopIteration

public void setLoopIteration(@Nullable
 Integer loopIteration)

role

public AgentInstanceHistoryItemResult role(@Nonnull
 AgentInstanceHistoryRoleEnum role)

getRole

@Nonnull
public AgentInstanceHistoryRoleEnum getRole()

The role of this history item in the conversation.

Returns:

role

setRole

public void setRole(@Nonnull
 AgentInstanceHistoryRoleEnum role)

content

public AgentInstanceHistoryItemResult content(@Nonnull
 List<AgentInstanceMessageContent> content)

addContentItem

public AgentInstanceHistoryItemResult addContentItem(AgentInstanceMessageContent contentItem)

getContent

@Nonnull
public List<AgentInstanceMessageContent> getContent()

The content blocks of this history item.

Returns:

content

setContent

public void setContent(@Nonnull
 List<AgentInstanceMessageContent> content)

toolCalls

public AgentInstanceHistoryItemResult toolCalls(@Nonnull
 List<AgentInstanceToolCall> toolCalls)

addToolCallsItem

public AgentInstanceHistoryItemResult addToolCallsItem(AgentInstanceToolCall toolCallsItem)

getToolCalls

@Nonnull
public List<AgentInstanceToolCall> getToolCalls()

Tool calls for this item. Empty for USER items and ASSISTANT items with no tool dispatches. ASSISTANT items: dispatched tool calls with arguments populated. TOOL_RESULT items: single-entry array referencing the originating tool call (arguments null).

Returns:

toolCalls

setToolCalls

public void setToolCalls(@Nonnull
 List<AgentInstanceToolCall> toolCalls)

metrics

public AgentInstanceHistoryItemResult metrics(@Nullable
 AgentInstanceHistoryItemMetrics metrics)

getMetrics

@Nullable
public AgentInstanceHistoryItemMetrics getMetrics()

Per-call token and latency metrics. Null when metrics were not provided at creation time.

Returns:

metrics

setMetrics

public void setMetrics(@Nullable
 AgentInstanceHistoryItemMetrics metrics)

commitStatus

public AgentInstanceHistoryItemResult commitStatus(@Nonnull
 AgentInstanceHistoryCommitStatusEnum commitStatus)

getCommitStatus

@Nonnull
public AgentInstanceHistoryCommitStatusEnum getCommitStatus()

The commit status of this history item.

Returns:

commitStatus

setCommitStatus

public void setCommitStatus(@Nonnull
 AgentInstanceHistoryCommitStatusEnum commitStatus)

producedAt

public AgentInstanceHistoryItemResult producedAt(@Nonnull
 String producedAt)

getProducedAt

@Nonnull
public String getProducedAt()

The connector-side timestamp of when this message was produced.

Returns:

producedAt

setProducedAt

public void setProducedAt(@Nonnull
 String producedAt)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object