Package io.camunda.client.protocol.rest

Class AgentInstanceUpdateRequest

java.lang.Object

io.camunda.client.protocol.rest.AgentInstanceUpdateRequest

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

Request to update the mutable state of an agent instance.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_METRICS
static final String	JSON_PROPERTY_STATUS
static final String	JSON_PROPERTY_TOOLS

Constructor Summary

Constructors

Constructor	Description
AgentInstanceUpdateRequest()

Method Summary

Modifier and Type	Method	Description
AgentInstanceUpdateRequest	addToolsItem(AgentTool toolsItem)
AgentInstanceUpdateRequest	elementInstanceKey(String elementInstanceKey)
boolean	equals(Object o)
String	getElementInstanceKey()	The key of the currently-active element instance for this agent instance.
AgentInstanceMetricsDelta	getMetrics()	Metric increments to apply to the aggregate counters.
AgentInstanceUpdateStatusEnum	getStatus()	The new status of the agent instance.
List<AgentTool>	getTools()	The complete list of tools available to the agent, replacing any previously stored tools.
int	hashCode()
AgentInstanceUpdateRequest	metrics(AgentInstanceMetricsDelta metrics)
void	setElementInstanceKey(String elementInstanceKey)
void	setMetrics(AgentInstanceMetricsDelta metrics)
void	setStatus(AgentInstanceUpdateStatusEnum status)
void	setTools(List<AgentTool> tools)
AgentInstanceUpdateRequest	status(AgentInstanceUpdateStatusEnum status)
AgentInstanceUpdateRequest	tools(List<AgentTool> tools)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_ELEMENT_INSTANCE_KEY

public static final String JSON_PROPERTY_ELEMENT_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_STATUS

public static final String JSON_PROPERTY_STATUS

See Also:

• Constant Field Values

JSON_PROPERTY_METRICS

public static final String JSON_PROPERTY_METRICS

See Also:

• Constant Field Values

JSON_PROPERTY_TOOLS

public static final String JSON_PROPERTY_TOOLS

See Also:

• Constant Field Values

Constructor Details

AgentInstanceUpdateRequest

public AgentInstanceUpdateRequest()

Method Details

elementInstanceKey

public AgentInstanceUpdateRequest elementInstanceKey(@Nonnull
 String elementInstanceKey)

getElementInstanceKey

@Nonnull
public String getElementInstanceKey()

The key of the currently-active element instance for this agent instance. Used for ownership/equality validation against the stored agent instance and, when the supplied key differs from the previous association (re-entry of an ad-hoc sub-process or AI Agent task), appended to elementInstanceKeys with the reverse link updated on the supplied element instance.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nonnull
 String elementInstanceKey)

status

public AgentInstanceUpdateRequest status(@Nullable
 AgentInstanceUpdateStatusEnum status)

getStatus

@Nullable
public AgentInstanceUpdateStatusEnum getStatus()

The new status of the agent instance.

Returns:

status

setStatus

public void setStatus(@Nullable
 AgentInstanceUpdateStatusEnum status)

metrics

public AgentInstanceUpdateRequest metrics(@Nullable
 AgentInstanceMetricsDelta metrics)

getMetrics

@Nullable
public AgentInstanceMetricsDelta getMetrics()

Metric increments to apply to the aggregate counters.

Returns:

metrics

setMetrics

public void setMetrics(@Nullable
 AgentInstanceMetricsDelta metrics)

tools

public AgentInstanceUpdateRequest tools(@Nullable
 List<AgentTool> tools)

addToolsItem

public AgentInstanceUpdateRequest addToolsItem(AgentTool toolsItem)

getTools

@Nullable
public List<AgentTool> getTools()

The complete list of tools available to the agent, replacing any previously stored tools. When provided, the engine replaces the existing tool list with this value.

Returns:

tools

setTools

public void setTools(@Nullable
 List<AgentTool> tools)

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