CreateAgentIn class

Constructors

CreateAgentIn({String? computeRef, String? description, String? executionMode, String? instructions, String? model, String? name, String? schedule, String? serviceAccountId, List<String> tools = const []})
Returns a new CreateAgentIn instance.

Properties

computeRef ↔ String?
ComputeRef optionally binds this bot to a visor machine. Opaque here, bounded at 256 characters, and not resolved — this package stores the reference and the binding's lifecycle belongs elsewhere.
getter/setter pair
description ↔ String?
Description is the one line published as the description of the agent_<name> tool, which is how another agent decides whether to call this one. Optional, and worth writing for exactly that reason.
getter/setter pair
executionMode ↔ String?
ExecutionMode is one-shot or long-running. Empty takes one-shot, which runs only when something POSTs to it. long-running additionally requires Schedule, and counts against a per-org cap that answers 409 when it is full.
getter/setter pair
hashCode → int
The hash code for this object.
no setteroverride
instructions ↔ String?
Instructions is the system prompt, up to 32 KiB, stored verbatim. This is what the model reads; Description is what other CALLERS read.
getter/setter pair
model ↔ String?
Model names the model to run on. Omit it to take the deployment's configured default; name one and it is checked against the gateway's served catalogue here, so a model this deployment cannot serve is refused now rather than at the first run. Stored under our own name for it, whatever spelling arrives.
getter/setter pair
name ↔ String?
Name is the agent's org-unique handle and the only required field. It must match ^A-Za-z0-9._-{0,63}$, and a name already taken in this org is a 409 rather than an overwrite. It is permanent: no update route moves it.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schedule ↔ String?
Schedule is the 5-field cron a long-running agent fires on, parsed here so a bad expression is a 400 and not an agent that silently never runs. Required with long-running; DISCARDED for one-shot rather than stored unused.
getter/setter pair
serviceAccountId ↔ String?
ServiceAccountID optionally names the IAM agent service account (
getter/setter pair
tools ↔ List<String>
Tools are the tool names this agent may call. Omitted or empty grants NONE — that default is the agent's authority and is not widened anywhere. The single entry "*" means whatever the fleet's MCP server serves at the time of each run.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override

Static Methods

fromJson(dynamic value) → CreateAgentIn?
Returns a new CreateAgentIn instance and imports its values from value if it's a Map, null otherwise.
listFromJson(dynamic json, {bool growable = false}) → List<CreateAgentIn>
mapFromJson(dynamic json) → Map<String, CreateAgentIn>
mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<CreateAgentIn>>

Constants

requiredKeys → const Set<String>
The list of required keys that must be present in a JSON.