Package io.camunda.client.protocol.rest

Class AgentInstanceCreationRequest

java.lang.Object

io.camunda.client.protocol.rest.AgentInstanceCreationRequest

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

Request to create a new agent instance.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_DEFINITION
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_LIMITS

Constructor Summary

Constructors

Constructor	Description
AgentInstanceCreationRequest()

Method Summary

Modifier and Type	Method	Description
AgentInstanceCreationRequest	definition(AgentInstanceDefinition definition)
AgentInstanceCreationRequest	elementInstanceKey(String elementInstanceKey)
boolean	equals(Object o)
AgentInstanceDefinition	getDefinition()	Static definition set once at creation.
String	getElementInstanceKey()	The key of the AI Agent Sub-process or AI Agent Task element instance.
AgentInstanceLimits	getLimits()	Limits for the agent execution.
int	hashCode()
AgentInstanceCreationRequest	limits(AgentInstanceLimits limits)
void	setDefinition(AgentInstanceDefinition definition)
void	setElementInstanceKey(String elementInstanceKey)
void	setLimits(AgentInstanceLimits limits)
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_DEFINITION

public static final String JSON_PROPERTY_DEFINITION

See Also:

• Constant Field Values

JSON_PROPERTY_LIMITS

public static final String JSON_PROPERTY_LIMITS

See Also:

• Constant Field Values

Constructor Details

AgentInstanceCreationRequest

public AgentInstanceCreationRequest()

Method Details

elementInstanceKey

public AgentInstanceCreationRequest elementInstanceKey(@Nonnull
 String elementInstanceKey)

getElementInstanceKey

@Nonnull
public String getElementInstanceKey()

The key of the AI Agent Sub-process or AI Agent Task element instance. The engine uses this key to infer processInstanceKey, elementId, processDefinitionKey, and tenantId.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nonnull
 String elementInstanceKey)

definition

public AgentInstanceCreationRequest definition(@Nonnull
 AgentInstanceDefinition definition)

getDefinition

@Nonnull
public AgentInstanceDefinition getDefinition()

Static definition set once at creation.

Returns:

definition

setDefinition

public void setDefinition(@Nonnull
 AgentInstanceDefinition definition)

limits

public AgentInstanceCreationRequest limits(@Nullable
 AgentInstanceLimits limits)

getLimits

@Nullable
public AgentInstanceLimits getLimits()

Limits for the agent execution. When omitted, all limits default to -1 (no limit).

Returns:

limits

setLimits

public void setLimits(@Nullable
 AgentInstanceLimits limits)

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