Package io.camunda.client.api.command

Interface UpdateAgentInstanceCommandStep1.AgentTool

Enclosing interface:

UpdateAgentInstanceCommandStep1

public static interface UpdateAgentInstanceCommandStep1.AgentTool

Represents a tool available to the agent instance.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getElementId()
String	getName()
static UpdateAgentInstanceCommandStep1.AgentTool	of(String name)	Creates a tool with the given name and no description or element ID.
static UpdateAgentInstanceCommandStep1.AgentTool	of(String name, String description, String elementId)	Creates a tool with the given name, description, and element ID.

Method Details

getName

String getName()

getDescription

String getDescription()

getElementId

String getElementId()

of

static UpdateAgentInstanceCommandStep1.AgentTool of(String name)

Creates a tool with the given name and no description or element ID.

Parameters:

name - the tool name. Must not be blank.

Returns:

a new UpdateAgentInstanceCommandStep1.AgentTool

of

static UpdateAgentInstanceCommandStep1.AgentTool of(String name,
 String description,
 String elementId)

Creates a tool with the given name, description, and element ID.

Parameters:

name - the tool name. Must not be blank.

description - optional description of the tool

elementId - optional ID of the BPMN element providing this tool

Returns:

a new UpdateAgentInstanceCommandStep1.AgentTool