Package io.camunda.client.api.command

Interface UpdateAgentInstanceCommandStep1

All Known Implementing Classes:

UpdateAgentInstanceCommandImpl

public interface UpdateAgentInstanceCommandStep1

Represents a request to update an existing agent instance.

Usage example:

   camundaClient
       .newUpdateAgentInstanceCommand(agentInstanceKey)
       .elementInstanceKey(elementInstanceKey)
       .status(AgentInstanceUpdateStatus.THINKING)
       .send()
       .join();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UpdateAgentInstanceCommandStep1.AgentTool	Represents a tool available to the agent instance.
static interface	UpdateAgentInstanceCommandStep1.UpdateAgentInstanceCommandStep2

Method Summary

Modifier and Type	Method	Description
UpdateAgentInstanceCommandStep1.UpdateAgentInstanceCommandStep2	elementInstanceKey(long elementInstanceKey)	Sets the currently-active element instance for this agent instance.

Method Details

elementInstanceKey

UpdateAgentInstanceCommandStep1.UpdateAgentInstanceCommandStep2 elementInstanceKey(long elementInstanceKey)

Sets the currently-active element instance for this agent instance. The engine uses this both for ownership/equality validation and — when the supplied key differs from the previous association (re-entry of an ad-hoc sub-process or AI Agent task) — to append the key to the accumulated list of associated element instances.

Parameters:

elementInstanceKey - the key of the element instance. Must be greater than 0.

Returns:

the next step of the builder