Package io.camunda.client.impl.command

Class CreateAgentInstanceCommandImpl

java.lang.Object

io.camunda.client.impl.command.CreateAgentInstanceCommandImpl

All Implemented Interfaces:

CreateAgentInstanceCommandStep1, CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep2, CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep3, CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep4, CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5, FinalCommandStep<CreateAgentInstanceResponse>

public class CreateAgentInstanceCommandImpl
extends Object
implements CreateAgentInstanceCommandStep1, CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep2, CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep3, CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep4, CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.api.command.CreateAgentInstanceCommandStep1

CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep2, CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep3, CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep4, CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5

Constructor Summary

Constructors

Constructor	Description
CreateAgentInstanceCommandImpl(HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep2	elementInstanceKey(long elementInstanceKey)	Sets the element instance key of the AHSP or AI Agent Task element instance.
CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5	maxModelCalls(int maxModelCalls)	Sets the maximum number of LLM model calls the agent instance may make.
CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5	maxTokens(long maxTokens)	Sets the maximum number of tokens the agent instance may use.
CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5	maxToolCalls(int maxToolCalls)	Sets the maximum number of tool calls the agent instance may make.
CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep3	model(String model)	Sets the LLM model identifier for the agent instance.
CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep4	provider(String provider)	Sets the LLM provider for the agent instance.
CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<CreateAgentInstanceResponse>	send()	Sends the command to the Camunda gateway.
CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5	systemPrompt(String systemPrompt)	Sets the system prompt for the agent instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.camunda.client.api.command.FinalCommandStep

execute

Constructor Details

CreateAgentInstanceCommandImpl

public CreateAgentInstanceCommandImpl(HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

elementInstanceKey

public CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep2 elementInstanceKey(long elementInstanceKey)

Description copied from interface: CreateAgentInstanceCommandStep1

Sets the element instance key of the AHSP or AI Agent Task element instance.

Specified by:

elementInstanceKey in interface CreateAgentInstanceCommandStep1

Parameters:

elementInstanceKey - the key of the element instance. Must be greater than 0.

Returns:

this builder for method chaining

model

public CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep3 model(String model)

Description copied from interface: CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep2

Sets the LLM model identifier for the agent instance.

Specified by:

model in interface CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep2

Parameters:

model - the model identifier (for example, gpt-4o). Must not be null or empty.

Returns:

this builder for method chaining

provider

public CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep4 provider(String provider)

Description copied from interface: CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep3

Sets the LLM provider for the agent instance.

Specified by:

provider in interface CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep3

Parameters:

provider - the provider name (for example, openai). Must not be null or empty.

Returns:

this builder for method chaining

systemPrompt

public CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5 systemPrompt(String systemPrompt)

Description copied from interface: CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep4

Sets the system prompt for the agent instance.

Specified by:

systemPrompt in interface CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep4

Parameters:

systemPrompt - the system prompt text. Must not be null or empty.

Returns:

this builder for method chaining

maxTokens

public CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5 maxTokens(long maxTokens)

Description copied from interface: CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5

Sets the maximum number of tokens the agent instance may use. Defaults to -1 (no limit).

Specified by:

maxTokens in interface CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5

Parameters:

maxTokens - the token limit. Use -1 for no limit.

Returns:

this builder for method chaining

maxModelCalls

public CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5 maxModelCalls(int maxModelCalls)

Description copied from interface: CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5

Sets the maximum number of LLM model calls the agent instance may make. Defaults to -1 (no limit).

Specified by:

maxModelCalls in interface CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5

Parameters:

maxModelCalls - the model-call limit. Use -1 for no limit.

Returns:

this builder for method chaining

maxToolCalls

public CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5 maxToolCalls(int maxToolCalls)

Description copied from interface: CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5

Sets the maximum number of tool calls the agent instance may make. Defaults to -1 (no limit).

Specified by:

maxToolCalls in interface CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5

Parameters:

maxToolCalls - the tool-call limit. Use -1 for no limit.

Returns:

this builder for method chaining

requestTimeout

public CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5 requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using CamundaClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<CreateAgentInstanceResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<CreateAgentInstanceResponse> send()

Description copied from interface: FinalCommandStep

Sends the command to the Camunda gateway. This operation is asynchronous. In case of success, the future returns the event that was generated by the Camunda gateway in response to the command.

Call CamundaFuture.join() to wait until the response is available.

 Future<JobEventinvalid input: '&#62' future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<CreateAgentInstanceResponse>

Returns:

a future tracking state of success/failure of the command.