Package io.camunda.client.protocol.rest

Class AgentTool

java.lang.Object

io.camunda.client.protocol.rest.AgentTool

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

A tool available to the agent.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_ELEMENT_ID
static final String	JSON_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
AgentTool()

Method Summary

Modifier and Type	Method	Description
AgentTool	description(String description)
AgentTool	elementId(String elementId)
boolean	equals(Object o)
String	getDescription()	A human-readable description of the tool.
String	getElementId()	The BPMN element ID of the tool element within the ad-hoc sub-process.
String	getName()	The tool name as visible to the LLM.
int	hashCode()
AgentTool	name(String name)
void	setDescription(String description)
void	setElementId(String elementId)
void	setName(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_ID

public static final String JSON_PROPERTY_ELEMENT_ID

See Also:

• Constant Field Values

Constructor Details

AgentTool

public AgentTool()

Method Details

name

public AgentTool name(@Nonnull
 String name)

getName

@Nonnull
public String getName()

The tool name as visible to the LLM.

Returns:

name

setName

public void setName(@Nonnull
 String name)

description

public AgentTool description(@Nullable
 String description)

getDescription

@Nullable
public String getDescription()

A human-readable description of the tool.

Returns:

description

setDescription

public void setDescription(@Nullable
 String description)

elementId

public AgentTool elementId(@Nullable
 String elementId)

getElementId

@Nullable
public String getElementId()

The BPMN element ID of the tool element within the ad-hoc sub-process.

Returns:

elementId

setElementId

public void setElementId(@Nullable
 String elementId)

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