apiclient

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2026 License: AGPL-3.0 Imports: 12 Imported by: 0

Documentation

Overview

Package apiclient provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.2 DO NOT EDIT.

Package apiclient is the oapi-codegen client for api/openapi.yaml, used by factory-agent and the factory CLI. Payloads that are v1alpha1 kinds are the internal/apis/v1alpha1 types (x-go-type), not copies.

Generated: never edit client.gen.go by hand; run make generate.

Index

Constants

View Source
const (
	AgentRefreshTokenScopes agentRefreshTokenContextKey = "agentRefreshToken.Scopes"
	AgentTokenScopes        agentTokenContextKey        = "agentToken.Scopes"
	CliTokenScopes          cliTokenContextKey          = "cliToken.Scopes"
	EnrollmentTokenScopes   enrollmentTokenContextKey   = "enrollmentToken.Scopes"
	RunTokenScopes          runTokenContextKey          = "runToken.Scopes"
	UiSessionScopes         uiSessionContextKey         = "uiSession.Scopes"
)

Variables

This section is empty.

Functions

func NewAbandonLeaseRequest

func NewAbandonLeaseRequest(server string, id LeaseID, body AbandonLeaseJSONRequestBody) (*http.Request, error)

NewAbandonLeaseRequest calls the generic AbandonLease builder with application/json body

func NewAbandonLeaseRequestWithBody

func NewAbandonLeaseRequestWithBody(server string, id LeaseID, contentType string, body io.Reader) (*http.Request, error)

NewAbandonLeaseRequestWithBody generates requests for AbandonLease with any type of body

func NewAuthCallbackRequest

func NewAuthCallbackRequest(server string, params *AuthCallbackParams) (*http.Request, error)

NewAuthCallbackRequest generates requests for AuthCallback

func NewCloseWorkItemRequest

func NewCloseWorkItemRequest(server string, id WorkItemID, body CloseWorkItemJSONRequestBody) (*http.Request, error)

NewCloseWorkItemRequest calls the generic CloseWorkItem builder with application/json body

func NewCloseWorkItemRequestWithBody

func NewCloseWorkItemRequestWithBody(server string, id WorkItemID, contentType string, body io.Reader) (*http.Request, error)

NewCloseWorkItemRequestWithBody generates requests for CloseWorkItem with any type of body

func NewCompleteLeaseRequest

func NewCompleteLeaseRequest(server string, id LeaseID, body CompleteLeaseJSONRequestBody) (*http.Request, error)

NewCompleteLeaseRequest calls the generic CompleteLease builder with application/json body

func NewCompleteLeaseRequestWithBody

func NewCompleteLeaseRequestWithBody(server string, id LeaseID, contentType string, body io.Reader) (*http.Request, error)

NewCompleteLeaseRequestWithBody generates requests for CompleteLease with any type of body

func NewCreateEffectRequest

func NewCreateEffectRequest(server string, id TaskID, body CreateEffectJSONRequestBody) (*http.Request, error)

NewCreateEffectRequest calls the generic CreateEffect builder with application/json body

func NewCreateEffectRequestWithBody

func NewCreateEffectRequestWithBody(server string, id TaskID, contentType string, body io.Reader) (*http.Request, error)

NewCreateEffectRequestWithBody generates requests for CreateEffect with any type of body

func NewCreateEnrollmentRequest

func NewCreateEnrollmentRequest(server string, body CreateEnrollmentJSONRequestBody) (*http.Request, error)

NewCreateEnrollmentRequest calls the generic CreateEnrollment builder with application/json body

func NewCreateEnrollmentRequestWithBody

func NewCreateEnrollmentRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateEnrollmentRequestWithBody generates requests for CreateEnrollment with any type of body

func NewDeleteEnrollmentRequest

func NewDeleteEnrollmentRequest(server string, id EnrollmentID) (*http.Request, error)

NewDeleteEnrollmentRequest generates requests for DeleteEnrollment

func NewDeleteWorkItemRequest

func NewDeleteWorkItemRequest(server string, id WorkItemID, params *DeleteWorkItemParams) (*http.Request, error)

NewDeleteWorkItemRequest generates requests for DeleteWorkItem

func NewDeregisterAgentRequest

func NewDeregisterAgentRequest(server string, id AgentID) (*http.Request, error)

NewDeregisterAgentRequest generates requests for DeregisterAgent

func NewDryRunCatalogRequest

func NewDryRunCatalogRequest(server string, body DryRunCatalogJSONRequestBody) (*http.Request, error)

NewDryRunCatalogRequest calls the generic DryRunCatalog builder with application/json body

func NewDryRunCatalogRequestWithBody

func NewDryRunCatalogRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewDryRunCatalogRequestWithBody generates requests for DryRunCatalog with any type of body

func NewGetCatalogFileRequest

func NewGetCatalogFileRequest(server string, params *GetCatalogFileParams) (*http.Request, error)

NewGetCatalogFileRequest generates requests for GetCatalogFile

func NewGetCatalogObjectRequest

func NewGetCatalogObjectRequest(server string, kind CatalogKind, name string) (*http.Request, error)

NewGetCatalogObjectRequest generates requests for GetCatalogObject

func NewGetCatalogRequest

func NewGetCatalogRequest(server string) (*http.Request, error)

NewGetCatalogRequest generates requests for GetCatalog

func NewGetEnvironmentLogRequest

func NewGetEnvironmentLogRequest(server string, id RunID) (*http.Request, error)

NewGetEnvironmentLogRequest generates requests for GetEnvironmentLog

func NewGetMeRequest

func NewGetMeRequest(server string) (*http.Request, error)

NewGetMeRequest generates requests for GetMe

func NewGetRunRequest

func NewGetRunRequest(server string, id RunID) (*http.Request, error)

NewGetRunRequest generates requests for GetRun

func NewGetTaskContextRequest

func NewGetTaskContextRequest(server string, id TaskID, n int) (*http.Request, error)

NewGetTaskContextRequest generates requests for GetTaskContext

func NewGetTaskOutputSchemaRequest

func NewGetTaskOutputSchemaRequest(server string, id TaskID) (*http.Request, error)

NewGetTaskOutputSchemaRequest generates requests for GetTaskOutputSchema

func NewGetTaskPromptRequest

func NewGetTaskPromptRequest(server string, id TaskID) (*http.Request, error)

NewGetTaskPromptRequest generates requests for GetTaskPrompt

func NewGetTaskRequest

func NewGetTaskRequest(server string, id TaskID) (*http.Request, error)

NewGetTaskRequest generates requests for GetTask

func NewGetTranscriptRequest

func NewGetTranscriptRequest(server string, id RunID) (*http.Request, error)

NewGetTranscriptRequest generates requests for GetTranscript

func NewGetWorkItemRequest

func NewGetWorkItemRequest(server string, id WorkItemID) (*http.Request, error)

NewGetWorkItemRequest generates requests for GetWorkItem

func NewHeartbeatLeaseRequest

func NewHeartbeatLeaseRequest(server string, id LeaseID, body HeartbeatLeaseJSONRequestBody) (*http.Request, error)

NewHeartbeatLeaseRequest calls the generic HeartbeatLease builder with application/json body

func NewHeartbeatLeaseRequestWithBody

func NewHeartbeatLeaseRequestWithBody(server string, id LeaseID, contentType string, body io.Reader) (*http.Request, error)

NewHeartbeatLeaseRequestWithBody generates requests for HeartbeatLease with any type of body

func NewLeaseTaskRequest

func NewLeaseTaskRequest(server string, id AgentID, params *LeaseTaskParams) (*http.Request, error)

NewLeaseTaskRequest generates requests for LeaseTask

func NewListAgentsRequest

func NewListAgentsRequest(server string, params *ListAgentsParams) (*http.Request, error)

NewListAgentsRequest generates requests for ListAgents

func NewListCatalogFilesRequest

func NewListCatalogFilesRequest(server string) (*http.Request, error)

NewListCatalogFilesRequest generates requests for ListCatalogFiles

func NewListEnrollmentsRequest

func NewListEnrollmentsRequest(server string, params *ListEnrollmentsParams) (*http.Request, error)

NewListEnrollmentsRequest generates requests for ListEnrollments

func NewListPoolsRequest

func NewListPoolsRequest(server string, params *ListPoolsParams) (*http.Request, error)

NewListPoolsRequest generates requests for ListPools

func NewListProvidersRequest

func NewListProvidersRequest(server string, params *ListProvidersParams) (*http.Request, error)

NewListProvidersRequest generates requests for ListProviders

func NewListQueuesRequest

func NewListQueuesRequest(server string, params *ListQueuesParams) (*http.Request, error)

NewListQueuesRequest generates requests for ListQueues

func NewListTasksRequest

func NewListTasksRequest(server string, params *ListTasksParams) (*http.Request, error)

NewListTasksRequest generates requests for ListTasks

func NewListWorkItemsRequest

func NewListWorkItemsRequest(server string, params *ListWorkItemsParams) (*http.Request, error)

NewListWorkItemsRequest generates requests for ListWorkItems

func NewLoginRequest

func NewLoginRequest(server string, params *LoginParams) (*http.Request, error)

NewLoginRequest generates requests for Login

func NewLogoutRequest

func NewLogoutRequest(server string) (*http.Request, error)

NewLogoutRequest generates requests for Logout

func NewPostCommandRequest

func NewPostCommandRequest(server string, body PostCommandJSONRequestBody) (*http.Request, error)

NewPostCommandRequest calls the generic PostCommand builder with application/json body

func NewPostCommandRequestWithBody

func NewPostCommandRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostCommandRequestWithBody generates requests for PostCommand with any type of body

func NewRegisterAgentRequest

func NewRegisterAgentRequest(server string, body RegisterAgentJSONRequestBody) (*http.Request, error)

NewRegisterAgentRequest calls the generic RegisterAgent builder with application/json body

func NewRegisterAgentRequestWithBody

func NewRegisterAgentRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewRegisterAgentRequestWithBody generates requests for RegisterAgent with any type of body

func NewReplayEventRequest

func NewReplayEventRequest(server string, id EventID) (*http.Request, error)

NewReplayEventRequest generates requests for ReplayEvent

func NewStreamEventsRequest

func NewStreamEventsRequest(server string, params *StreamEventsParams) (*http.Request, error)

NewStreamEventsRequest generates requests for StreamEvents

func NewUpdateAgentRequest

func NewUpdateAgentRequest(server string, id AgentID, body UpdateAgentJSONRequestBody) (*http.Request, error)

NewUpdateAgentRequest calls the generic UpdateAgent builder with application/json body

func NewUpdateAgentRequestWithBody

func NewUpdateAgentRequestWithBody(server string, id AgentID, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAgentRequestWithBody generates requests for UpdateAgent with any type of body

func NewUploadEnvironmentLogRequestWithBody

func NewUploadEnvironmentLogRequestWithBody(server string, id RunID, contentType string, body io.Reader) (*http.Request, error)

NewUploadEnvironmentLogRequestWithBody generates requests for UploadEnvironmentLog with any type of body

func NewUploadEnvironmentLogRequestWithTextBody

func NewUploadEnvironmentLogRequestWithTextBody(server string, id RunID, body UploadEnvironmentLogTextRequestBody) (*http.Request, error)

NewUploadEnvironmentLogRequestWithTextBody calls the generic UploadEnvironmentLog builder with text/plain body

func NewUploadTranscriptRequestWithBody

func NewUploadTranscriptRequestWithBody(server string, id RunID, contentType string, body io.Reader) (*http.Request, error)

NewUploadTranscriptRequestWithBody generates requests for UploadTranscript with any type of body

Types

type AbandonLeaseJSONRequestBody

type AbandonLeaseJSONRequestBody = AbandonRequest

AbandonLeaseJSONRequestBody defines body for AbandonLease for application/json ContentType.

type AbandonLeaseResponse

type AbandonLeaseResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON409     *Conflict
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseAbandonLeaseResponse

func ParseAbandonLeaseResponse(rsp *http.Response) (*AbandonLeaseResponse, error)

ParseAbandonLeaseResponse parses an HTTP response from a AbandonLeaseWithResponse call

func (AbandonLeaseResponse) ContentType

func (r AbandonLeaseResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AbandonLeaseResponse) Status

func (r AbandonLeaseResponse) Status() string

Status returns HTTPResponse.Status

func (AbandonLeaseResponse) StatusCode

func (r AbandonLeaseResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AbandonRequest

type AbandonRequest struct {
	Message *string              `json:"message,omitempty"`
	Reason  AbandonRequestReason `json:"reason"`

	// Until With `throttled`, when the harness's limit resets.
	Until *time.Time `json:"until,omitempty"`
}

AbandonRequest Why the task is handed back.

type AbandonRequestReason

type AbandonRequestReason string

AbandonRequestReason defines model for AbandonRequest.Reason.

const (
	AbandonRequestReasonAgentError AbandonRequestReason = "agent-error"
	AbandonRequestReasonShutdown   AbandonRequestReason = "shutdown"
	AbandonRequestReasonThrottled  AbandonRequestReason = "throttled"
)

Defines values for AbandonRequestReason.

func (AbandonRequestReason) Valid

func (e AbandonRequestReason) Valid() bool

Valid indicates whether the value is a known member of the AbandonRequestReason enum.

type Action

type Action = v1alpha1.Action

Action Action is a tagged union: exactly one member is set.

type ActionIntent

type ActionIntent struct {
	Type                 ActionIntentType       `json:"type"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

ActionIntent A materialised action; the fields besides `type` depend on it.

func (ActionIntent) Get

func (a ActionIntent) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for ActionIntent. Returns the specified element and whether it was found

func (ActionIntent) MarshalJSON

func (a ActionIntent) MarshalJSON() ([]byte, error)

Override default JSON handling for ActionIntent to handle AdditionalProperties

func (*ActionIntent) Set

func (a *ActionIntent) Set(fieldName string, value interface{})

Setter for additional properties for ActionIntent

func (*ActionIntent) UnmarshalJSON

func (a *ActionIntent) UnmarshalJSON(b []byte) error

Override default JSON handling for ActionIntent to handle AdditionalProperties

type ActionIntentType

type ActionIntentType string

ActionIntentType defines model for ActionIntent.Type.

const (
	ActionIntentTypeCancel      ActionIntentType = "cancel"
	ActionIntentTypeDebounce    ActionIntentType = "debounce"
	ActionIntentTypeDispatch    ActionIntentType = "dispatch"
	ActionIntentTypeEffect      ActionIntentType = "effect"
	ActionIntentTypeLink        ActionIntentType = "link"
	ActionIntentTypeNotify      ActionIntentType = "notify"
	ActionIntentTypeSet         ActionIntentType = "set"
	ActionIntentTypeUnsupported ActionIntentType = "unsupported"
)

Defines values for ActionIntentType.

func (ActionIntentType) Valid

func (e ActionIntentType) Valid() bool

Valid indicates whether the value is a known member of the ActionIntentType enum.

type Actor

type Actor = v1alpha1.Actor

Actor Actor is who caused an event.

type Admission

type Admission = v1alpha1.Admission

Admission Admission marks a registered pool that takes enrollments (P1 §6): an admin mints them with createEnrollment, naming each agent's owner.

type Agent

type Agent = v1alpha1.Agent

Agent Agent is a registered worker.

type AgentCapabilities

type AgentCapabilities = v1alpha1.AgentCapabilities

AgentCapabilities AgentCapabilities are the agent's harness offers and labels.

type AgentID

type AgentID = string

AgentID defines model for AgentID.

type AgentList

type AgentList struct {
	Items []Agent `json:"items"`

	// NextCursor Absent on the last page.
	NextCursor *string `json:"nextCursor,omitempty"`
}

AgentList A page of agents.

type AgentPhase

type AgentPhase = v1alpha1.AgentPhase

AgentPhase AgentPhase is a registered agent's state.

type AgentRegistration

type AgentRegistration struct {
	AgentId string `json:"agentId"`

	// AgentToken Keep in memory only; re-register on restart.
	AgentToken string    `json:"agentToken"`
	ExpiresAt  time.Time `json:"expiresAt"`

	// RefreshToken The agent's new refresh token (the `agentRefreshToken` scheme). Present only when
	// registering with an enrollment token or a refresh token. Keep it 0600 on the agent
	// host; it replaces the previous one, which is now spent.
	RefreshToken *string `json:"refreshToken,omitempty"`
}

AgentRegistration The agent's id and its bearer token.

type AgentSpec

type AgentSpec = v1alpha1.AgentSpec

AgentSpec AgentSpec is what the agent offers and what its owner lends.

type AgentStatus

type AgentStatus = v1alpha1.AgentStatus

AgentStatus AgentStatus is the agent's state.

type AgentUpdate

type AgentUpdate struct {
	// Lending Lending is the owner's consent: what the agent may take.
	Lending *Lending             `json:"lending,omitempty"`
	Phase   *v1alpha1.AgentPhase `json:"phase,omitempty"`

	// Until Required with `Throttled`.
	Until *time.Time `json:"until,omitempty"`
}

AgentUpdate A status report and/or a lending update. At least one field.

type AgentUsage

type AgentUsage = v1alpha1.AgentUsage

AgentUsage AgentUsage is the agent's usage today, checked against its lending.

type AppIdentity

type AppIdentity = v1alpha1.AppIdentity

AppIdentity AppIdentity is a GitHub App.

type ApprovalPhase

type ApprovalPhase = v1alpha1.ApprovalPhase

ApprovalPhase ApprovalPhase is an Approval's state: Pending → Granted | Denied | Expired.

type ApprovalRef

type ApprovalRef = v1alpha1.ApprovalRef

ApprovalRef ApprovalRef is an approval's name and phase, as shown on the work item.

type ApprovalSpec

type ApprovalSpec = v1alpha1.ApprovalSpec

ApprovalSpec ApprovalSpec is what is asked, of whom.

type Artifact

type Artifact = v1alpha1.Artifact

Artifact Artifact is something the run produced.

type AuthCallbackParams

type AuthCallbackParams struct {
	// Code The authorization code from GitHub.
	Code string `form:"code" json:"code"`

	// State The state given at login.
	State string `form:"state" json:"state"`
}

AuthCallbackParams defines parameters for AuthCallback.

type AuthCallbackResponse

type AuthCallbackResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseAuthCallbackResponse

func ParseAuthCallbackResponse(rsp *http.Response) (*AuthCallbackResponse, error)

ParseAuthCallbackResponse parses an HTTP response from a AuthCallbackWithResponse call

func (AuthCallbackResponse) ContentType

func (r AuthCallbackResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AuthCallbackResponse) Status

func (r AuthCallbackResponse) Status() string

Status returns HTTPResponse.Status

func (AuthCallbackResponse) StatusCode

func (r AuthCallbackResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BadRequest

type BadRequest = Problem

BadRequest An RFC 9457 problem detail.

type Budget

type Budget = v1alpha1.Budget

Budget Budget caps spend.

type BudgetLimit

type BudgetLimit = v1alpha1.BudgetLimit

BudgetLimit BudgetLimit is one budget window's limits; an unset limit is unlimited.

type CancelAction

type CancelAction = v1alpha1.CancelAction

CancelAction CancelAction cancels the active tasks of a task spec for the work item.

type CatalogError

type CatalogError struct {
	Code    *string `json:"code,omitempty"`
	File    *string `json:"file,omitempty"`
	Line    *int    `json:"line,omitempty"`
	Message string  `json:"message"`
}

CatalogError One catalog load error.

type CatalogFile

type CatalogFile struct {
	// Content The file's text, unrendered.
	Content string `json:"content"`

	// Digest `sha256:<hex>` of the content (a prompt's is its `spec.prompt.digest`).
	Digest string `json:"digest"`

	// Kind `prompt` is a template under `prompts/`; `schema` a JSON Schema under `schemas/`.
	Kind CatalogFileKind `json:"kind"`
	Path string          `json:"path"`
}

CatalogFile One prompt or schema file, as the catalog holds it.

type CatalogFileKind

type CatalogFileKind string

CatalogFileKind `prompt` is a template under `prompts/`; `schema` a JSON Schema under `schemas/`.

const (
	CatalogFileKindPrompt CatalogFileKind = "prompt"
	CatalogFileKindSchema CatalogFileKind = "schema"
)

Defines values for CatalogFileKind.

func (CatalogFileKind) Valid

func (e CatalogFileKind) Valid() bool

Valid indicates whether the value is a known member of the CatalogFileKind enum.

type CatalogFileList

type CatalogFileList struct {
	Items []CatalogFileRef `json:"items"`
}

CatalogFileList The catalog's prompt and schema files.

type CatalogFileRef

type CatalogFileRef struct {
	// Kind `prompt` is a template under `prompts/`; `schema` a JSON Schema under `schemas/`.
	Kind CatalogFileKind `json:"kind"`

	// Path The catalog-relative path, as TaskSpecs reference it.
	Path string `json:"path"`
}

CatalogFileRef One prompt or schema file of the catalog.

type CatalogKind

type CatalogKind string

CatalogKind A config kind.

const (
	CatalogKindGroup    CatalogKind = "Group"
	CatalogKindPool     CatalogKind = "Pool"
	CatalogKindProvider CatalogKind = "Provider"
	CatalogKindQueue    CatalogKind = "Queue"
	CatalogKindRule     CatalogKind = "Rule"
	CatalogKindRuleSet  CatalogKind = "RuleSet"
	CatalogKindTaskSpec CatalogKind = "TaskSpec"
	CatalogKindTemplate CatalogKind = "Template"
)

Defines values for CatalogKind.

func (CatalogKind) Valid

func (e CatalogKind) Valid() bool

Valid indicates whether the value is a known member of the CatalogKind enum.

type CatalogObject

type CatalogObject struct {
	// contains filtered or unexported fields
}

CatalogObject One config object, by kind.

func (CatalogObject) AsGroup

func (t CatalogObject) AsGroup() (Group, error)

AsGroup returns the union data inside the CatalogObject as a Group

func (CatalogObject) AsPool

func (t CatalogObject) AsPool() (Pool, error)

AsPool returns the union data inside the CatalogObject as a Pool

func (CatalogObject) AsProvider

func (t CatalogObject) AsProvider() (Provider, error)

AsProvider returns the union data inside the CatalogObject as a Provider

func (CatalogObject) AsQueue

func (t CatalogObject) AsQueue() (Queue, error)

AsQueue returns the union data inside the CatalogObject as a Queue

func (CatalogObject) AsRule

func (t CatalogObject) AsRule() (Rule, error)

AsRule returns the union data inside the CatalogObject as a Rule

func (CatalogObject) AsRuleSet

func (t CatalogObject) AsRuleSet() (RuleSet, error)

AsRuleSet returns the union data inside the CatalogObject as a RuleSet

func (CatalogObject) AsTaskSpec

func (t CatalogObject) AsTaskSpec() (TaskSpec, error)

AsTaskSpec returns the union data inside the CatalogObject as a TaskSpec

func (CatalogObject) AsTemplate

func (t CatalogObject) AsTemplate() (Template, error)

AsTemplate returns the union data inside the CatalogObject as a Template

func (CatalogObject) Discriminator

func (t CatalogObject) Discriminator() (string, error)

func (*CatalogObject) FromGroup

func (t *CatalogObject) FromGroup(v Group) error

FromGroup overwrites any union data inside the CatalogObject as the provided Group

func (*CatalogObject) FromPool

func (t *CatalogObject) FromPool(v Pool) error

FromPool overwrites any union data inside the CatalogObject as the provided Pool

func (*CatalogObject) FromProvider

func (t *CatalogObject) FromProvider(v Provider) error

FromProvider overwrites any union data inside the CatalogObject as the provided Provider

func (*CatalogObject) FromQueue

func (t *CatalogObject) FromQueue(v Queue) error

FromQueue overwrites any union data inside the CatalogObject as the provided Queue

func (*CatalogObject) FromRule

func (t *CatalogObject) FromRule(v Rule) error

FromRule overwrites any union data inside the CatalogObject as the provided Rule

func (*CatalogObject) FromRuleSet

func (t *CatalogObject) FromRuleSet(v RuleSet) error

FromRuleSet overwrites any union data inside the CatalogObject as the provided RuleSet

func (*CatalogObject) FromTaskSpec

func (t *CatalogObject) FromTaskSpec(v TaskSpec) error

FromTaskSpec overwrites any union data inside the CatalogObject as the provided TaskSpec

func (*CatalogObject) FromTemplate

func (t *CatalogObject) FromTemplate(v Template) error

FromTemplate overwrites any union data inside the CatalogObject as the provided Template

func (CatalogObject) MarshalJSON

func (t CatalogObject) MarshalJSON() ([]byte, error)

func (*CatalogObject) MergeGroup

func (t *CatalogObject) MergeGroup(v Group) error

MergeGroup performs a merge with any union data inside the CatalogObject, using the provided Group

func (*CatalogObject) MergePool

func (t *CatalogObject) MergePool(v Pool) error

MergePool performs a merge with any union data inside the CatalogObject, using the provided Pool

func (*CatalogObject) MergeProvider

func (t *CatalogObject) MergeProvider(v Provider) error

MergeProvider performs a merge with any union data inside the CatalogObject, using the provided Provider

func (*CatalogObject) MergeQueue

func (t *CatalogObject) MergeQueue(v Queue) error

MergeQueue performs a merge with any union data inside the CatalogObject, using the provided Queue

func (*CatalogObject) MergeRule

func (t *CatalogObject) MergeRule(v Rule) error

MergeRule performs a merge with any union data inside the CatalogObject, using the provided Rule

func (*CatalogObject) MergeRuleSet

func (t *CatalogObject) MergeRuleSet(v RuleSet) error

MergeRuleSet performs a merge with any union data inside the CatalogObject, using the provided RuleSet

func (*CatalogObject) MergeTaskSpec

func (t *CatalogObject) MergeTaskSpec(v TaskSpec) error

MergeTaskSpec performs a merge with any union data inside the CatalogObject, using the provided TaskSpec

func (*CatalogObject) MergeTemplate

func (t *CatalogObject) MergeTemplate(v Template) error

MergeTemplate performs a merge with any union data inside the CatalogObject, using the provided Template

func (*CatalogObject) UnmarshalJSON

func (t *CatalogObject) UnmarshalJSON(b []byte) error

func (CatalogObject) ValueByDiscriminator

func (t CatalogObject) ValueByDiscriminator() (interface{}, error)

type CatalogObjectRef

type CatalogObjectRef struct {
	// Kind A config kind.
	Kind   CatalogKind       `json:"kind"`
	Labels map[string]string `json:"labels,omitempty"`
	Name   string            `json:"name"`
}

CatalogObjectRef One object in the catalog.

type CatalogSummary

type CatalogSummary struct {
	Errors   []CatalogError     `json:"errors,omitempty"`
	LoadedAt *time.Time         `json:"loadedAt,omitempty"`
	Objects  []CatalogObjectRef `json:"objects"`
	Ref      string             `json:"ref"`

	// Repo The catalog repo URL, or empty for `--catalog-dir`.
	Repo *string `json:"repo,omitempty"`
	Sha  string  `json:"sha"`

	// Status `error` keeps serving the last good catalog.
	Status CatalogSummaryStatus `json:"status"`

	// Warnings The live catalog's warnings, and the missing App installations (code
	// `app-not-installed`): an identity's App that isn't installed on a repo a TaskSpec or
	// RuleSet can touch.
	Warnings []CatalogError `json:"warnings,omitempty"`
}

CatalogSummary The loaded catalog.

type CatalogSummaryStatus

type CatalogSummaryStatus string

CatalogSummaryStatus `error` keeps serving the last good catalog.

const (
	CatalogSummaryStatusError   CatalogSummaryStatus = "error"
	CatalogSummaryStatusLoaded  CatalogSummaryStatus = "loaded"
	CatalogSummaryStatusLoading CatalogSummaryStatus = "loading"
)

Defines values for CatalogSummaryStatus.

func (CatalogSummaryStatus) Valid

func (e CatalogSummaryStatus) Valid() bool

Valid indicates whether the value is a known member of the CatalogSummaryStatus enum.

type ChannelRef

type ChannelRef = v1alpha1.ChannelRef

ChannelRef ChannelRef is a channel on a provider.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) AbandonLease

func (c *Client) AbandonLease(ctx context.Context, id LeaseID, body AbandonLeaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AbandonLeaseWithBody

func (c *Client) AbandonLeaseWithBody(ctx context.Context, id LeaseID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AuthCallback

func (c *Client) AuthCallback(ctx context.Context, params *AuthCallbackParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CloseWorkItem

func (c *Client) CloseWorkItem(ctx context.Context, id WorkItemID, body CloseWorkItemJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CloseWorkItemWithBody

func (c *Client) CloseWorkItemWithBody(ctx context.Context, id WorkItemID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CompleteLease

func (c *Client) CompleteLease(ctx context.Context, id LeaseID, body CompleteLeaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CompleteLeaseWithBody

func (c *Client) CompleteLeaseWithBody(ctx context.Context, id LeaseID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEffect

func (c *Client) CreateEffect(ctx context.Context, id TaskID, body CreateEffectJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEffectWithBody

func (c *Client) CreateEffectWithBody(ctx context.Context, id TaskID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEnrollment

func (c *Client) CreateEnrollment(ctx context.Context, body CreateEnrollmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEnrollmentWithBody

func (c *Client) CreateEnrollmentWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteEnrollment

func (c *Client) DeleteEnrollment(ctx context.Context, id EnrollmentID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteWorkItem

func (c *Client) DeleteWorkItem(ctx context.Context, id WorkItemID, params *DeleteWorkItemParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeregisterAgent

func (c *Client) DeregisterAgent(ctx context.Context, id AgentID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DryRunCatalog

func (c *Client) DryRunCatalog(ctx context.Context, body DryRunCatalogJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DryRunCatalogWithBody

func (c *Client) DryRunCatalogWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCatalog

func (c *Client) GetCatalog(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCatalogFile

func (c *Client) GetCatalogFile(ctx context.Context, params *GetCatalogFileParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCatalogObject

func (c *Client) GetCatalogObject(ctx context.Context, kind CatalogKind, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetEnvironmentLog

func (c *Client) GetEnvironmentLog(ctx context.Context, id RunID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetMe

func (c *Client) GetMe(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRun

func (c *Client) GetRun(ctx context.Context, id RunID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTask

func (c *Client) GetTask(ctx context.Context, id TaskID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTaskContext

func (c *Client) GetTaskContext(ctx context.Context, id TaskID, n int, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTaskOutputSchema

func (c *Client) GetTaskOutputSchema(ctx context.Context, id TaskID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTaskPrompt

func (c *Client) GetTaskPrompt(ctx context.Context, id TaskID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTranscript

func (c *Client) GetTranscript(ctx context.Context, id RunID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetWorkItem

func (c *Client) GetWorkItem(ctx context.Context, id WorkItemID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) HeartbeatLease

func (c *Client) HeartbeatLease(ctx context.Context, id LeaseID, body HeartbeatLeaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) HeartbeatLeaseWithBody

func (c *Client) HeartbeatLeaseWithBody(ctx context.Context, id LeaseID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) LeaseTask

func (c *Client) LeaseTask(ctx context.Context, id AgentID, params *LeaseTaskParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListAgents

func (c *Client) ListAgents(ctx context.Context, params *ListAgentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListCatalogFiles

func (c *Client) ListCatalogFiles(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListEnrollments

func (c *Client) ListEnrollments(ctx context.Context, params *ListEnrollmentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListPools

func (c *Client) ListPools(ctx context.Context, params *ListPoolsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListProviders

func (c *Client) ListProviders(ctx context.Context, params *ListProvidersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListQueues

func (c *Client) ListQueues(ctx context.Context, params *ListQueuesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListTasks

func (c *Client) ListTasks(ctx context.Context, params *ListTasksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListWorkItems

func (c *Client) ListWorkItems(ctx context.Context, params *ListWorkItemsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Login

func (c *Client) Login(ctx context.Context, params *LoginParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Logout

func (c *Client) Logout(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostCommand

func (c *Client) PostCommand(ctx context.Context, body PostCommandJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostCommandWithBody

func (c *Client) PostCommandWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RegisterAgent

func (c *Client) RegisterAgent(ctx context.Context, body RegisterAgentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RegisterAgentWithBody

func (c *Client) RegisterAgentWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ReplayEvent

func (c *Client) ReplayEvent(ctx context.Context, id EventID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) StreamEvents

func (c *Client) StreamEvents(ctx context.Context, params *StreamEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAgent

func (c *Client) UpdateAgent(ctx context.Context, id AgentID, body UpdateAgentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAgentWithBody

func (c *Client) UpdateAgentWithBody(ctx context.Context, id AgentID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UploadEnvironmentLogWithBody

func (c *Client) UploadEnvironmentLogWithBody(ctx context.Context, id RunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UploadEnvironmentLogWithTextBody

func (c *Client) UploadEnvironmentLogWithTextBody(ctx context.Context, id RunID, body UploadEnvironmentLogTextRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UploadTranscriptWithBody

func (c *Client) UploadTranscriptWithBody(ctx context.Context, id RunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// ListAgents request
	ListAgents(ctx context.Context, params *ListAgentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RegisterAgentWithBody request with any body
	RegisterAgentWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	RegisterAgent(ctx context.Context, body RegisterAgentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeregisterAgent request
	DeregisterAgent(ctx context.Context, id AgentID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateAgentWithBody request with any body
	UpdateAgentWithBody(ctx context.Context, id AgentID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateAgent(ctx context.Context, id AgentID, body UpdateAgentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LeaseTask request
	LeaseTask(ctx context.Context, id AgentID, params *LeaseTaskParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AuthCallback request
	AuthCallback(ctx context.Context, params *AuthCallbackParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Login request
	Login(ctx context.Context, params *LoginParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Logout request
	Logout(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMe request
	GetMe(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCatalog request
	GetCatalog(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DryRunCatalogWithBody request with any body
	DryRunCatalogWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	DryRunCatalog(ctx context.Context, body DryRunCatalogJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCatalogFile request
	GetCatalogFile(ctx context.Context, params *GetCatalogFileParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListCatalogFiles request
	ListCatalogFiles(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCatalogObject request
	GetCatalogObject(ctx context.Context, kind CatalogKind, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostCommandWithBody request with any body
	PostCommandWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostCommand(ctx context.Context, body PostCommandJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListEnrollments request
	ListEnrollments(ctx context.Context, params *ListEnrollmentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateEnrollmentWithBody request with any body
	CreateEnrollmentWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateEnrollment(ctx context.Context, body CreateEnrollmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteEnrollment request
	DeleteEnrollment(ctx context.Context, id EnrollmentID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReplayEvent request
	ReplayEvent(ctx context.Context, id EventID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AbandonLeaseWithBody request with any body
	AbandonLeaseWithBody(ctx context.Context, id LeaseID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AbandonLease(ctx context.Context, id LeaseID, body AbandonLeaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CompleteLeaseWithBody request with any body
	CompleteLeaseWithBody(ctx context.Context, id LeaseID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CompleteLease(ctx context.Context, id LeaseID, body CompleteLeaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// HeartbeatLeaseWithBody request with any body
	HeartbeatLeaseWithBody(ctx context.Context, id LeaseID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	HeartbeatLease(ctx context.Context, id LeaseID, body HeartbeatLeaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListPools request
	ListPools(ctx context.Context, params *ListPoolsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListProviders request
	ListProviders(ctx context.Context, params *ListProvidersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListQueues request
	ListQueues(ctx context.Context, params *ListQueuesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRun request
	GetRun(ctx context.Context, id RunID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEnvironmentLog request
	GetEnvironmentLog(ctx context.Context, id RunID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UploadEnvironmentLogWithBody request with any body
	UploadEnvironmentLogWithBody(ctx context.Context, id RunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UploadEnvironmentLogWithTextBody(ctx context.Context, id RunID, body UploadEnvironmentLogTextRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTranscript request
	GetTranscript(ctx context.Context, id RunID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UploadTranscriptWithBody request with any body
	UploadTranscriptWithBody(ctx context.Context, id RunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// StreamEvents request
	StreamEvents(ctx context.Context, params *StreamEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListTasks request
	ListTasks(ctx context.Context, params *ListTasksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTask request
	GetTask(ctx context.Context, id TaskID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTaskContext request
	GetTaskContext(ctx context.Context, id TaskID, n int, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateEffectWithBody request with any body
	CreateEffectWithBody(ctx context.Context, id TaskID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateEffect(ctx context.Context, id TaskID, body CreateEffectJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTaskOutputSchema request
	GetTaskOutputSchema(ctx context.Context, id TaskID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTaskPrompt request
	GetTaskPrompt(ctx context.Context, id TaskID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListWorkItems request
	ListWorkItems(ctx context.Context, params *ListWorkItemsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteWorkItem request
	DeleteWorkItem(ctx context.Context, id WorkItemID, params *DeleteWorkItemParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetWorkItem request
	GetWorkItem(ctx context.Context, id WorkItemID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CloseWorkItemWithBody request with any body
	CloseWorkItemWithBody(ctx context.Context, id WorkItemID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CloseWorkItem(ctx context.Context, id WorkItemID, body CloseWorkItemJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) AbandonLeaseWithBodyWithResponse

func (c *ClientWithResponses) AbandonLeaseWithBodyWithResponse(ctx context.Context, id LeaseID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AbandonLeaseResponse, error)

AbandonLeaseWithBodyWithResponse request with arbitrary body returning *AbandonLeaseResponse

func (*ClientWithResponses) AbandonLeaseWithResponse

func (c *ClientWithResponses) AbandonLeaseWithResponse(ctx context.Context, id LeaseID, body AbandonLeaseJSONRequestBody, reqEditors ...RequestEditorFn) (*AbandonLeaseResponse, error)

func (*ClientWithResponses) AuthCallbackWithResponse

func (c *ClientWithResponses) AuthCallbackWithResponse(ctx context.Context, params *AuthCallbackParams, reqEditors ...RequestEditorFn) (*AuthCallbackResponse, error)

AuthCallbackWithResponse request returning *AuthCallbackResponse

func (*ClientWithResponses) CloseWorkItemWithBodyWithResponse

func (c *ClientWithResponses) CloseWorkItemWithBodyWithResponse(ctx context.Context, id WorkItemID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CloseWorkItemResponse, error)

CloseWorkItemWithBodyWithResponse request with arbitrary body returning *CloseWorkItemResponse

func (*ClientWithResponses) CloseWorkItemWithResponse

func (c *ClientWithResponses) CloseWorkItemWithResponse(ctx context.Context, id WorkItemID, body CloseWorkItemJSONRequestBody, reqEditors ...RequestEditorFn) (*CloseWorkItemResponse, error)

func (*ClientWithResponses) CompleteLeaseWithBodyWithResponse

func (c *ClientWithResponses) CompleteLeaseWithBodyWithResponse(ctx context.Context, id LeaseID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CompleteLeaseResponse, error)

CompleteLeaseWithBodyWithResponse request with arbitrary body returning *CompleteLeaseResponse

func (*ClientWithResponses) CompleteLeaseWithResponse

func (c *ClientWithResponses) CompleteLeaseWithResponse(ctx context.Context, id LeaseID, body CompleteLeaseJSONRequestBody, reqEditors ...RequestEditorFn) (*CompleteLeaseResponse, error)

func (*ClientWithResponses) CreateEffectWithBodyWithResponse

func (c *ClientWithResponses) CreateEffectWithBodyWithResponse(ctx context.Context, id TaskID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEffectResponse, error)

CreateEffectWithBodyWithResponse request with arbitrary body returning *CreateEffectResponse

func (*ClientWithResponses) CreateEffectWithResponse

func (c *ClientWithResponses) CreateEffectWithResponse(ctx context.Context, id TaskID, body CreateEffectJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEffectResponse, error)

func (*ClientWithResponses) CreateEnrollmentWithBodyWithResponse

func (c *ClientWithResponses) CreateEnrollmentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEnrollmentResponse, error)

CreateEnrollmentWithBodyWithResponse request with arbitrary body returning *CreateEnrollmentResponse

func (*ClientWithResponses) CreateEnrollmentWithResponse

func (c *ClientWithResponses) CreateEnrollmentWithResponse(ctx context.Context, body CreateEnrollmentJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEnrollmentResponse, error)

func (*ClientWithResponses) DeleteEnrollmentWithResponse

func (c *ClientWithResponses) DeleteEnrollmentWithResponse(ctx context.Context, id EnrollmentID, reqEditors ...RequestEditorFn) (*DeleteEnrollmentResponse, error)

DeleteEnrollmentWithResponse request returning *DeleteEnrollmentResponse

func (*ClientWithResponses) DeleteWorkItemWithResponse

func (c *ClientWithResponses) DeleteWorkItemWithResponse(ctx context.Context, id WorkItemID, params *DeleteWorkItemParams, reqEditors ...RequestEditorFn) (*DeleteWorkItemResponse, error)

DeleteWorkItemWithResponse request returning *DeleteWorkItemResponse

func (*ClientWithResponses) DeregisterAgentWithResponse

func (c *ClientWithResponses) DeregisterAgentWithResponse(ctx context.Context, id AgentID, reqEditors ...RequestEditorFn) (*DeregisterAgentResponse, error)

DeregisterAgentWithResponse request returning *DeregisterAgentResponse

func (*ClientWithResponses) DryRunCatalogWithBodyWithResponse

func (c *ClientWithResponses) DryRunCatalogWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DryRunCatalogResponse, error)

DryRunCatalogWithBodyWithResponse request with arbitrary body returning *DryRunCatalogResponse

func (*ClientWithResponses) DryRunCatalogWithResponse

func (c *ClientWithResponses) DryRunCatalogWithResponse(ctx context.Context, body DryRunCatalogJSONRequestBody, reqEditors ...RequestEditorFn) (*DryRunCatalogResponse, error)

func (*ClientWithResponses) GetCatalogFileWithResponse

func (c *ClientWithResponses) GetCatalogFileWithResponse(ctx context.Context, params *GetCatalogFileParams, reqEditors ...RequestEditorFn) (*GetCatalogFileResponse, error)

GetCatalogFileWithResponse request returning *GetCatalogFileResponse

func (*ClientWithResponses) GetCatalogObjectWithResponse

func (c *ClientWithResponses) GetCatalogObjectWithResponse(ctx context.Context, kind CatalogKind, name string, reqEditors ...RequestEditorFn) (*GetCatalogObjectResponse, error)

GetCatalogObjectWithResponse request returning *GetCatalogObjectResponse

func (*ClientWithResponses) GetCatalogWithResponse

func (c *ClientWithResponses) GetCatalogWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCatalogResponse, error)

GetCatalogWithResponse request returning *GetCatalogResponse

func (*ClientWithResponses) GetEnvironmentLogWithResponse

func (c *ClientWithResponses) GetEnvironmentLogWithResponse(ctx context.Context, id RunID, reqEditors ...RequestEditorFn) (*GetEnvironmentLogResponse, error)

GetEnvironmentLogWithResponse request returning *GetEnvironmentLogResponse

func (*ClientWithResponses) GetMeWithResponse

func (c *ClientWithResponses) GetMeWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMeResponse, error)

GetMeWithResponse request returning *GetMeResponse

func (*ClientWithResponses) GetRunWithResponse

func (c *ClientWithResponses) GetRunWithResponse(ctx context.Context, id RunID, reqEditors ...RequestEditorFn) (*GetRunResponse, error)

GetRunWithResponse request returning *GetRunResponse

func (*ClientWithResponses) GetTaskContextWithResponse

func (c *ClientWithResponses) GetTaskContextWithResponse(ctx context.Context, id TaskID, n int, reqEditors ...RequestEditorFn) (*GetTaskContextResponse, error)

GetTaskContextWithResponse request returning *GetTaskContextResponse

func (*ClientWithResponses) GetTaskOutputSchemaWithResponse

func (c *ClientWithResponses) GetTaskOutputSchemaWithResponse(ctx context.Context, id TaskID, reqEditors ...RequestEditorFn) (*GetTaskOutputSchemaResponse, error)

GetTaskOutputSchemaWithResponse request returning *GetTaskOutputSchemaResponse

func (*ClientWithResponses) GetTaskPromptWithResponse

func (c *ClientWithResponses) GetTaskPromptWithResponse(ctx context.Context, id TaskID, reqEditors ...RequestEditorFn) (*GetTaskPromptResponse, error)

GetTaskPromptWithResponse request returning *GetTaskPromptResponse

func (*ClientWithResponses) GetTaskWithResponse

func (c *ClientWithResponses) GetTaskWithResponse(ctx context.Context, id TaskID, reqEditors ...RequestEditorFn) (*GetTaskResponse, error)

GetTaskWithResponse request returning *GetTaskResponse

func (*ClientWithResponses) GetTranscriptWithResponse

func (c *ClientWithResponses) GetTranscriptWithResponse(ctx context.Context, id RunID, reqEditors ...RequestEditorFn) (*GetTranscriptResponse, error)

GetTranscriptWithResponse request returning *GetTranscriptResponse

func (*ClientWithResponses) GetWorkItemWithResponse

func (c *ClientWithResponses) GetWorkItemWithResponse(ctx context.Context, id WorkItemID, reqEditors ...RequestEditorFn) (*GetWorkItemResponse, error)

GetWorkItemWithResponse request returning *GetWorkItemResponse

func (*ClientWithResponses) HeartbeatLeaseWithBodyWithResponse

func (c *ClientWithResponses) HeartbeatLeaseWithBodyWithResponse(ctx context.Context, id LeaseID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*HeartbeatLeaseResponse, error)

HeartbeatLeaseWithBodyWithResponse request with arbitrary body returning *HeartbeatLeaseResponse

func (*ClientWithResponses) HeartbeatLeaseWithResponse

func (c *ClientWithResponses) HeartbeatLeaseWithResponse(ctx context.Context, id LeaseID, body HeartbeatLeaseJSONRequestBody, reqEditors ...RequestEditorFn) (*HeartbeatLeaseResponse, error)

func (*ClientWithResponses) LeaseTaskWithResponse

func (c *ClientWithResponses) LeaseTaskWithResponse(ctx context.Context, id AgentID, params *LeaseTaskParams, reqEditors ...RequestEditorFn) (*LeaseTaskResponse, error)

LeaseTaskWithResponse request returning *LeaseTaskResponse

func (*ClientWithResponses) ListAgentsWithResponse

func (c *ClientWithResponses) ListAgentsWithResponse(ctx context.Context, params *ListAgentsParams, reqEditors ...RequestEditorFn) (*ListAgentsResponse, error)

ListAgentsWithResponse request returning *ListAgentsResponse

func (*ClientWithResponses) ListCatalogFilesWithResponse

func (c *ClientWithResponses) ListCatalogFilesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListCatalogFilesResponse, error)

ListCatalogFilesWithResponse request returning *ListCatalogFilesResponse

func (*ClientWithResponses) ListEnrollmentsWithResponse

func (c *ClientWithResponses) ListEnrollmentsWithResponse(ctx context.Context, params *ListEnrollmentsParams, reqEditors ...RequestEditorFn) (*ListEnrollmentsResponse, error)

ListEnrollmentsWithResponse request returning *ListEnrollmentsResponse

func (*ClientWithResponses) ListPoolsWithResponse

func (c *ClientWithResponses) ListPoolsWithResponse(ctx context.Context, params *ListPoolsParams, reqEditors ...RequestEditorFn) (*ListPoolsResponse, error)

ListPoolsWithResponse request returning *ListPoolsResponse

func (*ClientWithResponses) ListProvidersWithResponse

func (c *ClientWithResponses) ListProvidersWithResponse(ctx context.Context, params *ListProvidersParams, reqEditors ...RequestEditorFn) (*ListProvidersResponse, error)

ListProvidersWithResponse request returning *ListProvidersResponse

func (*ClientWithResponses) ListQueuesWithResponse

func (c *ClientWithResponses) ListQueuesWithResponse(ctx context.Context, params *ListQueuesParams, reqEditors ...RequestEditorFn) (*ListQueuesResponse, error)

ListQueuesWithResponse request returning *ListQueuesResponse

func (*ClientWithResponses) ListTasksWithResponse

func (c *ClientWithResponses) ListTasksWithResponse(ctx context.Context, params *ListTasksParams, reqEditors ...RequestEditorFn) (*ListTasksResponse, error)

ListTasksWithResponse request returning *ListTasksResponse

func (*ClientWithResponses) ListWorkItemsWithResponse

func (c *ClientWithResponses) ListWorkItemsWithResponse(ctx context.Context, params *ListWorkItemsParams, reqEditors ...RequestEditorFn) (*ListWorkItemsResponse, error)

ListWorkItemsWithResponse request returning *ListWorkItemsResponse

func (*ClientWithResponses) LoginWithResponse

func (c *ClientWithResponses) LoginWithResponse(ctx context.Context, params *LoginParams, reqEditors ...RequestEditorFn) (*LoginResponse, error)

LoginWithResponse request returning *LoginResponse

func (*ClientWithResponses) LogoutWithResponse

func (c *ClientWithResponses) LogoutWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*LogoutResponse, error)

LogoutWithResponse request returning *LogoutResponse

func (*ClientWithResponses) PostCommandWithBodyWithResponse

func (c *ClientWithResponses) PostCommandWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostCommandResponse, error)

PostCommandWithBodyWithResponse request with arbitrary body returning *PostCommandResponse

func (*ClientWithResponses) PostCommandWithResponse

func (c *ClientWithResponses) PostCommandWithResponse(ctx context.Context, body PostCommandJSONRequestBody, reqEditors ...RequestEditorFn) (*PostCommandResponse, error)

func (*ClientWithResponses) RegisterAgentWithBodyWithResponse

func (c *ClientWithResponses) RegisterAgentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterAgentResponse, error)

RegisterAgentWithBodyWithResponse request with arbitrary body returning *RegisterAgentResponse

func (*ClientWithResponses) RegisterAgentWithResponse

func (c *ClientWithResponses) RegisterAgentWithResponse(ctx context.Context, body RegisterAgentJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterAgentResponse, error)

func (*ClientWithResponses) ReplayEventWithResponse

func (c *ClientWithResponses) ReplayEventWithResponse(ctx context.Context, id EventID, reqEditors ...RequestEditorFn) (*ReplayEventResponse, error)

ReplayEventWithResponse request returning *ReplayEventResponse

func (*ClientWithResponses) StreamEventsWithResponse

func (c *ClientWithResponses) StreamEventsWithResponse(ctx context.Context, params *StreamEventsParams, reqEditors ...RequestEditorFn) (*StreamEventsResponse, error)

StreamEventsWithResponse request returning *StreamEventsResponse

func (*ClientWithResponses) UpdateAgentWithBodyWithResponse

func (c *ClientWithResponses) UpdateAgentWithBodyWithResponse(ctx context.Context, id AgentID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAgentResponse, error)

UpdateAgentWithBodyWithResponse request with arbitrary body returning *UpdateAgentResponse

func (*ClientWithResponses) UpdateAgentWithResponse

func (c *ClientWithResponses) UpdateAgentWithResponse(ctx context.Context, id AgentID, body UpdateAgentJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAgentResponse, error)

func (*ClientWithResponses) UploadEnvironmentLogWithBodyWithResponse

func (c *ClientWithResponses) UploadEnvironmentLogWithBodyWithResponse(ctx context.Context, id RunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadEnvironmentLogResponse, error)

UploadEnvironmentLogWithBodyWithResponse request with arbitrary body returning *UploadEnvironmentLogResponse

func (*ClientWithResponses) UploadEnvironmentLogWithTextBodyWithResponse

func (c *ClientWithResponses) UploadEnvironmentLogWithTextBodyWithResponse(ctx context.Context, id RunID, body UploadEnvironmentLogTextRequestBody, reqEditors ...RequestEditorFn) (*UploadEnvironmentLogResponse, error)

func (*ClientWithResponses) UploadTranscriptWithBodyWithResponse

func (c *ClientWithResponses) UploadTranscriptWithBodyWithResponse(ctx context.Context, id RunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadTranscriptResponse, error)

UploadTranscriptWithBodyWithResponse request with arbitrary body returning *UploadTranscriptResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// ListAgentsWithResponse request
	ListAgentsWithResponse(ctx context.Context, params *ListAgentsParams, reqEditors ...RequestEditorFn) (*ListAgentsResponse, error)

	// RegisterAgentWithBodyWithResponse request with any body
	RegisterAgentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterAgentResponse, error)

	RegisterAgentWithResponse(ctx context.Context, body RegisterAgentJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterAgentResponse, error)

	// DeregisterAgentWithResponse request
	DeregisterAgentWithResponse(ctx context.Context, id AgentID, reqEditors ...RequestEditorFn) (*DeregisterAgentResponse, error)

	// UpdateAgentWithBodyWithResponse request with any body
	UpdateAgentWithBodyWithResponse(ctx context.Context, id AgentID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAgentResponse, error)

	UpdateAgentWithResponse(ctx context.Context, id AgentID, body UpdateAgentJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAgentResponse, error)

	// LeaseTaskWithResponse request
	LeaseTaskWithResponse(ctx context.Context, id AgentID, params *LeaseTaskParams, reqEditors ...RequestEditorFn) (*LeaseTaskResponse, error)

	// AuthCallbackWithResponse request
	AuthCallbackWithResponse(ctx context.Context, params *AuthCallbackParams, reqEditors ...RequestEditorFn) (*AuthCallbackResponse, error)

	// LoginWithResponse request
	LoginWithResponse(ctx context.Context, params *LoginParams, reqEditors ...RequestEditorFn) (*LoginResponse, error)

	// LogoutWithResponse request
	LogoutWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*LogoutResponse, error)

	// GetMeWithResponse request
	GetMeWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMeResponse, error)

	// GetCatalogWithResponse request
	GetCatalogWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCatalogResponse, error)

	// DryRunCatalogWithBodyWithResponse request with any body
	DryRunCatalogWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DryRunCatalogResponse, error)

	DryRunCatalogWithResponse(ctx context.Context, body DryRunCatalogJSONRequestBody, reqEditors ...RequestEditorFn) (*DryRunCatalogResponse, error)

	// GetCatalogFileWithResponse request
	GetCatalogFileWithResponse(ctx context.Context, params *GetCatalogFileParams, reqEditors ...RequestEditorFn) (*GetCatalogFileResponse, error)

	// ListCatalogFilesWithResponse request
	ListCatalogFilesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListCatalogFilesResponse, error)

	// GetCatalogObjectWithResponse request
	GetCatalogObjectWithResponse(ctx context.Context, kind CatalogKind, name string, reqEditors ...RequestEditorFn) (*GetCatalogObjectResponse, error)

	// PostCommandWithBodyWithResponse request with any body
	PostCommandWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostCommandResponse, error)

	PostCommandWithResponse(ctx context.Context, body PostCommandJSONRequestBody, reqEditors ...RequestEditorFn) (*PostCommandResponse, error)

	// ListEnrollmentsWithResponse request
	ListEnrollmentsWithResponse(ctx context.Context, params *ListEnrollmentsParams, reqEditors ...RequestEditorFn) (*ListEnrollmentsResponse, error)

	// CreateEnrollmentWithBodyWithResponse request with any body
	CreateEnrollmentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEnrollmentResponse, error)

	CreateEnrollmentWithResponse(ctx context.Context, body CreateEnrollmentJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEnrollmentResponse, error)

	// DeleteEnrollmentWithResponse request
	DeleteEnrollmentWithResponse(ctx context.Context, id EnrollmentID, reqEditors ...RequestEditorFn) (*DeleteEnrollmentResponse, error)

	// ReplayEventWithResponse request
	ReplayEventWithResponse(ctx context.Context, id EventID, reqEditors ...RequestEditorFn) (*ReplayEventResponse, error)

	// AbandonLeaseWithBodyWithResponse request with any body
	AbandonLeaseWithBodyWithResponse(ctx context.Context, id LeaseID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AbandonLeaseResponse, error)

	AbandonLeaseWithResponse(ctx context.Context, id LeaseID, body AbandonLeaseJSONRequestBody, reqEditors ...RequestEditorFn) (*AbandonLeaseResponse, error)

	// CompleteLeaseWithBodyWithResponse request with any body
	CompleteLeaseWithBodyWithResponse(ctx context.Context, id LeaseID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CompleteLeaseResponse, error)

	CompleteLeaseWithResponse(ctx context.Context, id LeaseID, body CompleteLeaseJSONRequestBody, reqEditors ...RequestEditorFn) (*CompleteLeaseResponse, error)

	// HeartbeatLeaseWithBodyWithResponse request with any body
	HeartbeatLeaseWithBodyWithResponse(ctx context.Context, id LeaseID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*HeartbeatLeaseResponse, error)

	HeartbeatLeaseWithResponse(ctx context.Context, id LeaseID, body HeartbeatLeaseJSONRequestBody, reqEditors ...RequestEditorFn) (*HeartbeatLeaseResponse, error)

	// ListPoolsWithResponse request
	ListPoolsWithResponse(ctx context.Context, params *ListPoolsParams, reqEditors ...RequestEditorFn) (*ListPoolsResponse, error)

	// ListProvidersWithResponse request
	ListProvidersWithResponse(ctx context.Context, params *ListProvidersParams, reqEditors ...RequestEditorFn) (*ListProvidersResponse, error)

	// ListQueuesWithResponse request
	ListQueuesWithResponse(ctx context.Context, params *ListQueuesParams, reqEditors ...RequestEditorFn) (*ListQueuesResponse, error)

	// GetRunWithResponse request
	GetRunWithResponse(ctx context.Context, id RunID, reqEditors ...RequestEditorFn) (*GetRunResponse, error)

	// GetEnvironmentLogWithResponse request
	GetEnvironmentLogWithResponse(ctx context.Context, id RunID, reqEditors ...RequestEditorFn) (*GetEnvironmentLogResponse, error)

	// UploadEnvironmentLogWithBodyWithResponse request with any body
	UploadEnvironmentLogWithBodyWithResponse(ctx context.Context, id RunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadEnvironmentLogResponse, error)

	UploadEnvironmentLogWithTextBodyWithResponse(ctx context.Context, id RunID, body UploadEnvironmentLogTextRequestBody, reqEditors ...RequestEditorFn) (*UploadEnvironmentLogResponse, error)

	// GetTranscriptWithResponse request
	GetTranscriptWithResponse(ctx context.Context, id RunID, reqEditors ...RequestEditorFn) (*GetTranscriptResponse, error)

	// UploadTranscriptWithBodyWithResponse request with any body
	UploadTranscriptWithBodyWithResponse(ctx context.Context, id RunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadTranscriptResponse, error)

	// StreamEventsWithResponse request
	StreamEventsWithResponse(ctx context.Context, params *StreamEventsParams, reqEditors ...RequestEditorFn) (*StreamEventsResponse, error)

	// ListTasksWithResponse request
	ListTasksWithResponse(ctx context.Context, params *ListTasksParams, reqEditors ...RequestEditorFn) (*ListTasksResponse, error)

	// GetTaskWithResponse request
	GetTaskWithResponse(ctx context.Context, id TaskID, reqEditors ...RequestEditorFn) (*GetTaskResponse, error)

	// GetTaskContextWithResponse request
	GetTaskContextWithResponse(ctx context.Context, id TaskID, n int, reqEditors ...RequestEditorFn) (*GetTaskContextResponse, error)

	// CreateEffectWithBodyWithResponse request with any body
	CreateEffectWithBodyWithResponse(ctx context.Context, id TaskID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEffectResponse, error)

	CreateEffectWithResponse(ctx context.Context, id TaskID, body CreateEffectJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEffectResponse, error)

	// GetTaskOutputSchemaWithResponse request
	GetTaskOutputSchemaWithResponse(ctx context.Context, id TaskID, reqEditors ...RequestEditorFn) (*GetTaskOutputSchemaResponse, error)

	// GetTaskPromptWithResponse request
	GetTaskPromptWithResponse(ctx context.Context, id TaskID, reqEditors ...RequestEditorFn) (*GetTaskPromptResponse, error)

	// ListWorkItemsWithResponse request
	ListWorkItemsWithResponse(ctx context.Context, params *ListWorkItemsParams, reqEditors ...RequestEditorFn) (*ListWorkItemsResponse, error)

	// DeleteWorkItemWithResponse request
	DeleteWorkItemWithResponse(ctx context.Context, id WorkItemID, params *DeleteWorkItemParams, reqEditors ...RequestEditorFn) (*DeleteWorkItemResponse, error)

	// GetWorkItemWithResponse request
	GetWorkItemWithResponse(ctx context.Context, id WorkItemID, reqEditors ...RequestEditorFn) (*GetWorkItemResponse, error)

	// CloseWorkItemWithBodyWithResponse request with any body
	CloseWorkItemWithBodyWithResponse(ctx context.Context, id WorkItemID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CloseWorkItemResponse, error)

	CloseWorkItemWithResponse(ctx context.Context, id WorkItemID, body CloseWorkItemJSONRequestBody, reqEditors ...RequestEditorFn) (*CloseWorkItemResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CloseWorkItemJSONRequestBody

type CloseWorkItemJSONRequestBody = CloseWorkItemRequest

CloseWorkItemJSONRequestBody defines body for CloseWorkItem for application/json ContentType.

type CloseWorkItemRequest

type CloseWorkItemRequest struct {
	Note   *string                    `json:"note,omitempty"`
	Reason CloseWorkItemRequestReason `json:"reason"`
}

CloseWorkItemRequest Why a work item is closed.

type CloseWorkItemRequestReason

type CloseWorkItemRequestReason string

CloseWorkItemRequestReason defines model for CloseWorkItemRequest.Reason.

const (
	CloseWorkItemRequestReasonDone      CloseWorkItemRequestReason = "done"
	CloseWorkItemRequestReasonDuplicate CloseWorkItemRequestReason = "duplicate"
	CloseWorkItemRequestReasonWontDo    CloseWorkItemRequestReason = "wont-do"
)

Defines values for CloseWorkItemRequestReason.

func (CloseWorkItemRequestReason) Valid

func (e CloseWorkItemRequestReason) Valid() bool

Valid indicates whether the value is a known member of the CloseWorkItemRequestReason enum.

type CloseWorkItemResponse

type CloseWorkItemResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *WorkItem
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseCloseWorkItemResponse

func ParseCloseWorkItemResponse(rsp *http.Response) (*CloseWorkItemResponse, error)

ParseCloseWorkItemResponse parses an HTTP response from a CloseWorkItemWithResponse call

func (CloseWorkItemResponse) ContentType

func (r CloseWorkItemResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CloseWorkItemResponse) Status

func (r CloseWorkItemResponse) Status() string

Status returns HTTPResponse.Status

func (CloseWorkItemResponse) StatusCode

func (r CloseWorkItemResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Command

type Command struct {
	// Args `{harness}` for redispatch; `{event}` for dispatch.
	Args *CommandArgs `json:"args,omitempty"`

	// Target `{scope, name}` for pause/resume; `{task}` for cancel/redispatch.
	Target *CommandTarget `json:"target,omitempty"`
	Type   CommandType    `json:"type"`
}

Command An operator command (api-server.md §Commands).

type CommandAccepted

type CommandAccepted struct {
	// Event The id of the `factory.command.*` or injected event.
	Event *string `json:"event,omitempty"`
	Type  string  `json:"type"`
}

CommandAccepted The accepted command and the event it became, if any.

type CommandArgs

type CommandArgs struct {
	// Event Event is a normalised provider event, shaped as a CloudEvent: its identity is (Source = provider instance or "factory", Type).
	Event *Event `json:"event,omitempty"`

	// Harness HarnessRequest asks for a harness and config.
	Harness *HarnessRequest `json:"harness,omitempty"`
}

CommandArgs `{harness}` for redispatch; `{event}` for dispatch.

type CommandTarget

type CommandTarget struct {
	Name  *string             `json:"name,omitempty"`
	Scope *CommandTargetScope `json:"scope,omitempty"`
	Task  *string             `json:"task,omitempty"`
}

CommandTarget `{scope, name}` for pause/resume; `{task}` for cancel/redispatch.

type CommandTargetScope

type CommandTargetScope string

CommandTargetScope defines model for CommandTarget.Scope.

const (
	CommandTargetScopeGlobal   CommandTargetScope = "global"
	CommandTargetScopeProvider CommandTargetScope = "provider"
	CommandTargetScopeQueue    CommandTargetScope = "queue"
	CommandTargetScopeWorkitem CommandTargetScope = "workitem"
)

Defines values for CommandTargetScope.

func (CommandTargetScope) Valid

func (e CommandTargetScope) Valid() bool

Valid indicates whether the value is a known member of the CommandTargetScope enum.

type CommandType

type CommandType string

CommandType defines model for Command.Type.

const (
	CommandTypeCancel        CommandType = "cancel"
	CommandTypeDispatch      CommandType = "dispatch"
	CommandTypePause         CommandType = "pause"
	CommandTypeRedispatch    CommandType = "redispatch"
	CommandTypeResume        CommandType = "resume"
	CommandTypeResyncCatalog CommandType = "resync-catalog"
)

Defines values for CommandType.

func (CommandType) Valid

func (e CommandType) Valid() bool

Valid indicates whether the value is a known member of the CommandType enum.

type CompleteLeaseJSONRequestBody

type CompleteLeaseJSONRequestBody = CompleteRequest

CompleteLeaseJSONRequestBody defines body for CompleteLease for application/json ContentType.

type CompleteLeaseResponse

type CompleteLeaseResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON409     *Conflict
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseCompleteLeaseResponse

func ParseCompleteLeaseResponse(rsp *http.Response) (*CompleteLeaseResponse, error)

ParseCompleteLeaseResponse parses an HTTP response from a CompleteLeaseWithResponse call

func (CompleteLeaseResponse) ContentType

func (r CompleteLeaseResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CompleteLeaseResponse) Status

func (r CompleteLeaseResponse) Status() string

Status returns HTTPResponse.Status

func (CompleteLeaseResponse) StatusCode

func (r CompleteLeaseResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CompleteRequest

type CompleteRequest struct {
	// Result Result is what an agent reports when a run completes.
	Result Result `json:"result"`

	// TranscriptRef From `uploadTranscript`.
	TranscriptRef *string `json:"transcriptRef,omitempty"`
}

CompleteRequest The run's Result and its transcript.

type Conflict

type Conflict = Problem

Conflict An RFC 9457 problem detail.

type ContextItem

type ContextItem = v1alpha1.ContextItem

ContextItem ContextItem is something the agent is given, with its trust label.

type CreateEffectJSONRequestBody

type CreateEffectJSONRequestBody = EffectRequest

CreateEffectJSONRequestBody defines body for CreateEffect for application/json ContentType.

type CreateEffectResponse

type CreateEffectResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *EffectResponse
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON429     *TooManyRequests
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseCreateEffectResponse

func ParseCreateEffectResponse(rsp *http.Response) (*CreateEffectResponse, error)

ParseCreateEffectResponse parses an HTTP response from a CreateEffectWithResponse call

func (CreateEffectResponse) ContentType

func (r CreateEffectResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateEffectResponse) Status

func (r CreateEffectResponse) Status() string

Status returns HTTPResponse.Status

func (CreateEffectResponse) StatusCode

func (r CreateEffectResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateEnrollmentJSONRequestBody

type CreateEnrollmentJSONRequestBody = EnrollmentRequest

CreateEnrollmentJSONRequestBody defines body for CreateEnrollment for application/json ContentType.

type CreateEnrollmentResponse

type CreateEnrollmentResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON201                       *EnrollmentCreated
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseCreateEnrollmentResponse

func ParseCreateEnrollmentResponse(rsp *http.Response) (*CreateEnrollmentResponse, error)

ParseCreateEnrollmentResponse parses an HTTP response from a CreateEnrollmentWithResponse call

func (CreateEnrollmentResponse) ContentType

func (r CreateEnrollmentResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateEnrollmentResponse) Status

func (r CreateEnrollmentResponse) Status() string

Status returns HTTPResponse.Status

func (CreateEnrollmentResponse) StatusCode

func (r CreateEnrollmentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Cursor

type Cursor = string

Cursor defines model for Cursor.

type Debounce

type Debounce = v1alpha1.Debounce

Debounce Debounce collapses bursts of events into one action.

type Decision

type Decision = v1alpha1.Decision

Decision Decision records why a rule did (or didn't) act: the UI's "why did this happen?".

type DeleteEnrollmentResponse

type DeleteEnrollmentResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseDeleteEnrollmentResponse

func ParseDeleteEnrollmentResponse(rsp *http.Response) (*DeleteEnrollmentResponse, error)

ParseDeleteEnrollmentResponse parses an HTTP response from a DeleteEnrollmentWithResponse call

func (DeleteEnrollmentResponse) ContentType

func (r DeleteEnrollmentResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteEnrollmentResponse) Status

func (r DeleteEnrollmentResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteEnrollmentResponse) StatusCode

func (r DeleteEnrollmentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteWorkItemParams

type DeleteWorkItemParams struct {
	// Force Cancel the active tasks and delete even while one is leased.
	Force *bool `form:"force,omitempty" json:"force,omitempty"`
}

DeleteWorkItemParams defines parameters for DeleteWorkItem.

type DeleteWorkItemResponse

type DeleteWorkItemResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *WorkItemDeleted
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON409     *Conflict
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseDeleteWorkItemResponse

func ParseDeleteWorkItemResponse(rsp *http.Response) (*DeleteWorkItemResponse, error)

ParseDeleteWorkItemResponse parses an HTTP response from a DeleteWorkItemWithResponse call

func (DeleteWorkItemResponse) ContentType

func (r DeleteWorkItemResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteWorkItemResponse) Status

func (r DeleteWorkItemResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteWorkItemResponse) StatusCode

func (r DeleteWorkItemResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeregisterAgentResponse

type DeregisterAgentResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseDeregisterAgentResponse

func ParseDeregisterAgentResponse(rsp *http.Response) (*DeregisterAgentResponse, error)

ParseDeregisterAgentResponse parses an HTTP response from a DeregisterAgentWithResponse call

func (DeregisterAgentResponse) ContentType

func (r DeregisterAgentResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeregisterAgentResponse) Status

func (r DeregisterAgentResponse) Status() string

Status returns HTTPResponse.Status

func (DeregisterAgentResponse) StatusCode

func (r DeregisterAgentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Destination

type Destination = v1alpha1.Destination

Destination Destination is one recipient of a notification.

type DispatchAction

type DispatchAction = v1alpha1.DispatchAction

DispatchAction DispatchAction creates a Task (Pending) in a queue.

type DryRunCatalogJSONRequestBody

type DryRunCatalogJSONRequestBody = DryRunRequest

DryRunCatalogJSONRequestBody defines body for DryRunCatalog for application/json ContentType.

type DryRunCatalogResponse

type DryRunCatalogResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *Evaluation
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSONDefault *Error
}

func ParseDryRunCatalogResponse

func ParseDryRunCatalogResponse(rsp *http.Response) (*DryRunCatalogResponse, error)

ParseDryRunCatalogResponse parses an HTTP response from a DryRunCatalogWithResponse call

func (DryRunCatalogResponse) ContentType

func (r DryRunCatalogResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DryRunCatalogResponse) Status

func (r DryRunCatalogResponse) Status() string

Status returns HTTPResponse.Status

func (DryRunCatalogResponse) StatusCode

func (r DryRunCatalogResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DryRunRequest

type DryRunRequest struct {
	// Event Event is a normalised provider event, shaped as a CloudEvent: its identity is (Source = provider instance or "factory", Type).
	Event Event `json:"event"`

	// WorkItem Evaluate against this work item's state; an empty one when absent.
	WorkItem *string `json:"workItem,omitempty"`
}

DryRunRequest An event to evaluate, optionally against an existing work item.

type Duration

type Duration = v1alpha1.Duration

Duration A Go duration ("90s", "15m", "1h30m"), optionally prefixed by whole days ("7d", "1d12h").

type Effect

type Effect = v1alpha1.Effect

Effect Effect is an audit record of one provider write.

type EffectAction

type EffectAction = v1alpha1.EffectAction

EffectAction A direct provider effect: op, an optional target, and the op-specific fields inline (e.g. labels for label.add). The catalog loader checks those fields per op.

type EffectOp

type EffectOp = v1alpha1.EffectOp

EffectOp EffectOp is a provider effect, as named in TaskSpec effects.allow and the effect action.

type EffectRequest

type EffectRequest struct {
	// Args Op-specific arguments (`body`, `labels`, `title`, `ref`, `sha`, …).
	Args map[string]interface{} `json:"args,omitempty"`

	// IdempotencyKey `<taskID>/<op>/<seq>`, or a skill-chosen key. A repeated key replays the stored effect.
	IdempotencyKey string `json:"idempotencyKey"`

	// Op EffectOp is a provider effect, as named in TaskSpec effects.allow and the effect action.
	Op EffectOp `json:"op"`

	// Target The object to act on; defaults to the task's primary object.
	Target *string `json:"target,omitempty"`
}

EffectRequest One effect. The dispatcher maps the catalog's inline effect fields to `args`.

type EffectResponse

type EffectResponse struct {
	EffectId string  `json:"effectId"`
	Url      *string `json:"url,omitempty"`
}

EffectResponse The stored effect and, for API ops, the URL of what it made.

type EffectResult

type EffectResult = v1alpha1.EffectResult

EffectResult EffectResult is the outcome of an effect.

type EffectSpec

type EffectSpec = v1alpha1.EffectSpec

EffectSpec EffectSpec is what was asked.

type EffectStatus

type EffectStatus = v1alpha1.EffectStatus

EffectStatus EffectStatus is what happened.

type EffectiveConfig

type EffectiveConfig = v1alpha1.EffectiveConfig

EffectiveConfig EffectiveConfig is the exact config the harness ran with.

type EffectsPolicy

type EffectsPolicy = v1alpha1.EffectsPolicy

EffectsPolicy EffectsPolicy is what a task may do.

type EgressPolicy

type EgressPolicy = v1alpha1.EgressPolicy

EgressPolicy EgressPolicy narrows a workspace's network.

type Enrollment

type Enrollment struct {
	// Agent The agent the token registered (`agt_<owner>-<name>`); null while unused.
	Agent     *string   `json:"agent"`
	CreatedAt time.Time `json:"createdAt"`

	// CreatedBy The admin who minted it, as an actor id (`<provider>:<login>`, or `factory:cli` for the CLI token).
	CreatedBy string `json:"createdBy"`

	// ExpiresAt After this the token no longer registers an agent.
	ExpiresAt time.Time `json:"expiresAt"`

	// Id The enrollment's id, `enl_` and a lowercase ULID.
	Id string `json:"id"`

	// Name The agent host's name.
	Name string `json:"name"`

	// Owner The GitHub login of the agent's owner.
	Owner string `json:"owner"`

	// Pool The Pool the agent joins.
	Pool string `json:"pool"`

	// UsedAt When the token registered the agent; null while unused.
	UsedAt *time.Time `json:"usedAt"`
}

Enrollment An enrollment, without its token or the token's hash.

type EnrollmentCreated

type EnrollmentCreated struct {
	// Enrollment An enrollment, without its token or the token's hash.
	Enrollment Enrollment `json:"enrollment"`

	// Token The enrollment token (the `enrollmentToken` scheme), returned only here; the
	// dispatcher keeps its hash. Hand it to the agent host's supervisor out of band.
	Token string `json:"token"`
}

EnrollmentCreated The minted enrollment and its one-time token.

type EnrollmentID

type EnrollmentID = string

EnrollmentID defines model for EnrollmentID.

type EnrollmentList

type EnrollmentList struct {
	Items []Enrollment `json:"items"`

	// NextCursor Absent on the last page.
	NextCursor *string `json:"nextCursor,omitempty"`
}

EnrollmentList A page of enrollments.

type EnrollmentRequest

type EnrollmentRequest struct {
	// Name The agent host's name, its `RegisterAgentRequest.host`; the agent is named `agt_<owner>-<name>`.
	Name string `json:"name"`

	// Owner The GitHub login of the owner who lends the agent (its lending rules apply).
	Owner string `json:"owner"`

	// Pool The Pool the agent joins.
	Pool string `json:"pool"`

	// Ttl How long the enrollment token may be used, a Duration (`7d`, `36h`). At most `30d`.
	Ttl *v1alpha1.Duration `json:"ttl,omitempty"`
}

EnrollmentRequest The enrollment to mint. The pool, owner and name are fixed by the admin.

type Environment

type Environment = v1alpha1.Environment

Environment Environment is what a task's workspace brings up before the harness runs (P1 §4): plain commands run as root inside the task's VM workspace, which has its own Docker.

type EnvironmentLogUpload

type EnvironmentLogUpload struct {
	Bytes             int64  `json:"bytes"`
	EnvironmentLogRef string `json:"environmentLogRef"`
}

EnvironmentLogUpload Where the environment log was stored.

type Error

type Error = Problem

Error An RFC 9457 problem detail.

type Evaluation

type Evaluation struct {
	// Decisions The ordered actions that would be applied.
	Decisions []EvaluationDecision `json:"decisions"`
	Event     string               `json:"event"`

	// Matches Every candidate rule and its result.
	Matches []RuleMatch `json:"matches"`

	// StateAfter The projected work item state after all `set` actions.
	StateAfter map[string]interface{} `json:"stateAfter,omitempty"`
	WorkItem   *string                `json:"workItem,omitempty"`
}

Evaluation What the rule engine decided for an event (internal/rules Evaluation).

type EvaluationDecision

type EvaluationDecision struct {
	// Action A materialised action; the fields besides `type` depend on it.
	Action ActionIntent           `json:"action"`
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// Rail A safety rail's verdict on an action, as the dry-run summarises it. This is a different view from the stored RailVerdict (lowercase allowed, suppressed, deferred, unsupported): an unsupported action shows as Suppressed, and the rail name is prefixed to the reason.
	Rail    EvaluationRail `json:"rail"`
	Rule    string         `json:"rule"`
	RuleSet string         `json:"ruleSet"`
}

EvaluationDecision One action a rule would take, with its rail verdict and the inputs `where` saw.

type EvaluationRail

type EvaluationRail struct {
	Reason  *string               `json:"reason,omitempty"`
	Verdict EvaluationRailVerdict `json:"verdict"`
}

EvaluationRail A safety rail's verdict on an action, as the dry-run summarises it. This is a different view from the stored RailVerdict (lowercase allowed, suppressed, deferred, unsupported): an unsupported action shows as Suppressed, and the rail name is prefixed to the reason.

type EvaluationRailVerdict

type EvaluationRailVerdict string

EvaluationRailVerdict defines model for EvaluationRail.Verdict.

const (
	EvaluationRailVerdictAllowed    EvaluationRailVerdict = "Allowed"
	EvaluationRailVerdictDeferred   EvaluationRailVerdict = "Deferred"
	EvaluationRailVerdictSuppressed EvaluationRailVerdict = "Suppressed"
)

Defines values for EvaluationRailVerdict.

func (EvaluationRailVerdict) Valid

func (e EvaluationRailVerdict) Valid() bool

Valid indicates whether the value is a known member of the EvaluationRailVerdict enum.

type Event

type Event = v1alpha1.Event

Event Event is a normalised provider event, shaped as a CloudEvent: its identity is (Source = provider instance or "factory", Type).

type EventData

type EventData = v1alpha1.EventData

EventData EventData is the event's payload.

type EventID

type EventID = string

EventID defines model for EventID.

type EventType

type EventType = v1alpha1.EventType

EventType EventType is a normalised event type.

type ExprOrHarnessRequest

type ExprOrHarnessRequest = v1alpha1.ExprOr[v1alpha1.HarnessRequest]

ExprOrHarnessRequest ExprOr holds either an expression string or a typed value.

type FieldError

type FieldError struct {
	// Field The field's path, e.g. `capabilities.harnesses[0].name`.
	Field string `json:"field"`

	// Message What is wrong with it.
	Message string `json:"message"`
}

FieldError One invalid field.

type Forbidden

type Forbidden = Problem

Forbidden An RFC 9457 problem detail.

type GetCatalogFileParams

type GetCatalogFileParams struct {
	// Path The file's catalog-relative path, e.g. `prompts/implement.md.tmpl`.
	Path string `form:"path" json:"path"`
}

GetCatalogFileParams defines parameters for GetCatalogFile.

type GetCatalogFileResponse

type GetCatalogFileResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *CatalogFile
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSONDefault *Error
}

func ParseGetCatalogFileResponse

func ParseGetCatalogFileResponse(rsp *http.Response) (*GetCatalogFileResponse, error)

ParseGetCatalogFileResponse parses an HTTP response from a GetCatalogFileWithResponse call

func (GetCatalogFileResponse) ContentType

func (r GetCatalogFileResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetCatalogFileResponse) Status

func (r GetCatalogFileResponse) Status() string

Status returns HTTPResponse.Status

func (GetCatalogFileResponse) StatusCode

func (r GetCatalogFileResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCatalogObjectResponse

type GetCatalogObjectResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *CatalogObject
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSONDefault *Error
}

func ParseGetCatalogObjectResponse

func ParseGetCatalogObjectResponse(rsp *http.Response) (*GetCatalogObjectResponse, error)

ParseGetCatalogObjectResponse parses an HTTP response from a GetCatalogObjectWithResponse call

func (GetCatalogObjectResponse) ContentType

func (r GetCatalogObjectResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetCatalogObjectResponse) Status

func (r GetCatalogObjectResponse) Status() string

Status returns HTTPResponse.Status

func (GetCatalogObjectResponse) StatusCode

func (r GetCatalogObjectResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCatalogResponse

type GetCatalogResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *CatalogSummary
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSONDefault *Error
}

func ParseGetCatalogResponse

func ParseGetCatalogResponse(rsp *http.Response) (*GetCatalogResponse, error)

ParseGetCatalogResponse parses an HTTP response from a GetCatalogWithResponse call

func (GetCatalogResponse) ContentType

func (r GetCatalogResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetCatalogResponse) Status

func (r GetCatalogResponse) Status() string

Status returns HTTPResponse.Status

func (GetCatalogResponse) StatusCode

func (r GetCatalogResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEnvironmentLogResponse

type GetEnvironmentLogResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSONDefault *Error
}

func ParseGetEnvironmentLogResponse

func ParseGetEnvironmentLogResponse(rsp *http.Response) (*GetEnvironmentLogResponse, error)

ParseGetEnvironmentLogResponse parses an HTTP response from a GetEnvironmentLogWithResponse call

func (GetEnvironmentLogResponse) ContentType

func (r GetEnvironmentLogResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetEnvironmentLogResponse) Status

func (r GetEnvironmentLogResponse) Status() string

Status returns HTTPResponse.Status

func (GetEnvironmentLogResponse) StatusCode

func (r GetEnvironmentLogResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMeResponse

type GetMeResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *Me
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSONDefault *Error
}

func ParseGetMeResponse

func ParseGetMeResponse(rsp *http.Response) (*GetMeResponse, error)

ParseGetMeResponse parses an HTTP response from a GetMeWithResponse call

func (GetMeResponse) ContentType

func (r GetMeResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetMeResponse) Status

func (r GetMeResponse) Status() string

Status returns HTTPResponse.Status

func (GetMeResponse) StatusCode

func (r GetMeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRunResponse

type GetRunResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *RunDetail
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSONDefault *Error
}

func ParseGetRunResponse

func ParseGetRunResponse(rsp *http.Response) (*GetRunResponse, error)

ParseGetRunResponse parses an HTTP response from a GetRunWithResponse call

func (GetRunResponse) ContentType

func (r GetRunResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetRunResponse) Status

func (r GetRunResponse) Status() string

Status returns HTTPResponse.Status

func (GetRunResponse) StatusCode

func (r GetRunResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTaskContextResponse

type GetTaskContextResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *TaskContext
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSONDefault *Error
}

func ParseGetTaskContextResponse

func ParseGetTaskContextResponse(rsp *http.Response) (*GetTaskContextResponse, error)

ParseGetTaskContextResponse parses an HTTP response from a GetTaskContextWithResponse call

func (GetTaskContextResponse) ContentType

func (r GetTaskContextResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetTaskContextResponse) Status

func (r GetTaskContextResponse) Status() string

Status returns HTTPResponse.Status

func (GetTaskContextResponse) StatusCode

func (r GetTaskContextResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTaskOutputSchemaResponse

type GetTaskOutputSchemaResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationschemaJSON200      *JSONSchemaDocument
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSONDefault *Error
}

func ParseGetTaskOutputSchemaResponse

func ParseGetTaskOutputSchemaResponse(rsp *http.Response) (*GetTaskOutputSchemaResponse, error)

ParseGetTaskOutputSchemaResponse parses an HTTP response from a GetTaskOutputSchemaWithResponse call

func (GetTaskOutputSchemaResponse) ContentType

func (r GetTaskOutputSchemaResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetTaskOutputSchemaResponse) Status

Status returns HTTPResponse.Status

func (GetTaskOutputSchemaResponse) StatusCode

func (r GetTaskOutputSchemaResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTaskPromptResponse

type GetTaskPromptResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSONDefault *Error
}

func ParseGetTaskPromptResponse

func ParseGetTaskPromptResponse(rsp *http.Response) (*GetTaskPromptResponse, error)

ParseGetTaskPromptResponse parses an HTTP response from a GetTaskPromptWithResponse call

func (GetTaskPromptResponse) ContentType

func (r GetTaskPromptResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetTaskPromptResponse) Status

func (r GetTaskPromptResponse) Status() string

Status returns HTTPResponse.Status

func (GetTaskPromptResponse) StatusCode

func (r GetTaskPromptResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTaskResponse

type GetTaskResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *Task
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSONDefault *Error
}

func ParseGetTaskResponse

func ParseGetTaskResponse(rsp *http.Response) (*GetTaskResponse, error)

ParseGetTaskResponse parses an HTTP response from a GetTaskWithResponse call

func (GetTaskResponse) ContentType

func (r GetTaskResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetTaskResponse) Status

func (r GetTaskResponse) Status() string

Status returns HTTPResponse.Status

func (GetTaskResponse) StatusCode

func (r GetTaskResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTranscriptResponse

type GetTranscriptResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSONDefault *Error
}

func ParseGetTranscriptResponse

func ParseGetTranscriptResponse(rsp *http.Response) (*GetTranscriptResponse, error)

ParseGetTranscriptResponse parses an HTTP response from a GetTranscriptWithResponse call

func (GetTranscriptResponse) ContentType

func (r GetTranscriptResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetTranscriptResponse) Status

func (r GetTranscriptResponse) Status() string

Status returns HTTPResponse.Status

func (GetTranscriptResponse) StatusCode

func (r GetTranscriptResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkItemResponse

type GetWorkItemResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *WorkItemDetail
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSONDefault *Error
}

func ParseGetWorkItemResponse

func ParseGetWorkItemResponse(rsp *http.Response) (*GetWorkItemResponse, error)

ParseGetWorkItemResponse parses an HTTP response from a GetWorkItemWithResponse call

func (GetWorkItemResponse) ContentType

func (r GetWorkItemResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetWorkItemResponse) Status

func (r GetWorkItemResponse) Status() string

Status returns HTTPResponse.Status

func (GetWorkItemResponse) StatusCode

func (r GetWorkItemResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GitCredential

type GitCredential struct {
	ExpiresAt time.Time `json:"expiresAt"`

	// Host The git host, e.g. `github.com`.
	Host        string            `json:"host"`
	Permissions map[string]string `json:"permissions,omitempty"`
	Provider    string            `json:"provider"`

	// ReadRepos Further repos a read-only token may read (a token that can write covers `repo` only).
	ReadRepos []string `json:"readRepos,omitempty"`

	// Repo The repo the token is for, `owner/name`.
	Repo  string `json:"repo"`
	Token string `json:"token"`

	// Username The username to present with the token (`x-access-token`).
	Username string `json:"username"`
}

GitCredential A scoped installation token for one repo: the task's repo with the TaskSpec permissions, or a private read repo with `contents: read`. Never stored by the dispatcher.

type GitCredentialSpec

type GitCredentialSpec = v1alpha1.GitCredentialSpec

GitCredentialSpec GitCredentialSpec describes the scoped git tokens minted for a task: one for Repo with the TaskSpec permissions and, unless PublicReads is set, a read-only one per read repo.

type GitHubActionsBackend

type GitHubActionsBackend = v1alpha1.GitHubActionsBackend

GitHubActionsBackend GitHubActionsBackend runs agents as a workflow.

type GitHubProviderSpec

type GitHubProviderSpec = v1alpha1.GitHubProviderSpec

GitHubProviderSpec GitHubProviderSpec is the connection to a GitHub (or GHE) instance.

type Group

type Group = v1alpha1.Group

Group Group is a named set of people, resolved per provider.

type GroupCache

type GroupCache = v1alpha1.GroupCache

GroupCache GroupCache says how long resolved members are cached.

type GroupSource

type GroupSource = v1alpha1.GroupSource

GroupSource GroupSource is one source of members on one provider.

type GroupSpec

type GroupSpec = v1alpha1.GroupSpec

GroupSpec GroupSpec is the spec of a Group.

type HarnessConfig

type HarnessConfig = v1alpha1.HarnessConfig

HarnessConfig HarnessConfig is a requested harness config.

type HarnessConstraint

type HarnessConstraint = v1alpha1.HarnessConstraint

HarnessConstraint HarnessConstraint bounds what a harness may run.

type HarnessOffer

type HarnessOffer = v1alpha1.HarnessOffer

HarnessOffer HarnessOffer is what one agent can actually run with one harness (from the agent's Probe and local config): concrete values, not patterns.

type HarnessPolicy

type HarnessPolicy = v1alpha1.HarnessPolicy

HarnessPolicy HarnessPolicy is a TaskSpec's harness constraints and default request.

type HarnessRequest

type HarnessRequest = v1alpha1.HarnessRequest

HarnessRequest HarnessRequest asks for a harness and config.

type HarnessResolved

type HarnessResolved = v1alpha1.HarnessResolved

HarnessResolved HarnessResolved is the concrete harness config chosen when an agent leased the task.

type HeartbeatLeaseJSONRequestBody

type HeartbeatLeaseJSONRequestBody = HeartbeatRequest

HeartbeatLeaseJSONRequestBody defines body for HeartbeatLease for application/json ContentType.

type HeartbeatLeaseResponse

type HeartbeatLeaseResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *HeartbeatResponse
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON409     *Conflict
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseHeartbeatLeaseResponse

func ParseHeartbeatLeaseResponse(rsp *http.Response) (*HeartbeatLeaseResponse, error)

ParseHeartbeatLeaseResponse parses an HTTP response from a HeartbeatLeaseWithResponse call

func (HeartbeatLeaseResponse) ContentType

func (r HeartbeatLeaseResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (HeartbeatLeaseResponse) Status

func (r HeartbeatLeaseResponse) Status() string

Status returns HTTPResponse.Status

func (HeartbeatLeaseResponse) StatusCode

func (r HeartbeatLeaseResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HeartbeatRequest

type HeartbeatRequest struct {
	Progress []ProgressEvent `json:"progress,omitempty"`

	// Usage Usage since the previous heartbeat. `costUSD` is null for subscription runs.
	Usage *UsageDelta `json:"usage,omitempty"`
}

HeartbeatRequest Progress events and usage deltas since the previous heartbeat.

type HeartbeatResponse

type HeartbeatResponse struct {
	// Cancel Cancel the run now (the task is being cancelled).
	Cancel    bool      `json:"cancel"`
	ExpiresAt time.Time `json:"expiresAt"`

	// RefreshedGitCredential A scoped installation token for one repo: the task's repo with the TaskSpec permissions,
	// or a private read repo with `contents: read`. Never stored by the dispatcher.
	RefreshedGitCredential *GitCredential `json:"refreshedGitCredential,omitempty"`

	// RefreshedReadCredentials Sent with `refreshedGitCredential` when the task has read-only credentials: they
	// replace the lease's `readCredentials`, one per private read repo.
	RefreshedReadCredentials []GitCredential `json:"refreshedReadCredentials,omitempty"`
}

HeartbeatResponse The new expiry, whether to cancel, and maybe refreshed credentials.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InlineRule

type InlineRule = v1alpha1.InlineRule

InlineRule InlineRule is a Rule without its TypeMeta, embedded in a RuleSet.

type InputSpec

type InputSpec = v1alpha1.InputSpec

InputSpec InputSpec declares one TaskSpec input.

type Instructions

type Instructions = v1alpha1.Instructions

Instructions Instructions is the prompt template.

type JSONSchemaDocument

type JSONSchemaDocument map[string]interface{}

JSONSchemaDocument A JSON Schema (draft 2020-12) document, served as the catalog holds it.

type LLMAuth

type LLMAuth = v1alpha1.LLMAuth

LLMAuth LLMAuth is the LLM credential ephemeral agents use.

type LabelSelector

type LabelSelector = v1alpha1.LabelSelector

LabelSelector LabelSelector selects objects by their labels, as in Kubernetes.

type LabelSelectorParam

type LabelSelectorParam = string

LabelSelectorParam defines model for LabelSelectorParam.

type LabelSelectorRequirement

type LabelSelectorRequirement = v1alpha1.LabelSelectorRequirement

LabelSelectorRequirement LabelSelectorRequirement is one matchExpressions entry.

type Lease

type Lease struct {
	// GitCredential A scoped installation token for one repo: the task's repo with the TaskSpec permissions,
	// or a private read repo with `contents: read`. Never stored by the dispatcher.
	GitCredential GitCredential `json:"gitCredential"`

	// Lease The lease itself.
	Lease LeaseInfo `json:"lease"`

	// ReadCredentials One read-only credential (`permissions: {contents: read}`) per private read repo of
	// the task (`task.spec.credentials.git.readRepos`), its `repo` being that read repo.
	// Absent when the task has no read repos or they are public (`publicReads`): those are
	// cloned anonymously.
	ReadCredentials []GitCredential `json:"readCredentials,omitempty"`

	// RunToken The run-scoped token for this lease (the `runToken` scheme). Appears only in this
	// response; the dispatcher keeps only its hash. Not refreshed by heartbeats: it lives
	// exactly as long as the lease.
	RunToken *string `json:"runToken,omitempty"`

	// Task Task is one instantiation of a TaskSpec for a work item.
	Task Task `json:"task"`
}

Lease A leased task, its lease and its credential bundle for the agent's gateway: the scoped git credential, the read credentials and the run token.

type LeaseID

type LeaseID = string

LeaseID defines model for LeaseID.

type LeaseInfo

type LeaseInfo struct {
	Agent     string    `json:"agent"`
	ExpiresAt time.Time `json:"expiresAt"`

	// HeartbeatEvery The heartbeat interval (`pool.lease.heartbeat`), e.g. `30s`.
	HeartbeatEvery string `json:"heartbeatEvery"`
	Id             string `json:"id"`

	// Run The Run created for this attempt.
	Run  *string `json:"run,omitempty"`
	Task string  `json:"task"`
}

LeaseInfo The lease itself.

type LeasePolicy

type LeasePolicy = v1alpha1.LeasePolicy

LeasePolicy LeasePolicy sets lease timing.

type LeaseTaskParams

type LeaseTaskParams struct {
	// Wait How long to wait for a task, in seconds (`30s`). At most `60s`.
	Wait *string `form:"wait,omitempty" json:"wait,omitempty"`
}

LeaseTaskParams defines parameters for LeaseTask.

type LeaseTaskResponse

type LeaseTaskResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *Lease
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseLeaseTaskResponse

func ParseLeaseTaskResponse(rsp *http.Response) (*LeaseTaskResponse, error)

ParseLeaseTaskResponse parses an HTTP response from a LeaseTaskWithResponse call

func (LeaseTaskResponse) ContentType

func (r LeaseTaskResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (LeaseTaskResponse) Status

func (r LeaseTaskResponse) Status() string

Status returns HTTPResponse.Status

func (LeaseTaskResponse) StatusCode

func (r LeaseTaskResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Lending

type Lending = v1alpha1.Lending

Lending Lending is the owner's consent: what the agent may take.

type Limit

type Limit = int

Limit defines model for Limit.

type Limits

type Limits = v1alpha1.Limits

Limits Limits bound a run.

type Link = v1alpha1.Link

Link Link is a provider object that belongs to the work item.

type LinkAction

type LinkAction = v1alpha1.LinkAction

LinkAction LinkAction adds a provider object to the work item.

type ListAgentsParams

type ListAgentsParams struct {
	// Cursor The `nextCursor` of the previous page. Opaque.
	Cursor *Cursor `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Limit The page size.
	Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`

	// LabelSelector A Kubernetes-style label selector on `metadata.labels`: `pack=intake,env!=prod,owner`.
	LabelSelector *LabelSelectorParam `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`
}

ListAgentsParams defines parameters for ListAgents.

type ListAgentsResponse

type ListAgentsResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *AgentList
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSONDefault *Error
}

func ParseListAgentsResponse

func ParseListAgentsResponse(rsp *http.Response) (*ListAgentsResponse, error)

ParseListAgentsResponse parses an HTTP response from a ListAgentsWithResponse call

func (ListAgentsResponse) ContentType

func (r ListAgentsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListAgentsResponse) Status

func (r ListAgentsResponse) Status() string

Status returns HTTPResponse.Status

func (ListAgentsResponse) StatusCode

func (r ListAgentsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListCatalogFilesResponse

type ListCatalogFilesResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *CatalogFileList
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSONDefault *Error
}

func ParseListCatalogFilesResponse

func ParseListCatalogFilesResponse(rsp *http.Response) (*ListCatalogFilesResponse, error)

ParseListCatalogFilesResponse parses an HTTP response from a ListCatalogFilesWithResponse call

func (ListCatalogFilesResponse) ContentType

func (r ListCatalogFilesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListCatalogFilesResponse) Status

func (r ListCatalogFilesResponse) Status() string

Status returns HTTPResponse.Status

func (ListCatalogFilesResponse) StatusCode

func (r ListCatalogFilesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListEnrollmentsParams

type ListEnrollmentsParams struct {
	// Cursor The `nextCursor` of the previous page. Opaque.
	Cursor *Cursor `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Limit The page size.
	Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`
}

ListEnrollmentsParams defines parameters for ListEnrollments.

type ListEnrollmentsResponse

type ListEnrollmentsResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *EnrollmentList
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSONDefault *Error
}

func ParseListEnrollmentsResponse

func ParseListEnrollmentsResponse(rsp *http.Response) (*ListEnrollmentsResponse, error)

ParseListEnrollmentsResponse parses an HTTP response from a ListEnrollmentsWithResponse call

func (ListEnrollmentsResponse) ContentType

func (r ListEnrollmentsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListEnrollmentsResponse) Status

func (r ListEnrollmentsResponse) Status() string

Status returns HTTPResponse.Status

func (ListEnrollmentsResponse) StatusCode

func (r ListEnrollmentsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListPoolsParams

type ListPoolsParams struct {
	// Cursor The `nextCursor` of the previous page. Opaque.
	Cursor *Cursor `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Limit The page size.
	Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`

	// LabelSelector A Kubernetes-style label selector on `metadata.labels`: `pack=intake,env!=prod,owner`.
	LabelSelector *LabelSelectorParam `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`
}

ListPoolsParams defines parameters for ListPools.

type ListPoolsResponse

type ListPoolsResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *PoolList
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSONDefault *Error
}

func ParseListPoolsResponse

func ParseListPoolsResponse(rsp *http.Response) (*ListPoolsResponse, error)

ParseListPoolsResponse parses an HTTP response from a ListPoolsWithResponse call

func (ListPoolsResponse) ContentType

func (r ListPoolsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListPoolsResponse) Status

func (r ListPoolsResponse) Status() string

Status returns HTTPResponse.Status

func (ListPoolsResponse) StatusCode

func (r ListPoolsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListProvidersParams

type ListProvidersParams struct {
	// Cursor The `nextCursor` of the previous page. Opaque.
	Cursor *Cursor `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Limit The page size.
	Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`

	// LabelSelector A Kubernetes-style label selector on `metadata.labels`: `pack=intake,env!=prod,owner`.
	LabelSelector *LabelSelectorParam `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`
}

ListProvidersParams defines parameters for ListProviders.

type ListProvidersResponse

type ListProvidersResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *ProviderList
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSONDefault *Error
}

func ParseListProvidersResponse

func ParseListProvidersResponse(rsp *http.Response) (*ListProvidersResponse, error)

ParseListProvidersResponse parses an HTTP response from a ListProvidersWithResponse call

func (ListProvidersResponse) ContentType

func (r ListProvidersResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListProvidersResponse) Status

func (r ListProvidersResponse) Status() string

Status returns HTTPResponse.Status

func (ListProvidersResponse) StatusCode

func (r ListProvidersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListQueuesParams

type ListQueuesParams struct {
	// Cursor The `nextCursor` of the previous page. Opaque.
	Cursor *Cursor `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Limit The page size.
	Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`

	// LabelSelector A Kubernetes-style label selector on `metadata.labels`: `pack=intake,env!=prod,owner`.
	LabelSelector *LabelSelectorParam `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`
}

ListQueuesParams defines parameters for ListQueues.

type ListQueuesResponse

type ListQueuesResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *QueueList
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSONDefault *Error
}

func ParseListQueuesResponse

func ParseListQueuesResponse(rsp *http.Response) (*ListQueuesResponse, error)

ParseListQueuesResponse parses an HTTP response from a ListQueuesWithResponse call

func (ListQueuesResponse) ContentType

func (r ListQueuesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListQueuesResponse) Status

func (r ListQueuesResponse) Status() string

Status returns HTTPResponse.Status

func (ListQueuesResponse) StatusCode

func (r ListQueuesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListTasksParams

type ListTasksParams struct {
	// Cursor The `nextCursor` of the previous page. Opaque.
	Cursor *Cursor `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Limit The page size.
	Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`

	// LabelSelector A Kubernetes-style label selector on `metadata.labels`: `pack=intake,env!=prod,owner`.
	LabelSelector *LabelSelectorParam `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`
}

ListTasksParams defines parameters for ListTasks.

type ListTasksResponse

type ListTasksResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *TaskList
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSONDefault *Error
}

func ParseListTasksResponse

func ParseListTasksResponse(rsp *http.Response) (*ListTasksResponse, error)

ParseListTasksResponse parses an HTTP response from a ListTasksWithResponse call

func (ListTasksResponse) ContentType

func (r ListTasksResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListTasksResponse) Status

func (r ListTasksResponse) Status() string

Status returns HTTPResponse.Status

func (ListTasksResponse) StatusCode

func (r ListTasksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListWorkItemsParams

type ListWorkItemsParams struct {
	// Cursor The `nextCursor` of the previous page. Opaque.
	Cursor *Cursor `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Limit The page size.
	Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`

	// LabelSelector A Kubernetes-style label selector on `metadata.labels`: `pack=intake,env!=prod,owner`.
	LabelSelector *LabelSelectorParam `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`
}

ListWorkItemsParams defines parameters for ListWorkItems.

type ListWorkItemsResponse

type ListWorkItemsResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *WorkItemList
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSONDefault *Error
}

func ParseListWorkItemsResponse

func ParseListWorkItemsResponse(rsp *http.Response) (*ListWorkItemsResponse, error)

ParseListWorkItemsResponse parses an HTTP response from a ListWorkItemsWithResponse call

func (ListWorkItemsResponse) ContentType

func (r ListWorkItemsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListWorkItemsResponse) Status

func (r ListWorkItemsResponse) Status() string

Status returns HTTPResponse.Status

func (ListWorkItemsResponse) StatusCode

func (r ListWorkItemsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type LoginParams

type LoginParams struct {
	// ReturnTo A same-origin path to return to after login.
	ReturnTo *string `form:"returnTo,omitempty" json:"returnTo,omitempty"`
}

LoginParams defines parameters for Login.

type LoginResponse

type LoginResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSONDefault *Error
}

func ParseLoginResponse

func ParseLoginResponse(rsp *http.Response) (*LoginResponse, error)

ParseLoginResponse parses an HTTP response from a LoginWithResponse call

func (LoginResponse) ContentType

func (r LoginResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (LoginResponse) Status

func (r LoginResponse) Status() string

Status returns HTTPResponse.Status

func (LoginResponse) StatusCode

func (r LoginResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type LogoutResponse

type LogoutResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseLogoutResponse

func ParseLogoutResponse(rsp *http.Response) (*LogoutResponse, error)

ParseLogoutResponse parses an HTTP response from a LogoutWithResponse call

func (LogoutResponse) ContentType

func (r LogoutResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (LogoutResponse) Status

func (r LogoutResponse) Status() string

Status returns HTTPResponse.Status

func (LogoutResponse) StatusCode

func (r LogoutResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Me

type Me struct {
	AvatarUrl *string `json:"avatarUrl,omitempty"`

	// IsAdmin Member of the `maintainers` Group; may send commands.
	IsAdmin bool    `json:"isAdmin"`
	Login   string  `json:"login"`
	Name    *string `json:"name,omitempty"`
}

Me The signed-in user.

type NotFound

type NotFound = Problem

NotFound An RFC 9457 problem detail.

type NotifyAction

type NotifyAction = v1alpha1.NotifyAction

NotifyAction NotifyAction sends a templated message through the providers; no LLM involved.

type ObjectMeta

type ObjectMeta = v1alpha1.ObjectMeta

ObjectMeta ObjectMeta is the metadata of every kind except Task (TaskMeta) and Event (CloudEvents attributes).

type ObjectRef

type ObjectRef = v1alpha1.ObjectRef

ObjectRef ObjectRef identifies a provider object, e.g.

type OrgRole

type OrgRole = v1alpha1.OrgRole

OrgRole OrgRole selects the members of an org with a role, e.g.

type OutputSpec

type OutputSpec = v1alpha1.OutputSpec

OutputSpec OutputSpec is the expected Result: its spec-specific schema and outcomes.

type PayloadTooLarge

type PayloadTooLarge = Problem

PayloadTooLarge An RFC 9457 problem detail.

type PendingTask

type PendingTask struct {
	// Reason `queue-full`, `budget`, `agent-busy`, `agent-throttled`, `lending`, `no-capable-agent`, `anti-affinity`.
	Reason *string    `json:"reason,omitempty"`
	Since  *time.Time `json:"since,omitempty"`
	Task   string     `json:"task"`
}

PendingTask A pending task and the first matching check it failed.

type Pool

type Pool = v1alpha1.Pool

Pool Pool is who takes tasks out of queues and how capacity scales.

type PoolBackend

type PoolBackend = v1alpha1.PoolBackend

PoolBackend PoolBackend runs ephemeral agents.

type PoolList

type PoolList struct {
	Items []PoolView `json:"items"`

	// NextCursor Absent on the last page.
	NextCursor *string `json:"nextCursor,omitempty"`
}

PoolList A page of pools.

type PoolRequirements

type PoolRequirements = v1alpha1.PoolRequirements

PoolRequirements PoolRequirements is the minimum an agent must offer to join.

type PoolSpec

type PoolSpec = v1alpha1.PoolSpec

PoolSpec PoolSpec is the spec of a Pool.

type PoolView

type PoolView struct {
	// Agents The names of the agents registered in the pool.
	Agents []string `json:"agents"`

	// Pool Pool is who takes tasks out of queues and how capacity scales.
	Pool Pool `json:"pool"`
}

PoolView A pool and its agents.

type PostCommandJSONRequestBody

type PostCommandJSONRequestBody = Command

PostCommandJSONRequestBody defines body for PostCommand for application/json ContentType.

type PostCommandResponse

type PostCommandResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON202                       *CommandAccepted
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParsePostCommandResponse

func ParsePostCommandResponse(rsp *http.Response) (*PostCommandResponse, error)

ParsePostCommandResponse parses an HTTP response from a PostCommandWithResponse call

func (PostCommandResponse) ContentType

func (r PostCommandResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PostCommandResponse) Status

func (r PostCommandResponse) Status() string

Status returns HTTPResponse.Status

func (PostCommandResponse) StatusCode

func (r PostCommandResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Problem

type Problem struct {
	// Code A stable machine-readable code: `idempotency-key-required`, `effect-not-allowed`, `lease-gone`, `store-read-only`, ….
	Code *string `json:"code,omitempty"`

	// Detail This occurrence's explanation.
	Detail *string `json:"detail,omitempty"`

	// Errors Field-level validation errors.
	Errors []FieldError `json:"errors,omitempty"`

	// Instance The request id of this occurrence.
	Instance *string `json:"instance,omitempty"`

	// Status The HTTP status code.
	Status int `json:"status"`

	// Title A short summary of the problem type.
	Title string `json:"title"`

	// Type A URI identifying the problem type; `about:blank` when only `code` matters.
	Type *string `json:"type,omitempty"`
}

Problem An RFC 9457 problem detail.

type ProgressEvent

type ProgressEvent = v1alpha1.ProgressEvent

ProgressEvent ProgressEvent is one progress line streamed by the agent.

type PromptRef

type PromptRef = v1alpha1.PromptRef

PromptRef PromptRef is where the agent fetches the rendered prompt.

type Provenance

type Provenance = v1alpha1.Provenance

Provenance Provenance is the event, RuleSet, rule and catalog commit that created a task.

type Provider

type Provider = v1alpha1.Provider

Provider Provider says how to connect to one provider instance.

type ProviderHealth

type ProviderHealth struct {
	CheckedAt *time.Time           `json:"checkedAt,omitempty"`
	Message   *string              `json:"message,omitempty"`
	Status    ProviderHealthStatus `json:"status"`
}

ProviderHealth A provider connection's health (`Conn.Health()`).

type ProviderHealthStatus

type ProviderHealthStatus string

ProviderHealthStatus defines model for ProviderHealth.Status.

const (
	ProviderHealthStatusDegraded ProviderHealthStatus = "degraded"
	ProviderHealthStatusDown     ProviderHealthStatus = "down"
	ProviderHealthStatusOk       ProviderHealthStatus = "ok"
	ProviderHealthStatusUnknown  ProviderHealthStatus = "unknown"
)

Defines values for ProviderHealthStatus.

func (ProviderHealthStatus) Valid

func (e ProviderHealthStatus) Valid() bool

Valid indicates whether the value is a known member of the ProviderHealthStatus enum.

type ProviderList

type ProviderList struct {
	Items []ProviderView `json:"items"`

	// NextCursor Absent on the last page.
	NextCursor *string `json:"nextCursor,omitempty"`
}

ProviderList A page of providers.

type ProviderScope

type ProviderScope = v1alpha1.ProviderScope

ProviderScope ProviderScope bounds what a provider instance covers.

type ProviderSpec

type ProviderSpec = v1alpha1.ProviderSpec

ProviderSpec ProviderSpec is the spec of a Provider.

type ProviderView

type ProviderView struct {
	// Health A provider connection's health (`Conn.Health()`).
	Health ProviderHealth `json:"health"`

	// Provider Provider says how to connect to one provider instance.
	Provider Provider `json:"provider"`
}

ProviderView A provider and its health.

type Queue

type Queue = v1alpha1.Queue

Queue Queue holds tasks until a pool's agents take them.

type QueueList

type QueueList struct {
	Items []QueueView `json:"items"`

	// NextCursor Absent on the last page.
	NextCursor *string `json:"nextCursor,omitempty"`
}

QueueList A page of queues.

type QueueSpec

type QueueSpec = v1alpha1.QueueSpec

QueueSpec QueueSpec is the spec of a Queue.

type QueueView

type QueueView struct {
	// Depth Pending tasks.
	Depth int `json:"depth"`

	// Pending The pending tasks and why each waits.
	Pending []PendingTask `json:"pending"`

	// Queue Queue holds tasks until a pool's agents take them.
	Queue Queue `json:"queue"`

	// Running Leased or running tasks.
	Running int `json:"running"`
}

QueueView A queue and its depth.

type RailVerdict

type RailVerdict = v1alpha1.RailVerdict

RailVerdict RailVerdict is one safety rail's verdict on a decision as the work item stores it (lowercase, unsupported included); the dry-run API's EvaluationRail is a different view of it (Allowed, Suppressed or Deferred), where unsupported shows as Suppressed and the rail name is prefixed to the reason.

type ReadyCheck

type ReadyCheck = v1alpha1.ReadyCheck

ReadyCheck ReadyCheck is how the runtime waits for an environment.

type RegisterAgentJSONRequestBody

type RegisterAgentJSONRequestBody = RegisterAgentRequest

RegisterAgentJSONRequestBody defines body for RegisterAgent for application/json ContentType.

type RegisterAgentRequest

type RegisterAgentRequest struct {
	// AgentVersion The `factory-agent` version.
	AgentVersion string `json:"agentVersion"`

	// Capabilities AgentCapabilities are the agent's harness offers and labels.
	Capabilities AgentCapabilities `json:"capabilities"`

	// Host The worker's host name; the agent is named `agt_<owner>-<host>`.
	Host string `json:"host"`

	// Lending Lending is the owner's consent: what the agent may take.
	Lending *Lending `json:"lending,omitempty"`

	// Pool The Pool to join.
	Pool string `json:"pool"`
}

RegisterAgentRequest The agent's pool, host and offer. The credentials travel in the security headers.

type RegisterAgentResponse

type RegisterAgentResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON201                       *AgentRegistration
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseRegisterAgentResponse

func ParseRegisterAgentResponse(rsp *http.Response) (*RegisterAgentResponse, error)

ParseRegisterAgentResponse parses an HTTP response from a RegisterAgentWithResponse call

func (RegisterAgentResponse) ContentType

func (r RegisterAgentResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RegisterAgentResponse) Status

func (r RegisterAgentResponse) Status() string

Status returns HTTPResponse.Status

func (RegisterAgentResponse) StatusCode

func (r RegisterAgentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReplayEventResponse

type ReplayEventResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *ReplayResult
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON409     *Conflict
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseReplayEventResponse

func ParseReplayEventResponse(rsp *http.Response) (*ReplayEventResponse, error)

ParseReplayEventResponse parses an HTTP response from a ReplayEventWithResponse call

func (ReplayEventResponse) ContentType

func (r ReplayEventResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ReplayEventResponse) Status

func (r ReplayEventResponse) Status() string

Status returns HTTPResponse.Status

func (ReplayEventResponse) StatusCode

func (r ReplayEventResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReplayResult

type ReplayResult struct {
	// Decisions The decisions the replay recorded (each with `replay`), none when it changed nothing.
	Decisions []Decision `json:"decisions"`
	Event     string     `json:"event"`

	// WorkItem The work item the event was evaluated for; absent when no rule fires for it.
	WorkItem *string `json:"workItem,omitempty"`
}

ReplayResult A replay's outcome.

type RepoMount

type RepoMount = v1alpha1.RepoMount

RepoMount RepoMount is one repo in the workspace.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type Requires

type Requires = v1alpha1.Requires

Requires Requires lists the agent labels a task needs.

type Result

type Result = v1alpha1.Result

Result Result is what an agent reports when a run completes.

type ResultHarness

type ResultHarness = v1alpha1.ResultHarness

ResultHarness ResultHarness is the harness that ran, its effective config and usage.

type ResyncPolicy

type ResyncPolicy = v1alpha1.ResyncPolicy

ResyncPolicy ResyncPolicy says how often the provider's objects are re-observed.

type RetryPolicy

type RetryPolicy = v1alpha1.RetryPolicy

RetryPolicy RetryPolicy says how often, and on what, a task is retried.

type Rule

type Rule = v1alpha1.Rule

Rule Rule is when and what.

type RuleMatch

type RuleMatch struct {
	// ActionIndex With `action-error`, the failing action.
	ActionIndex *int            `json:"actionIndex,omitempty"`
	Error       *string         `json:"error,omitempty"`
	Result      RuleMatchResult `json:"result"`
	Rule        string          `json:"rule"`
	RuleSet     string          `json:"ruleSet"`
}

RuleMatch One candidate rule's result.

type RuleMatchResult

type RuleMatchResult string

RuleMatchResult defines model for RuleMatch.Result.

const (
	RuleMatchResultActionError       RuleMatchResult = "action-error"
	RuleMatchResultDuplicate         RuleMatchResult = "duplicate"
	RuleMatchResultError             RuleMatchResult = "error"
	RuleMatchResultMatched           RuleMatchResult = "matched"
	RuleMatchResultNotMatched        RuleMatchResult = "not-matched"
	RuleMatchResultSuppressedByFinal RuleMatchResult = "suppressed-by-final"
)

Defines values for RuleMatchResult.

func (RuleMatchResult) Valid

func (e RuleMatchResult) Valid() bool

Valid indicates whether the value is a known member of the RuleMatchResult enum.

type RuleSelection

type RuleSelection = v1alpha1.RuleSelection

RuleSelection RuleSelection picks rules: refs ∪ selector, minus exclude.

type RuleSet

type RuleSet = v1alpha1.RuleSet

RuleSet RuleSet is where rules apply: it binds provider instances, sets the scope, selects rules and overrides their params.

type RuleSetSpec

type RuleSetSpec = v1alpha1.RuleSetSpec

RuleSetSpec RuleSetSpec is the spec of a RuleSet.

type RuleSpec

type RuleSpec = v1alpha1.RuleSpec

RuleSpec RuleSpec is the spec of a Rule.

type Run

type Run = v1alpha1.Run

Run Run is one attempt at a Task by one agent.

type RunDetail

type RunDetail struct {
	Effects []Effect `json:"effects"`

	// Run Run is one attempt at a Task by one agent.
	Run Run `json:"run"`
}

RunDetail A run and its effects.

type RunID

type RunID = string

RunID defines model for RunID.

type RunSpec

type RunSpec = v1alpha1.RunSpec

RunSpec RunSpec is a Run's spec.

type RunStatus

type RunStatus = v1alpha1.RunStatus

RunStatus RunStatus is a Run's status.

type Scaling

type Scaling = v1alpha1.Scaling

Scaling Scaling bounds an ephemeral pool's size.

type Scope

type Scope = v1alpha1.Scope

Scope Scope narrows a RuleSet to repos (globs) or channels.

type SecretRef

type SecretRef = v1alpha1.SecretRef

SecretRef SecretRef points at a secret held outside the catalog.

type ServiceUnavailable

type ServiceUnavailable = Problem

ServiceUnavailable An RFC 9457 problem detail.

type SkillRef

type SkillRef = v1alpha1.SkillRef

SkillRef SkillRef pins skills from a skills repo.

type SlackProviderSpec

type SlackProviderSpec = v1alpha1.SlackProviderSpec

SlackProviderSpec SlackProviderSpec is the connection to a Slack workspace (future).

type StreamEventsParams

type StreamEventsParams struct {
	// Topics Comma-separated topics: `runs/<id>`, `workitems`, `workitems/<id>`, `tasks`, `agents`.
	Topics []string `form:"topics" json:"topics"`

	// LastEventID The `id` of the last event received, to resume after a reconnect.
	LastEventID *string `json:"Last-Event-ID,omitempty"`
}

StreamEventsParams defines parameters for StreamEvents.

type StreamEventsResponse

type StreamEventsResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseStreamEventsResponse

func ParseStreamEventsResponse(rsp *http.Response) (*StreamEventsResponse, error)

ParseStreamEventsResponse parses an HTTP response from a StreamEventsWithResponse call

func (StreamEventsResponse) ContentType

func (r StreamEventsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (StreamEventsResponse) Status

func (r StreamEventsResponse) Status() string

Status returns HTTPResponse.Status

func (StreamEventsResponse) StatusCode

func (r StreamEventsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StringOrList

type StringOrList = v1alpha1.StringOrList

StringOrList StringOrList is a field that takes one string (often a pattern, e.g.

type Suggestion

type Suggestion = v1alpha1.Suggestion

Suggestion Suggestion is a follow-up the agent proposes; rules decide.

type Target

type Target = v1alpha1.Target

Target Target says which repo or object the work happens on, when it isn't the event's object.

type Task

type Task = v1alpha1.Task

Task Task is one instantiation of a TaskSpec for a work item.

type TaskContext

type TaskContext struct {
	// Content The fetched content. Untrusted content is fenced and hidden parts are marked, not stripped.
	Content   string  `json:"content"`
	Index     int     `json:"index"`
	Kind      string  `json:"kind"`
	MediaType *string `json:"mediaType,omitempty"`
	Provider  *string `json:"provider,omitempty"`
	Ref       string  `json:"ref"`

	// Trust `trusted` or `untrusted`.
	Trust string `json:"trust"`
}

TaskContext One fetched context item, labelled with its trust.

type TaskCredentials

type TaskCredentials = v1alpha1.TaskCredentials

TaskCredentials TaskCredentials are the credentials a task gets.

type TaskHarness

type TaskHarness = v1alpha1.TaskHarness

TaskHarness TaskHarness is the requested harness and, once leased, the resolved one (null until then).

type TaskID

type TaskID = string

TaskID defines model for TaskID.

type TaskList

type TaskList struct {
	Items []Task `json:"items"`

	// NextCursor Absent on the last page.
	NextCursor *string `json:"nextCursor,omitempty"`
}

TaskList A page of tasks.

type TaskMeta

type TaskMeta = v1alpha1.TaskMeta

TaskMeta TaskMeta is a Task's metadata: tasks are named by id and carry their provenance.

type TaskPhase

type TaskPhase = v1alpha1.TaskPhase

TaskPhase TaskPhase is a Task's lifecycle phase.

type TaskRunSpec

type TaskRunSpec = v1alpha1.TaskRunSpec

TaskRunSpec TaskRunSpec is a Task's spec: the TaskSpec resolved for this work item.

type TaskSpec

type TaskSpec = v1alpha1.TaskSpec

TaskSpec TaskSpec is what and how for one role, with no triggers or transitions.

type TaskSpecRef

type TaskSpecRef = v1alpha1.TaskSpecRef

TaskSpecRef TaskSpecRef is the TaskSpec a task was made from, by name and digest.

type TaskSpecSpec

type TaskSpecSpec = v1alpha1.TaskSpecSpec

TaskSpecSpec TaskSpecSpec is the spec of a TaskSpec.

type TaskStatus

type TaskStatus = v1alpha1.TaskStatus

TaskStatus TaskStatus is a Task's status.

type Template

type Template = v1alpha1.Template

Template Template is the text of notifications and approval prompts, one body per provider type.

type TemplateBody

type TemplateBody = v1alpha1.TemplateBody

TemplateBody TemplateBody is either an inline Go text/template (written as a string) or, for Slack, a Block Kit file ({blocks: path}).

type TemplateSpec

type TemplateSpec = v1alpha1.TemplateSpec

TemplateSpec TemplateSpec is the spec of a Template.

type TooManyRequests

type TooManyRequests = Problem

TooManyRequests An RFC 9457 problem detail.

type TranscriptUpload

type TranscriptUpload struct {
	Bytes         int64  `json:"bytes"`
	TranscriptRef string `json:"transcriptRef"`
}

TranscriptUpload Where the transcript was stored.

type TrustRule

type TrustRule = v1alpha1.TrustRule

TrustRule TrustRule maps actors to a trust tier.

type Unauthorized

type Unauthorized = Problem

Unauthorized An RFC 9457 problem detail.

type UpdateAgentJSONRequestBody

type UpdateAgentJSONRequestBody = AgentUpdate

UpdateAgentJSONRequestBody defines body for UpdateAgent for application/json ContentType.

type UpdateAgentResponse

type UpdateAgentResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *Agent
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseUpdateAgentResponse

func ParseUpdateAgentResponse(rsp *http.Response) (*UpdateAgentResponse, error)

ParseUpdateAgentResponse parses an HTTP response from a UpdateAgentWithResponse call

func (UpdateAgentResponse) ContentType

func (r UpdateAgentResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateAgentResponse) Status

func (r UpdateAgentResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateAgentResponse) StatusCode

func (r UpdateAgentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UploadEnvironmentLogResponse

type UploadEnvironmentLogResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *EnvironmentLogUpload
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON413     *PayloadTooLarge
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseUploadEnvironmentLogResponse

func ParseUploadEnvironmentLogResponse(rsp *http.Response) (*UploadEnvironmentLogResponse, error)

ParseUploadEnvironmentLogResponse parses an HTTP response from a UploadEnvironmentLogWithResponse call

func (UploadEnvironmentLogResponse) ContentType

func (r UploadEnvironmentLogResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UploadEnvironmentLogResponse) Status

Status returns HTTPResponse.Status

func (UploadEnvironmentLogResponse) StatusCode

func (r UploadEnvironmentLogResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UploadEnvironmentLogTextBody

type UploadEnvironmentLogTextBody = string

UploadEnvironmentLogTextBody defines parameters for UploadEnvironmentLog.

type UploadEnvironmentLogTextRequestBody

type UploadEnvironmentLogTextRequestBody = UploadEnvironmentLogTextBody

UploadEnvironmentLogTextRequestBody defines body for UploadEnvironmentLog for text/plain ContentType.

type UploadTranscriptResponse

type UploadTranscriptResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *TranscriptUpload
	ApplicationproblemJSON400     *BadRequest
	ApplicationproblemJSON401     *Unauthorized
	ApplicationproblemJSON403     *Forbidden
	ApplicationproblemJSON404     *NotFound
	ApplicationproblemJSON413     *PayloadTooLarge
	ApplicationproblemJSON503     *ServiceUnavailable
	ApplicationproblemJSONDefault *Error
}

func ParseUploadTranscriptResponse

func ParseUploadTranscriptResponse(rsp *http.Response) (*UploadTranscriptResponse, error)

ParseUploadTranscriptResponse parses an HTTP response from a UploadTranscriptWithResponse call

func (UploadTranscriptResponse) ContentType

func (r UploadTranscriptResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UploadTranscriptResponse) Status

func (r UploadTranscriptResponse) Status() string

Status returns HTTPResponse.Status

func (UploadTranscriptResponse) StatusCode

func (r UploadTranscriptResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Usage

type Usage = v1alpha1.Usage

Usage Usage is what a run consumed.

type UsageDelta

type UsageDelta struct {
	CostUSD      *float32 `json:"costUSD,omitempty"`
	InputTokens  *int64   `json:"inputTokens,omitempty"`
	OutputTokens *int64   `json:"outputTokens,omitempty"`
}

UsageDelta Usage since the previous heartbeat. `costUSD` is null for subscription runs.

type VersionSource

type VersionSource = v1alpha1.VersionSource

VersionSource VersionSource is where an environment's component versions come from.

type Webhook

type Webhook = v1alpha1.Webhook

Webhook Webhook is where the provider's webhook is mounted, and the secret that signs it.

type WorkItem

type WorkItem = v1alpha1.WorkItem

WorkItem WorkItem groups the provider objects that are about one piece of work.

type WorkItemClosed

type WorkItemClosed = v1alpha1.WorkItemClosed

WorkItemClosed WorkItemClosed records why and when an admin closed a work item.

type WorkItemDeleted

type WorkItemDeleted struct {
	// Deleted How many objects of each kind were deleted (Task, Run, Effect, Event, …).
	Deleted  map[string]int `json:"deleted"`
	WorkItem string         `json:"workItem"`
}

WorkItemDeleted What deleting a work item removed, by kind.

type WorkItemDetail

type WorkItemDetail struct {
	Effects []Effect `json:"effects"`
	Events  []Event  `json:"events"`
	Runs    []Run    `json:"runs"`
	Tasks   []Task   `json:"tasks"`

	// WorkItem WorkItem groups the provider objects that are about one piece of work.
	WorkItem WorkItem `json:"workItem"`
}

WorkItemDetail A work item and its timeline.

type WorkItemID

type WorkItemID = string

WorkItemID defines model for WorkItemID.

type WorkItemList

type WorkItemList struct {
	Items []WorkItem `json:"items"`

	// NextCursor Absent on the last page.
	NextCursor *string `json:"nextCursor,omitempty"`
}

WorkItemList A page of work items.

type WorkItemSpec

type WorkItemSpec = v1alpha1.WorkItemSpec

WorkItemSpec WorkItemSpec is the spec of a WorkItem.

type WorkItemStatus

type WorkItemStatus = v1alpha1.WorkItemStatus

WorkItemStatus WorkItemStatus is the work item's state, set only by rules and controllers.

type Workspace

type Workspace = v1alpha1.Workspace

Workspace Workspace says what the agent checks out.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL