Class AgentUpdateParams.Body
-
- All Implemented Interfaces:
public final class AgentUpdateParams.BodyRequest parameters for updating an
agent. Omit a field to preserve its current value.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classAgentUpdateParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final Integerversion()The agent's current version, used to prevent concurrent overwrites. final Optional<String>description()Description. final Optional<List<BetaManagedAgentsUrlMcpServerParams>>mcpServers()MCP servers. final Optional<AgentUpdateParams.Metadata>metadata()Metadata patch. final Optional<AgentUpdateParams.Model>model()Model identifier. final Optional<BetaManagedAgentsMultiagentParams>multiagent()A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the agentsroster.final Optional<String>name()Human-readable name. final Optional<List<BetaManagedAgentsSkillParams>>skills()Skills. final Optional<String>system()System prompt. final Optional<List<AgentUpdateParams.Tool>>tools()Tool configurations available to the agent. final JsonField<Integer>_version()Returns the raw JSON value of version. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<List<BetaManagedAgentsUrlMcpServerParams>>_mcpServers()Returns the raw JSON value of mcpServers. final JsonField<AgentUpdateParams.Metadata>_metadata()Returns the raw JSON value of metadata. final JsonField<AgentUpdateParams.Model>_model()Returns the raw JSON value of model. final JsonField<BetaManagedAgentsMultiagentParams>_multiagent()Returns the raw JSON value of multiagent. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<List<BetaManagedAgentsSkillParams>>_skills()Returns the raw JSON value of skills. final JsonField<String>_system()Returns the raw JSON value of system. final JsonField<List<AgentUpdateParams.Tool>>_tools()Returns the raw JSON value of tools. final Map<String, JsonValue>_additionalProperties()final AgentUpdateParams.Body.BuildertoBuilder()final AgentUpdateParams.Bodyvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static AgentUpdateParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
version
final 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.
-
description
final Optional<String> description()
Description. Omit to preserve; send empty string or null to clear.
-
mcpServers
final Optional<List<BetaManagedAgentsUrlMcpServerParams>> mcpServers()
MCP servers. Full replacement. Omit to preserve; send empty array or null to clear. Names must be unique. Maximum 20.
-
metadata
final Optional<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.
-
model
final Optional<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.
-
multiagent
final Optional<BetaManagedAgentsMultiagentParams> multiagent()
A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the
agentsroster.
-
name
final Optional<String> name()
Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.
-
skills
final Optional<List<BetaManagedAgentsSkillParams>> skills()
Skills. Full replacement. Omit to preserve; send empty array or null to clear.
-
system
final Optional<String> system()
System prompt. Omit to preserve; send empty string or null to clear.
-
tools
final Optional<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.
-
_version
final JsonField<Integer> _version()
Returns the raw JSON value of version.
Unlike version, this method doesn't throw if the JSON field has an unexpected type.
-
_description
final JsonField<String> _description()
Returns the raw JSON value of description.
Unlike description, this method doesn't throw if the JSON field has an unexpected type.
-
_mcpServers
final JsonField<List<BetaManagedAgentsUrlMcpServerParams>> _mcpServers()
Returns the raw JSON value of mcpServers.
Unlike mcpServers, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<AgentUpdateParams.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_model
final JsonField<AgentUpdateParams.Model> _model()
Returns the raw JSON value of model.
Unlike model, this method doesn't throw if the JSON field has an unexpected type.
-
_multiagent
final JsonField<BetaManagedAgentsMultiagentParams> _multiagent()
Returns the raw JSON value of multiagent.
Unlike multiagent, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_skills
final JsonField<List<BetaManagedAgentsSkillParams>> _skills()
Returns the raw JSON value of skills.
Unlike skills, this method doesn't throw if the JSON field has an unexpected type.
-
_system
final JsonField<String> _system()
Returns the raw JSON value of system.
Unlike system, this method doesn't throw if the JSON field has an unexpected type.
-
_tools
final JsonField<List<AgentUpdateParams.Tool>> _tools()
Returns the raw JSON value of tools.
Unlike tools, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final AgentUpdateParams.Body.Builder toBuilder()
-
validate
final AgentUpdateParams.Body validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static AgentUpdateParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.version()
-
-
-
-