Files
sdk/docs/AgentAgentView.md

19 KiB

AgentAgentView

Properties

Name Type Description Notes
Avatar Pointer to string Avatar is an image the agent is drawn as — a link to one, or the bytes inline as a data URL, up to 96 KiB. Emoji is the one glyph a caller picked when they had no image. At most one is ever set; neither means the agent is drawn as its initial, the same way a person with no photo is. Both are iam/pkg/schema's Mark, so a face means the same thing on an agent as it does on a person or an org. Avatar is the agent's picture: an image URL, or the image itself inline as a data URL up to 96 KiB. Empty when the agent has no image. [optional]
CapMicroUsd Pointer to int64 CapMicroUSD is the total this agent may spend within one Period, as an integer number of micro-USD (1,000,000 = $1). It is required at creation: a cap of zero would mean no limit and no per-agent spend record at all. [optional]
ComputeRef Pointer to string ComputeRef is the visor machine this bot is bound to, opaque here: this package stores and echoes it, and the binding's lifecycle belongs elsewhere. Empty means unbound, which is what every one-shot agent is. [optional]
ConsumedMicroUsd Pointer to int64 ConsumedMicroUSD is what has been spent in the current period, in micro-USD. It is settled from what the gateway reported, not from the quote. [optional]
CreatedAt Pointer to string CreatedAt is when the agent was defined, RFC 3339 in UTC to the second. [optional]
Description Pointer to string Description is the one line another agent reads when deciding whether to call this one: the tool catalogue publishes it as the description of `agent_<name>`, falling back to &quot;agent <name>&quot; when it is empty. It is not part of the prompt — Instructions is — so writing the behaviour here reaches the caller and not the model. [optional]
Emoji Pointer to string Emoji is the single glyph a caller picked when they had no image. At most one of avatar and emoji is ever set; neither means the agent is drawn as its initial, the same way a person with no photo is. [optional]
ExecutionMode Pointer to string ExecutionMode is one-shot or long-running, and it decides who may start this agent. one-shot runs only when something POSTs to it; long-running is additionally invoked by the scheduler on Schedule, once a minute against the cron. An org's long-running agents are capped, so a switch INTO it can be refused with 409. [optional]
Id Pointer to string ID is the agent's stable handle, minted here as &quot;agent_&quot; + 32 hex characters of crypto/rand. A caller cannot choose it, and it never changes — unlike Name, which is the other way to address the same agent. [optional]
Lineage Pointer to []string Lineage is every agent above this one, nearest first — the parent, its parent, and so on to the agent a person defined. All of them are in this org, so the principal this agent answers to is theirs. [optional]
MaxTaskMicroUsd Pointer to int64 MaxTaskMicroUSD is the ceiling for a single run, in micro-USD. A session cannot exceed it even when the period cap still has room, so one runaway task cannot consume a month. [optional]
Model Pointer to string Model is the Zen model this agent runs on, and it is always OUR name for it: writes normalize through cloud.ZenModel and the read normalizes again, so an upstream family name never leaves here even from a row written before that rule existed. A create that named none took the deployment's configured default, so this is where a caller learns which model it actually got. [optional]
Name Pointer to string Name is the agent's org-unique handle, matching ^[A-Za-z0-9][A-Za-z0-9.-]{0,63}$. It addresses the agent everywhere ID does, it is what a run row records, and it is the suffix of the `agent<name>` tool other agents call this one by. Set once at create; no update route moves it, because moving it would orphan that history. [optional]
Parent Pointer to string Parent is the agent that spawned this one; absent for an agent a person defined. [optional]
Period Pointer to string Period is the window the cap resets on: day, week or month. [optional]
Runs Pointer to int64 Runs is how many executions the org has recorded against this agent, counted at read time. The list and update reads count the WHOLE history; the detail read reports the size of the RecentRuns page it carries, which stops at 20 — so a detail row saying 20 means &quot;at least 20&quot;, not &quot;exactly 20&quot;. [optional]
Schedule Pointer to string Schedule is the 5-field cron the scheduler fires a long-running agent on, evaluated once a minute. Required for long-running and DROPPED for one-shot — a one-shot agent's schedule is not stored, so absence here is the mode's answer rather than a value nobody set. [optional]
ServiceAccountId Pointer to string ServiceAccountID is the IAM agent service account (<org>-<agent>) a scheduled run is billed AS. It is what makes an autonomous run attributable to a principal rather than only to the org; empty means the org itself wears the spend. [optional]
Status Pointer to string Status is the agent's readiness: &quot;ready&quot;, or &quot;retired&quot; for a built-in whose member has left Hanzo's team. A retired agent is left out of the list and still answers a get by its handle. Server-set; no route accepts it. [optional]
Tools Pointer to []string Tools are the tool names this agent may call, and the list IS the authority: an agent that declares none gets none. The single entry &quot;*&quot; means whatever the fleet's MCP server serves at the moment of the run, resolved per run rather than frozen here, which is how the default assistant reaches subsystems that shipped after it was defined. Empty array, never null. [optional]
UpdatedAt Pointer to string UpdatedAt is the last time any field above was written, same format. It moves on an update to the DEFINITION and never on a run, so a busy agent nobody has edited keeps an old one. [optional]

Methods

NewAgentAgentView

func NewAgentAgentView() *AgentAgentView

NewAgentAgentView instantiates a new AgentAgentView object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewAgentAgentViewWithDefaults

func NewAgentAgentViewWithDefaults() *AgentAgentView

NewAgentAgentViewWithDefaults instantiates a new AgentAgentView object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetAvatar

func (o *AgentAgentView) GetAvatar() string

GetAvatar returns the Avatar field if non-nil, zero value otherwise.

GetAvatarOk

func (o *AgentAgentView) GetAvatarOk() (*string, bool)

GetAvatarOk returns a tuple with the Avatar field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAvatar

func (o *AgentAgentView) SetAvatar(v string)

SetAvatar sets Avatar field to given value.

HasAvatar

func (o *AgentAgentView) HasAvatar() bool

HasAvatar returns a boolean if a field has been set.

GetCapMicroUsd

func (o *AgentAgentView) GetCapMicroUsd() int64

GetCapMicroUsd returns the CapMicroUsd field if non-nil, zero value otherwise.

GetCapMicroUsdOk

func (o *AgentAgentView) GetCapMicroUsdOk() (*int64, bool)

GetCapMicroUsdOk returns a tuple with the CapMicroUsd field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCapMicroUsd

func (o *AgentAgentView) SetCapMicroUsd(v int64)

SetCapMicroUsd sets CapMicroUsd field to given value.

HasCapMicroUsd

func (o *AgentAgentView) HasCapMicroUsd() bool

HasCapMicroUsd returns a boolean if a field has been set.

GetComputeRef

func (o *AgentAgentView) GetComputeRef() string

GetComputeRef returns the ComputeRef field if non-nil, zero value otherwise.

GetComputeRefOk

func (o *AgentAgentView) GetComputeRefOk() (*string, bool)

GetComputeRefOk returns a tuple with the ComputeRef field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetComputeRef

func (o *AgentAgentView) SetComputeRef(v string)

SetComputeRef sets ComputeRef field to given value.

HasComputeRef

func (o *AgentAgentView) HasComputeRef() bool

HasComputeRef returns a boolean if a field has been set.

GetConsumedMicroUsd

func (o *AgentAgentView) GetConsumedMicroUsd() int64

GetConsumedMicroUsd returns the ConsumedMicroUsd field if non-nil, zero value otherwise.

GetConsumedMicroUsdOk

func (o *AgentAgentView) GetConsumedMicroUsdOk() (*int64, bool)

GetConsumedMicroUsdOk returns a tuple with the ConsumedMicroUsd field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetConsumedMicroUsd

func (o *AgentAgentView) SetConsumedMicroUsd(v int64)

SetConsumedMicroUsd sets ConsumedMicroUsd field to given value.

HasConsumedMicroUsd

func (o *AgentAgentView) HasConsumedMicroUsd() bool

HasConsumedMicroUsd returns a boolean if a field has been set.

GetCreatedAt

func (o *AgentAgentView) GetCreatedAt() string

GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise.

GetCreatedAtOk

func (o *AgentAgentView) GetCreatedAtOk() (*string, bool)

GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreatedAt

func (o *AgentAgentView) SetCreatedAt(v string)

SetCreatedAt sets CreatedAt field to given value.

HasCreatedAt

func (o *AgentAgentView) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

GetDescription

func (o *AgentAgentView) GetDescription() string

GetDescription returns the Description field if non-nil, zero value otherwise.

GetDescriptionOk

func (o *AgentAgentView) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDescription

func (o *AgentAgentView) SetDescription(v string)

SetDescription sets Description field to given value.

HasDescription

func (o *AgentAgentView) HasDescription() bool

HasDescription returns a boolean if a field has been set.

GetEmoji

func (o *AgentAgentView) GetEmoji() string

GetEmoji returns the Emoji field if non-nil, zero value otherwise.

GetEmojiOk

func (o *AgentAgentView) GetEmojiOk() (*string, bool)

GetEmojiOk returns a tuple with the Emoji field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEmoji

func (o *AgentAgentView) SetEmoji(v string)

SetEmoji sets Emoji field to given value.

HasEmoji

func (o *AgentAgentView) HasEmoji() bool

HasEmoji returns a boolean if a field has been set.

GetExecutionMode

func (o *AgentAgentView) GetExecutionMode() string

GetExecutionMode returns the ExecutionMode field if non-nil, zero value otherwise.

GetExecutionModeOk

func (o *AgentAgentView) GetExecutionModeOk() (*string, bool)

GetExecutionModeOk returns a tuple with the ExecutionMode field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetExecutionMode

func (o *AgentAgentView) SetExecutionMode(v string)

SetExecutionMode sets ExecutionMode field to given value.

HasExecutionMode

func (o *AgentAgentView) HasExecutionMode() bool

HasExecutionMode returns a boolean if a field has been set.

GetId

func (o *AgentAgentView) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *AgentAgentView) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *AgentAgentView) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *AgentAgentView) HasId() bool

HasId returns a boolean if a field has been set.

GetLineage

func (o *AgentAgentView) GetLineage() []string

GetLineage returns the Lineage field if non-nil, zero value otherwise.

GetLineageOk

func (o *AgentAgentView) GetLineageOk() (*[]string, bool)

GetLineageOk returns a tuple with the Lineage field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLineage

func (o *AgentAgentView) SetLineage(v []string)

SetLineage sets Lineage field to given value.

HasLineage

func (o *AgentAgentView) HasLineage() bool

HasLineage returns a boolean if a field has been set.

GetMaxTaskMicroUsd

func (o *AgentAgentView) GetMaxTaskMicroUsd() int64

GetMaxTaskMicroUsd returns the MaxTaskMicroUsd field if non-nil, zero value otherwise.

GetMaxTaskMicroUsdOk

func (o *AgentAgentView) GetMaxTaskMicroUsdOk() (*int64, bool)

GetMaxTaskMicroUsdOk returns a tuple with the MaxTaskMicroUsd field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMaxTaskMicroUsd

func (o *AgentAgentView) SetMaxTaskMicroUsd(v int64)

SetMaxTaskMicroUsd sets MaxTaskMicroUsd field to given value.

HasMaxTaskMicroUsd

func (o *AgentAgentView) HasMaxTaskMicroUsd() bool

HasMaxTaskMicroUsd returns a boolean if a field has been set.

GetModel

func (o *AgentAgentView) GetModel() string

GetModel returns the Model field if non-nil, zero value otherwise.

GetModelOk

func (o *AgentAgentView) GetModelOk() (*string, bool)

GetModelOk returns a tuple with the Model field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetModel

func (o *AgentAgentView) SetModel(v string)

SetModel sets Model field to given value.

HasModel

func (o *AgentAgentView) HasModel() bool

HasModel returns a boolean if a field has been set.

GetName

func (o *AgentAgentView) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *AgentAgentView) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *AgentAgentView) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *AgentAgentView) HasName() bool

HasName returns a boolean if a field has been set.

GetParent

func (o *AgentAgentView) GetParent() string

GetParent returns the Parent field if non-nil, zero value otherwise.

GetParentOk

func (o *AgentAgentView) GetParentOk() (*string, bool)

GetParentOk returns a tuple with the Parent field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetParent

func (o *AgentAgentView) SetParent(v string)

SetParent sets Parent field to given value.

HasParent

func (o *AgentAgentView) HasParent() bool

HasParent returns a boolean if a field has been set.

GetPeriod

func (o *AgentAgentView) GetPeriod() string

GetPeriod returns the Period field if non-nil, zero value otherwise.

GetPeriodOk

func (o *AgentAgentView) GetPeriodOk() (*string, bool)

GetPeriodOk returns a tuple with the Period field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPeriod

func (o *AgentAgentView) SetPeriod(v string)

SetPeriod sets Period field to given value.

HasPeriod

func (o *AgentAgentView) HasPeriod() bool

HasPeriod returns a boolean if a field has been set.

GetRuns

func (o *AgentAgentView) GetRuns() int64

GetRuns returns the Runs field if non-nil, zero value otherwise.

GetRunsOk

func (o *AgentAgentView) GetRunsOk() (*int64, bool)

GetRunsOk returns a tuple with the Runs field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRuns

func (o *AgentAgentView) SetRuns(v int64)

SetRuns sets Runs field to given value.

HasRuns

func (o *AgentAgentView) HasRuns() bool

HasRuns returns a boolean if a field has been set.

GetSchedule

func (o *AgentAgentView) GetSchedule() string

GetSchedule returns the Schedule field if non-nil, zero value otherwise.

GetScheduleOk

func (o *AgentAgentView) GetScheduleOk() (*string, bool)

GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSchedule

func (o *AgentAgentView) SetSchedule(v string)

SetSchedule sets Schedule field to given value.

HasSchedule

func (o *AgentAgentView) HasSchedule() bool

HasSchedule returns a boolean if a field has been set.

GetServiceAccountId

func (o *AgentAgentView) GetServiceAccountId() string

GetServiceAccountId returns the ServiceAccountId field if non-nil, zero value otherwise.

GetServiceAccountIdOk

func (o *AgentAgentView) GetServiceAccountIdOk() (*string, bool)

GetServiceAccountIdOk returns a tuple with the ServiceAccountId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetServiceAccountId

func (o *AgentAgentView) SetServiceAccountId(v string)

SetServiceAccountId sets ServiceAccountId field to given value.

HasServiceAccountId

func (o *AgentAgentView) HasServiceAccountId() bool

HasServiceAccountId returns a boolean if a field has been set.

GetStatus

func (o *AgentAgentView) GetStatus() string

GetStatus returns the Status field if non-nil, zero value otherwise.

GetStatusOk

func (o *AgentAgentView) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStatus

func (o *AgentAgentView) SetStatus(v string)

SetStatus sets Status field to given value.

HasStatus

func (o *AgentAgentView) HasStatus() bool

HasStatus returns a boolean if a field has been set.

GetTools

func (o *AgentAgentView) GetTools() []string

GetTools returns the Tools field if non-nil, zero value otherwise.

GetToolsOk

func (o *AgentAgentView) GetToolsOk() (*[]string, bool)

GetToolsOk returns a tuple with the Tools field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTools

func (o *AgentAgentView) SetTools(v []string)

SetTools sets Tools field to given value.

HasTools

func (o *AgentAgentView) HasTools() bool

HasTools returns a boolean if a field has been set.

GetUpdatedAt

func (o *AgentAgentView) GetUpdatedAt() string

GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise.

GetUpdatedAtOk

func (o *AgentAgentView) GetUpdatedAtOk() (*string, bool)

GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetUpdatedAt

func (o *AgentAgentView) SetUpdatedAt(v string)

SetUpdatedAt sets UpdatedAt field to given value.

HasUpdatedAt

func (o *AgentAgentView) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]