Package io.camunda.client.protocol.rest

Class AgentInstanceResult

java.lang.Object

io.camunda.client.protocol.rest.AgentInstanceResult

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

AgentInstanceResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AGENT_INSTANCE_KEY
static final String	JSON_PROPERTY_COMPLETION_DATE
static final String	JSON_PROPERTY_CREATION_DATE
static final String	JSON_PROPERTY_DEFINITION
static final String	JSON_PROPERTY_ELEMENT_ID
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_KEYS
static final String	JSON_PROPERTY_LAST_UPDATED_DATE
static final String	JSON_PROPERTY_LIMITS
static final String	JSON_PROPERTY_METRICS
static final String	JSON_PROPERTY_PROCESS_DEFINITION_ID
static final String	JSON_PROPERTY_PROCESS_DEFINITION_KEY
static final String	JSON_PROPERTY_PROCESS_DEFINITION_VERSION
static final String	JSON_PROPERTY_PROCESS_DEFINITION_VERSION_TAG
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_ROOT_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_STATUS
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_TOOLS

Constructor Summary

Constructors

Constructor	Description
AgentInstanceResult()

Method Summary

Modifier and Type	Method	Description
AgentInstanceResult	addElementInstanceKeysItem(String elementInstanceKeysItem)
AgentInstanceResult	addToolsItem(AgentTool toolsItem)
AgentInstanceResult	agentInstanceKey(String agentInstanceKey)
AgentInstanceResult	completionDate(String completionDate)
AgentInstanceResult	creationDate(String creationDate)
AgentInstanceResult	definition(AgentInstanceDefinition definition)
AgentInstanceResult	elementId(String elementId)
AgentInstanceResult	elementInstanceKeys(List<String> elementInstanceKeys)
boolean	equals(Object o)
String	getAgentInstanceKey()	The unique key for this agent instance.
String	getCompletionDate()	The date when this agent instance completed.
String	getCreationDate()	The date when this agent instance was created.
AgentInstanceDefinition	getDefinition()	The static definition of the agent, including model, provider, and system prompt.
String	getElementId()	The BPMN element ID of the ad-hoc sub-process or AI agent task that owns this agent instance.
List<String>	getElementInstanceKeys()	The keys of all element instances associated with this agent instance.
String	getLastUpdatedDate()	The date when this agent instance was last updated.
AgentInstanceLimits	getLimits()	The configured limits for this agent instance, set once at creation.
AgentInstanceMetrics	getMetrics()	Aggregated metrics across all loopIterations of this agent instance.
String	getProcessDefinitionId()	The BPMN process ID of the process definition associated with this agent instance.
String	getProcessDefinitionKey()	The key of the process definition associated with this agent instance.
Integer	getProcessDefinitionVersion()	The version of the process definition associated with this agent instance.
String	getProcessDefinitionVersionTag()	The version tag of the process definition associated with this agent instance.
String	getProcessInstanceKey()	The key of the process instance that owns this agent instance.
String	getRootProcessInstanceKey()	The key of the root process instance.
AgentInstanceStatusEnum	getStatus()	Get status
String	getTenantId()	The tenant ID of this agent instance.
List<AgentTool>	getTools()	The tools available to the agent.
int	hashCode()
AgentInstanceResult	lastUpdatedDate(String lastUpdatedDate)
AgentInstanceResult	limits(AgentInstanceLimits limits)
AgentInstanceResult	metrics(AgentInstanceMetrics metrics)
AgentInstanceResult	processDefinitionId(String processDefinitionId)
AgentInstanceResult	processDefinitionKey(String processDefinitionKey)
AgentInstanceResult	processDefinitionVersion(Integer processDefinitionVersion)
AgentInstanceResult	processDefinitionVersionTag(String processDefinitionVersionTag)
AgentInstanceResult	processInstanceKey(String processInstanceKey)
AgentInstanceResult	rootProcessInstanceKey(String rootProcessInstanceKey)
void	setAgentInstanceKey(String agentInstanceKey)
void	setCompletionDate(String completionDate)
void	setCreationDate(String creationDate)
void	setDefinition(AgentInstanceDefinition definition)
void	setElementId(String elementId)
void	setElementInstanceKeys(List<String> elementInstanceKeys)
void	setLastUpdatedDate(String lastUpdatedDate)
void	setLimits(AgentInstanceLimits limits)
void	setMetrics(AgentInstanceMetrics metrics)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionVersion(Integer processDefinitionVersion)
void	setProcessDefinitionVersionTag(String processDefinitionVersionTag)
void	setProcessInstanceKey(String processInstanceKey)
void	setRootProcessInstanceKey(String rootProcessInstanceKey)
void	setStatus(AgentInstanceStatusEnum status)
void	setTenantId(String tenantId)
void	setTools(List<AgentTool> tools)
AgentInstanceResult	status(AgentInstanceStatusEnum status)
AgentInstanceResult	tenantId(String tenantId)
AgentInstanceResult	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_AGENT_INSTANCE_KEY

public static final String JSON_PROPERTY_AGENT_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_STATUS

public static final String JSON_PROPERTY_STATUS

See Also:

• Constant Field Values

JSON_PROPERTY_DEFINITION

public static final String JSON_PROPERTY_DEFINITION

See Also:

• Constant Field Values

JSON_PROPERTY_METRICS

public static final String JSON_PROPERTY_METRICS

See Also:

• Constant Field Values

JSON_PROPERTY_LIMITS

public static final String JSON_PROPERTY_LIMITS

See Also:

• Constant Field Values

JSON_PROPERTY_TOOLS

public static final String JSON_PROPERTY_TOOLS

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_ID

public static final String JSON_PROPERTY_ELEMENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_ROOT_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_ROOT_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_KEY

public static final String JSON_PROPERTY_PROCESS_DEFINITION_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_ID

public static final String JSON_PROPERTY_PROCESS_DEFINITION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_VERSION

public static final String JSON_PROPERTY_PROCESS_DEFINITION_VERSION

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_VERSION_TAG

public static final String JSON_PROPERTY_PROCESS_DEFINITION_VERSION_TAG

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_CREATION_DATE

public static final String JSON_PROPERTY_CREATION_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_LAST_UPDATED_DATE

public static final String JSON_PROPERTY_LAST_UPDATED_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_COMPLETION_DATE

public static final String JSON_PROPERTY_COMPLETION_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_INSTANCE_KEYS

public static final String JSON_PROPERTY_ELEMENT_INSTANCE_KEYS

See Also:

• Constant Field Values

Constructor Details

AgentInstanceResult

public AgentInstanceResult()

Method Details

agentInstanceKey

public AgentInstanceResult agentInstanceKey(@Nonnull
 String agentInstanceKey)

getAgentInstanceKey

@Nonnull
public String getAgentInstanceKey()

The unique key for this agent instance.

Returns:

agentInstanceKey

setAgentInstanceKey

public void setAgentInstanceKey(@Nonnull
 String agentInstanceKey)

status

public AgentInstanceResult status(@Nonnull
 AgentInstanceStatusEnum status)

getStatus

@Nonnull
public AgentInstanceStatusEnum getStatus()

Get status

Returns:

status

setStatus

public void setStatus(@Nonnull
 AgentInstanceStatusEnum status)

definition

public AgentInstanceResult definition(@Nonnull
 AgentInstanceDefinition definition)

getDefinition

@Nonnull
public AgentInstanceDefinition getDefinition()

The static definition of the agent, including model, provider, and system prompt.

Returns:

definition

setDefinition

public void setDefinition(@Nonnull
 AgentInstanceDefinition definition)

metrics

public AgentInstanceResult metrics(@Nonnull
 AgentInstanceMetrics metrics)

getMetrics

@Nonnull
public AgentInstanceMetrics getMetrics()

Aggregated metrics across all loopIterations of this agent instance.

Returns:

metrics

setMetrics

public void setMetrics(@Nonnull
 AgentInstanceMetrics metrics)

limits

public AgentInstanceResult limits(@Nonnull
 AgentInstanceLimits limits)

getLimits

@Nonnull
public AgentInstanceLimits getLimits()

The configured limits for this agent instance, set once at creation.

Returns:

limits

setLimits

public void setLimits(@Nonnull
 AgentInstanceLimits limits)

tools

public AgentInstanceResult tools(@Nonnull
 List<AgentTool> tools)

addToolsItem

public AgentInstanceResult addToolsItem(AgentTool toolsItem)

getTools

@Nonnull
public List<AgentTool> getTools()

The tools available to the agent.

Returns:

tools

setTools

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

elementId

public AgentInstanceResult elementId(@Nonnull
 String elementId)

getElementId

@Nonnull
public String getElementId()

The BPMN element ID of the ad-hoc sub-process or AI agent task that owns this agent instance.

Returns:

elementId

setElementId

public void setElementId(@Nonnull
 String elementId)

processInstanceKey

public AgentInstanceResult processInstanceKey(@Nonnull
 String processInstanceKey)

getProcessInstanceKey

@Nonnull
public String getProcessInstanceKey()

The key of the process instance that owns this agent instance.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nonnull
 String processInstanceKey)

rootProcessInstanceKey

public AgentInstanceResult rootProcessInstanceKey(@Nonnull
 String rootProcessInstanceKey)

getRootProcessInstanceKey

@Nonnull
public String getRootProcessInstanceKey()

The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy.

Returns:

rootProcessInstanceKey

setRootProcessInstanceKey

public void setRootProcessInstanceKey(@Nonnull
 String rootProcessInstanceKey)

processDefinitionKey

public AgentInstanceResult processDefinitionKey(@Nonnull
 String processDefinitionKey)

getProcessDefinitionKey

@Nonnull
public String getProcessDefinitionKey()

The key of the process definition associated with this agent instance.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nonnull
 String processDefinitionKey)

processDefinitionId

public AgentInstanceResult processDefinitionId(@Nonnull
 String processDefinitionId)

getProcessDefinitionId

@Nonnull
public String getProcessDefinitionId()

The BPMN process ID of the process definition associated with this agent instance.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nonnull
 String processDefinitionId)

processDefinitionVersion

public AgentInstanceResult processDefinitionVersion(@Nonnull
 Integer processDefinitionVersion)

getProcessDefinitionVersion

@Nonnull
public Integer getProcessDefinitionVersion()

The version of the process definition associated with this agent instance.

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(@Nonnull
 Integer processDefinitionVersion)

processDefinitionVersionTag

public AgentInstanceResult processDefinitionVersionTag(@Nullable
 String processDefinitionVersionTag)

getProcessDefinitionVersionTag

@Nullable
public String getProcessDefinitionVersionTag()

The version tag of the process definition associated with this agent instance.

Returns:

processDefinitionVersionTag

setProcessDefinitionVersionTag

public void setProcessDefinitionVersionTag(@Nullable
 String processDefinitionVersionTag)

tenantId

public AgentInstanceResult tenantId(@Nonnull
 String tenantId)

getTenantId

@Nonnull
public String getTenantId()

The tenant ID of this agent instance.

Returns:

tenantId

setTenantId

public void setTenantId(@Nonnull
 String tenantId)

creationDate

public AgentInstanceResult creationDate(@Nonnull
 String creationDate)

getCreationDate

@Nonnull
public String getCreationDate()

The date when this agent instance was created.

Returns:

creationDate

setCreationDate

public void setCreationDate(@Nonnull
 String creationDate)

lastUpdatedDate

public AgentInstanceResult lastUpdatedDate(@Nonnull
 String lastUpdatedDate)

getLastUpdatedDate

@Nonnull
public String getLastUpdatedDate()

The date when this agent instance was last updated.

Returns:

lastUpdatedDate

setLastUpdatedDate

public void setLastUpdatedDate(@Nonnull
 String lastUpdatedDate)

completionDate

public AgentInstanceResult completionDate(@Nullable
 String completionDate)

getCompletionDate

@Nullable
public String getCompletionDate()

The date when this agent instance completed. Null while the agent is still running.

Returns:

completionDate

setCompletionDate

public void setCompletionDate(@Nullable
 String completionDate)

elementInstanceKeys

public AgentInstanceResult elementInstanceKeys(@Nonnull
 List<String> elementInstanceKeys)

addElementInstanceKeysItem

public AgentInstanceResult addElementInstanceKeysItem(String elementInstanceKeysItem)

getElementInstanceKeys

@Nonnull
public List<String> getElementInstanceKeys()

The keys of all element instances associated with this agent instance.

Returns:

elementInstanceKeys

setElementInstanceKeys

public void setElementInstanceKeys(@Nonnull
 List<String> elementInstanceKeys)

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