Class AgentUpdateParams.Body.Builder
-
- All Implemented Interfaces:
public final class AgentUpdateParams.Body.BuilderA builder for Body.
-
-
Method Summary
-
-
Method Detail
-
version
final AgentUpdateParams.Body.Builder version(Integer version)
The agent's current version, used to prevent concurrent overwrites. Obtain this value from a create or retrieve response. The request fails if this does not match the server's current version.
-
version
final AgentUpdateParams.Body.Builder version(JsonField<Integer> version)
Sets Builder.version to an arbitrary JSON value.
You should usually call Builder.version with a well-typed Int value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
description
final AgentUpdateParams.Body.Builder description(String description)
Description. Omit to preserve; send empty string or null to clear.
-
description
final AgentUpdateParams.Body.Builder description(Optional<String> description)
Alias for calling Builder.description with
description.orElse(null).
-
description
final AgentUpdateParams.Body.Builder description(JsonField<String> description)
Sets Builder.description to an arbitrary JSON value.
You should usually call Builder.description with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
mcpServers
final AgentUpdateParams.Body.Builder mcpServers(List<BetaManagedAgentsUrlMcpServerParams> mcpServers)
MCP servers. Full replacement. Omit to preserve; send empty array or null to clear. Names must be unique. Maximum 20.
-
mcpServers
final AgentUpdateParams.Body.Builder mcpServers(Optional<List<BetaManagedAgentsUrlMcpServerParams>> mcpServers)
Alias for calling Builder.mcpServers with
mcpServers.orElse(null).
-
mcpServers
final AgentUpdateParams.Body.Builder mcpServers(JsonField<List<BetaManagedAgentsUrlMcpServerParams>> mcpServers)
Sets Builder.mcpServers to an arbitrary JSON value.
You should usually call Builder.mcpServers with a well-typed
List<BetaManagedAgentsUrlMcpServerParams>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addMcpServer
final AgentUpdateParams.Body.Builder addMcpServer(BetaManagedAgentsUrlMcpServerParams mcpServer)
Adds a single BetaManagedAgentsUrlMcpServerParams to mcpServers.
-
metadata
final AgentUpdateParams.Body.Builder metadata(AgentUpdateParams.Metadata metadata)
Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars.
-
metadata
final AgentUpdateParams.Body.Builder metadata(Optional<AgentUpdateParams.Metadata> metadata)
Alias for calling Builder.metadata with
metadata.orElse(null).
-
metadata
final AgentUpdateParams.Body.Builder metadata(JsonField<AgentUpdateParams.Metadata> metadata)
Sets Builder.metadata to an arbitrary JSON value.
You should usually call Builder.metadata with a well-typed Metadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
model
final AgentUpdateParams.Body.Builder model(AgentUpdateParams.Model model)
Model identifier. Accepts the model string, e.g.
claude-opus-4-6, or amodel_configobject for additional configuration control. Omit to preserve. Cannot be cleared.
-
model
final AgentUpdateParams.Body.Builder model(JsonField<AgentUpdateParams.Model> model)
Sets Builder.model to an arbitrary JSON value.
You should usually call Builder.model with a well-typed Model value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
model
final AgentUpdateParams.Body.Builder model(BetaManagedAgentsModel betaManagedAgents)
Alias for calling model with
Model.ofBetaManagedAgents(betaManagedAgents).
-
model
final AgentUpdateParams.Body.Builder model(BetaManagedAgentsModelConfigParams betaManagedAgentsModelConfigParams)
Alias for calling model with
Model.ofBetaManagedAgentsModelConfigParams(betaManagedAgentsModelConfigParams).
-
multiagent
final AgentUpdateParams.Body.Builder multiagent(BetaManagedAgentsMultiagentParams multiagent)
A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the
agentsroster.
-
multiagent
final AgentUpdateParams.Body.Builder multiagent(Optional<BetaManagedAgentsMultiagentParams> multiagent)
Alias for calling Builder.multiagent with
multiagent.orElse(null).
-
multiagent
final AgentUpdateParams.Body.Builder multiagent(JsonField<BetaManagedAgentsMultiagentParams> multiagent)
Sets Builder.multiagent to an arbitrary JSON value.
You should usually call Builder.multiagent with a well-typed BetaManagedAgentsMultiagentParams value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
coordinatorMultiagent
final AgentUpdateParams.Body.Builder coordinatorMultiagent(List<BetaManagedAgentsMultiagentRosterEntryParams> agents)
Alias for calling multiagent with the following:
BetaManagedAgentsMultiagentParams.builder() .type(BetaManagedAgentsMultiagentParams.Type.COORDINATOR) .agents(agents) .build()
-
name
final AgentUpdateParams.Body.Builder name(String name)
Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.
-
name
final AgentUpdateParams.Body.Builder name(JsonField<String> name)
Sets Builder.name to an arbitrary JSON value.
You should usually call Builder.name with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
skills
final AgentUpdateParams.Body.Builder skills(List<BetaManagedAgentsSkillParams> skills)
Skills. Full replacement. Omit to preserve; send empty array or null to clear.
-
skills
final AgentUpdateParams.Body.Builder skills(Optional<List<BetaManagedAgentsSkillParams>> skills)
Alias for calling Builder.skills with
skills.orElse(null).
-
skills
final AgentUpdateParams.Body.Builder skills(JsonField<List<BetaManagedAgentsSkillParams>> skills)
Sets Builder.skills to an arbitrary JSON value.
You should usually call Builder.skills with a well-typed
List<BetaManagedAgentsSkillParams>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addSkill
final AgentUpdateParams.Body.Builder addSkill(BetaManagedAgentsSkillParams skill)
Adds a single BetaManagedAgentsSkillParams to skills.
-
addSkill
final AgentUpdateParams.Body.Builder addSkill(BetaManagedAgentsAnthropicSkillParams anthropic)
Alias for calling addSkill with
BetaManagedAgentsSkillParams.ofAnthropic(anthropic).
-
addSkill
final AgentUpdateParams.Body.Builder addSkill(BetaManagedAgentsCustomSkillParams custom)
Alias for calling addSkill with
BetaManagedAgentsSkillParams.ofCustom(custom).
-
addAnthropicSkill
final AgentUpdateParams.Body.Builder addAnthropicSkill(String skillId)
Alias for calling addSkill with the following:
BetaManagedAgentsAnthropicSkillParams.builder() .type(BetaManagedAgentsAnthropicSkillParams.Type.ANTHROPIC) .skillId(skillId) .build()
-
addCustomSkill
final AgentUpdateParams.Body.Builder addCustomSkill(String skillId)
Alias for calling addSkill with the following:
BetaManagedAgentsCustomSkillParams.builder() .type(BetaManagedAgentsCustomSkillParams.Type.CUSTOM) .skillId(skillId) .build()
-
system
final AgentUpdateParams.Body.Builder system(String system)
System prompt. Omit to preserve; send empty string or null to clear.
-
system
final AgentUpdateParams.Body.Builder system(Optional<String> system)
Alias for calling Builder.system with
system.orElse(null).
-
system
final AgentUpdateParams.Body.Builder system(JsonField<String> system)
Sets Builder.system to an arbitrary JSON value.
You should usually call Builder.system with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
tools
final AgentUpdateParams.Body.Builder tools(List<AgentUpdateParams.Tool> tools)
Tool configurations available to the agent. Full replacement. Omit to preserve; send empty array or null to clear. Maximum of 128 tools across all toolsets allowed.
-
tools
final AgentUpdateParams.Body.Builder tools(Optional<List<AgentUpdateParams.Tool>> tools)
Alias for calling Builder.tools with
tools.orElse(null).
-
tools
final AgentUpdateParams.Body.Builder tools(JsonField<List<AgentUpdateParams.Tool>> tools)
Sets Builder.tools to an arbitrary JSON value.
You should usually call Builder.tools with a well-typed
List<Tool>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addTool
final AgentUpdateParams.Body.Builder addTool(AgentUpdateParams.Tool tool)
-
addTool
final AgentUpdateParams.Body.Builder addTool(BetaManagedAgentsAgentToolset20260401Params agentToolset20260401)
Alias for calling addTool with
Tool.ofAgentToolset20260401(agentToolset20260401).
-
addTool
final AgentUpdateParams.Body.Builder addTool(BetaManagedAgentsMcpToolsetParams mcpToolset)
Alias for calling addTool with
Tool.ofMcpToolset(mcpToolset).
-
addTool
final AgentUpdateParams.Body.Builder addTool(BetaManagedAgentsCustomToolParams custom)
Alias for calling addTool with
Tool.ofCustom(custom).
-
addMcpToolsetTool
final AgentUpdateParams.Body.Builder addMcpToolsetTool(String mcpServerName)
Alias for calling addTool with the following:
BetaManagedAgentsMcpToolsetParams.builder() .type(BetaManagedAgentsMcpToolsetParams.Type.MCP_TOOLSET) .mcpServerName(mcpServerName) .build()
-
additionalProperties
final AgentUpdateParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final AgentUpdateParams.Body.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final AgentUpdateParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final AgentUpdateParams.Body.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final AgentUpdateParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final AgentUpdateParams.Body build()
Returns an immutable instance of Body.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.version()
-
-
-
-