Constructor Detail

Method Detail

• agentId

   final AgentUpdateParams.Builder agentId(String agentId)

• agentId

   final AgentUpdateParams.Builder agentId(Optional<String> agentId)

  Alias for calling Builder.agentId with agentId.orElse(null).

• betas

   final AgentUpdateParams.Builder betas(List<AnthropicBeta> betas)

  Optional header to specify the beta version(s) you want to use.

• betas

   final AgentUpdateParams.Builder betas(Optional<List<AnthropicBeta>> betas)

  Alias for calling Builder.betas with betas.orElse(null).

• addBeta

   final AgentUpdateParams.Builder addBeta(AnthropicBeta beta)

  Adds a single AnthropicBeta to betas.

• addBeta

   final AgentUpdateParams.Builder addBeta(String value)

  Sets addBeta to an arbitrary String.

  You should usually call addBeta with a well-typed AnthropicBeta constant instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• body

   final AgentUpdateParams.Builder body(AgentUpdateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • version

  • description

  • mcpServers

  • metadata

  • model

  • etc.

• version

   final AgentUpdateParams.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.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.Builder description(String description)

  Description. Omit to preserve; send empty string or null to clear.

• description

   final AgentUpdateParams.Builder description(Optional<String> description)

  Alias for calling Builder.description with description.orElse(null).

• description

   final AgentUpdateParams.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.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.Builder mcpServers(Optional<List<BetaManagedAgentsUrlMcpServerParams>> mcpServers)

  Alias for calling Builder.mcpServers with mcpServers.orElse(null).

• mcpServers

   final AgentUpdateParams.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.Builder addMcpServer(BetaManagedAgentsUrlMcpServerParams mcpServer)

  Adds a single BetaManagedAgentsUrlMcpServerParams to mcpServers.

• metadata

   final AgentUpdateParams.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.Builder metadata(Optional<AgentUpdateParams.Metadata> metadata)

  Alias for calling Builder.metadata with metadata.orElse(null).

• metadata

   final AgentUpdateParams.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.Builder model(AgentUpdateParams.Model model)

  Model identifier. Accepts the model string, e.g. claude-opus-4-6, or a model_config object for additional configuration control. Omit to preserve. Cannot be cleared.

• model

   final AgentUpdateParams.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.Builder model(BetaManagedAgentsModel betaManagedAgents)

  Alias for calling model with Model.ofBetaManagedAgents(betaManagedAgents).

• model

   final AgentUpdateParams.Builder model(BetaManagedAgentsModelConfigParams betaManagedAgentsModelConfigParams)

  Alias for calling model with Model.ofBetaManagedAgentsModelConfigParams(betaManagedAgentsModelConfigParams).

• multiagent

   final AgentUpdateParams.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 agents roster.

• multiagent

   final AgentUpdateParams.Builder multiagent(Optional<BetaManagedAgentsMultiagentParams> multiagent)

  Alias for calling Builder.multiagent with multiagent.orElse(null).

• multiagent

   final AgentUpdateParams.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.Builder coordinatorMultiagent(List<BetaManagedAgentsMultiagentRosterEntryParams> agents)

  Alias for calling multiagent with the following:

  BetaManagedAgentsMultiagentParams.builder()
      .type(BetaManagedAgentsMultiagentParams.Type.COORDINATOR)
      .agents(agents)
      .build()

• name

   final AgentUpdateParams.Builder name(String name)

  Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.

• name

   final AgentUpdateParams.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.Builder skills(List<BetaManagedAgentsSkillParams> skills)

  Skills. Full replacement. Omit to preserve; send empty array or null to clear.

• skills

   final AgentUpdateParams.Builder skills(Optional<List<BetaManagedAgentsSkillParams>> skills)

  Alias for calling Builder.skills with skills.orElse(null).

• skills

   final AgentUpdateParams.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.Builder addSkill(BetaManagedAgentsSkillParams skill)

  Adds a single BetaManagedAgentsSkillParams to skills.

• addSkill

   final AgentUpdateParams.Builder addSkill(BetaManagedAgentsAnthropicSkillParams anthropic)

  Alias for calling addSkill with BetaManagedAgentsSkillParams.ofAnthropic(anthropic).

• addSkill

   final AgentUpdateParams.Builder addSkill(BetaManagedAgentsCustomSkillParams custom)

  Alias for calling addSkill with BetaManagedAgentsSkillParams.ofCustom(custom).

• addAnthropicSkill

   final AgentUpdateParams.Builder addAnthropicSkill(String skillId)

  Alias for calling addSkill with the following:

  BetaManagedAgentsAnthropicSkillParams.builder()
      .type(BetaManagedAgentsAnthropicSkillParams.Type.ANTHROPIC)
      .skillId(skillId)
      .build()

• addCustomSkill

   final AgentUpdateParams.Builder addCustomSkill(String skillId)

  Alias for calling addSkill with the following:

  BetaManagedAgentsCustomSkillParams.builder()
      .type(BetaManagedAgentsCustomSkillParams.Type.CUSTOM)
      .skillId(skillId)
      .build()

• system

   final AgentUpdateParams.Builder system(String system)

  System prompt. Omit to preserve; send empty string or null to clear.

• system

   final AgentUpdateParams.Builder system(Optional<String> system)

  Alias for calling Builder.system with system.orElse(null).

• system

   final AgentUpdateParams.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.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.Builder tools(Optional<List<AgentUpdateParams.Tool>> tools)

  Alias for calling Builder.tools with tools.orElse(null).

• tools

   final AgentUpdateParams.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.Builder addTool(AgentUpdateParams.Tool tool)

  Adds a single Tool to tools.

• addTool

   final AgentUpdateParams.Builder addTool(BetaManagedAgentsAgentToolset20260401Params agentToolset20260401)

  Alias for calling addTool with Tool.ofAgentToolset20260401(agentToolset20260401).

• addTool

   final AgentUpdateParams.Builder addTool(BetaManagedAgentsMcpToolsetParams mcpToolset)

  Alias for calling addTool with Tool.ofMcpToolset(mcpToolset).

• addTool

   final AgentUpdateParams.Builder addTool(BetaManagedAgentsCustomToolParams custom)

  Alias for calling addTool with Tool.ofCustom(custom).

• addMcpToolsetTool

   final AgentUpdateParams.Builder addMcpToolsetTool(String mcpServerName)

  Alias for calling addTool with the following:

  BetaManagedAgentsMcpToolsetParams.builder()
      .type(BetaManagedAgentsMcpToolsetParams.Type.MCP_TOOLSET)
      .mcpServerName(mcpServerName)
      .build()

• additionalBodyProperties

   final AgentUpdateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final AgentUpdateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final AgentUpdateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final AgentUpdateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final AgentUpdateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final AgentUpdateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final AgentUpdateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final AgentUpdateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final AgentUpdateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final AgentUpdateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final AgentUpdateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final AgentUpdateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final AgentUpdateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final AgentUpdateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final AgentUpdateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final AgentUpdateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final AgentUpdateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final AgentUpdateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final AgentUpdateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final AgentUpdateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final AgentUpdateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final AgentUpdateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final AgentUpdateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final AgentUpdateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final AgentUpdateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final AgentUpdateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final AgentUpdateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final AgentUpdateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final AgentUpdateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final AgentUpdateParams build()

  Returns an immutable instance of AgentUpdateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .version()