api

Jul 28, 2026

Changes in this version

type AgentAPIPingResponse

+ func (r AgentAPIPingResponse) ContentType() string

+ func (r AgentAPIPingResponse) GetBody() []byte

type AgentCheckinInput

+ Paused *bool

type AgentCheckinOutput

+ PauseReason *string

+ Paused *bool

+ PausedAt *time.Time

+ PausedBy *string

type AgentCheckinResponse

+ func (r AgentCheckinResponse) ContentType() string

+ func (r AgentCheckinResponse) GetBody() []byte

+ func (r AgentCheckinResponse) GetJSON200() *AgentCheckinOutput

type HealthResponse

+ func (r HealthResponse) ContentType() string

+ func (r HealthResponse) GetBody() []byte

Aug 19, 2025

Changes in this version

+ func NewAgentCheckinRequest(server string, body AgentCheckinJSONRequestBody) (*http.Request, error)

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

+ type AgentCheckinInput struct

+ AgentID *string

+ AgentVersion *string

+ PoolLabels *[]PoolLabel

+ type AgentCheckinJSONRequestBody = AgentCheckinInput

+ type AgentCheckinOutput struct

+ AuthToken *string

+ RequiredAgentVersion *string

+ WorkerEnvironmentVariables *[]EnvironmentVariable

+ WorkerImageURI *string

+ type AgentCheckinResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *AgentCheckinOutput

+ func ParseAgentCheckinResponse(rsp *http.Response) (*AgentCheckinResponse, error)

+ func (r AgentCheckinResponse) Status() string

+ func (r AgentCheckinResponse) StatusCode() int

type Client

+ func (c *Client) AgentCheckin(ctx context.Context, body AgentCheckinJSONRequestBody, ...) (*http.Response, error)

+ func (c *Client) AgentCheckinWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

type ClientInterface

+ AgentCheckin func(ctx context.Context, body AgentCheckinJSONRequestBody, ...) (*http.Response, error)

+ AgentCheckinWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

type ClientWithResponses

+ func (c *ClientWithResponses) AgentCheckinWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*AgentCheckinResponse, error)

+ func (c *ClientWithResponses) AgentCheckinWithResponse(ctx context.Context, body AgentCheckinJSONRequestBody, ...) (*AgentCheckinResponse, error)

type ClientWithResponsesInterface

+ AgentCheckinWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*AgentCheckinResponse, error)

+ AgentCheckinWithResponse func(ctx context.Context, body AgentCheckinJSONRequestBody, ...) (*AgentCheckinResponse, error)

Jun 13, 2025

Changes in this version

type ErrorType

+ const AGENTERRORPULLINGWORKERIMAGE

+ const AGENTERRORRUNNINGWORKER

type TaskPollOutput

+ RunCounter *int

Jun 12, 2025

Changes in this version

type TaskPollOutput

+ ContainerTimeout string

Mar 19, 2025

Changes in this version

+ type ErrorType string

+ const CUSTOMERWORKLOADERROR

+ const Empty

+ const NONZEROEXITCODE

+ const UNKNOWNERROR

+ const UNKNOWNWORKERERROR

type TaskStatus

+ const SUBMITTED

type UpdateTaskInput

+ ErrorType *ErrorType

Oct 24, 2024

Changes in this version

+ const OAuthScopes

+ func NewAgentAPIPingRequest(server string) (*http.Request, error)

+ func NewAgentHeartbeatRequest(server string, body AgentHeartbeatJSONRequestBody) (*http.Request, error)

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

+ func NewHealthRequest(server string) (*http.Request, error)

+ func NewTaskPollRequest(server string, body TaskPollJSONRequestBody) (*http.Request, error)

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

+ func NewUpdateTaskRequest(server string, taskName TaskName, body UpdateTaskJSONRequestBody) (*http.Request, error)

+ func NewUpdateTaskRequestWithBody(server string, taskName TaskName, contentType string, body io.Reader) (*http.Request, error)

+ type AgentAPIPingResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ func ParseAgentAPIPingResponse(rsp *http.Response) (*AgentAPIPingResponse, error)

+ func (r AgentAPIPingResponse) Status() string

+ func (r AgentAPIPingResponse) StatusCode() int

+ type AgentHeartbeatInput struct

+ AgentName *string

+ PoolLabels *[]PoolLabel

+ TaskName *TaskName

+ TaskStatus *TaskStatus

+ type AgentHeartbeatJSONRequestBody = AgentHeartbeatInput

+ type AgentHeartbeatResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ func ParseAgentHeartbeatResponse(rsp *http.Response) (*AgentHeartbeatResponse, error)

+ func (r AgentHeartbeatResponse) Status() string

+ func (r AgentHeartbeatResponse) StatusCode() int

+ type Client struct

+ Client HttpRequestDoer

+ RequestEditors []RequestEditorFn

+ Server string

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

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

+ func (c *Client) AgentHeartbeat(ctx context.Context, body AgentHeartbeatJSONRequestBody, ...) (*http.Response, error)

+ func (c *Client) AgentHeartbeatWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

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

+ func (c *Client) TaskPoll(ctx context.Context, body TaskPollJSONRequestBody, ...) (*http.Response, error)

+ func (c *Client) TaskPollWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) UpdateTask(ctx context.Context, taskName TaskName, body UpdateTaskJSONRequestBody, ...) (*http.Response, error)

+ func (c *Client) UpdateTaskWithBody(ctx context.Context, taskName TaskName, contentType string, body io.Reader, ...) (*http.Response, error)

+ type ClientInterface interface

+ AgentAPIPing func(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ AgentHeartbeat func(ctx context.Context, body AgentHeartbeatJSONRequestBody, ...) (*http.Response, error)

+ AgentHeartbeatWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ Health func(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ TaskPoll func(ctx context.Context, body TaskPollJSONRequestBody, ...) (*http.Response, error)

+ TaskPollWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ UpdateTask func(ctx context.Context, taskName TaskName, body UpdateTaskJSONRequestBody, ...) (*http.Response, error)

+ UpdateTaskWithBody func(ctx context.Context, taskName TaskName, contentType string, body io.Reader, ...) (*http.Response, error)

+ type ClientOption func(*Client) error

+ func WithBaseURL(baseURL string) ClientOption

+ func WithHTTPClient(doer HttpRequestDoer) ClientOption

+ func WithRequestEditorFn(fn RequestEditorFn) ClientOption

+ type ClientWithResponses struct

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

+ func (c *ClientWithResponses) AgentAPIPingWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*AgentAPIPingResponse, error)

+ func (c *ClientWithResponses) AgentHeartbeatWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*AgentHeartbeatResponse, error)

+ func (c *ClientWithResponses) AgentHeartbeatWithResponse(ctx context.Context, body AgentHeartbeatJSONRequestBody, ...) (*AgentHeartbeatResponse, error)

+ func (c *ClientWithResponses) HealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthResponse, error)

+ func (c *ClientWithResponses) TaskPollWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*TaskPollResponse, error)

+ func (c *ClientWithResponses) TaskPollWithResponse(ctx context.Context, body TaskPollJSONRequestBody, ...) (*TaskPollResponse, error)

+ func (c *ClientWithResponses) UpdateTaskWithBodyWithResponse(ctx context.Context, taskName TaskName, contentType string, body io.Reader, ...) (*UpdateTaskResponse, error)

+ func (c *ClientWithResponses) UpdateTaskWithResponse(ctx context.Context, taskName TaskName, body UpdateTaskJSONRequestBody, ...) (*UpdateTaskResponse, error)

+ type ClientWithResponsesInterface interface

+ AgentAPIPingWithResponse func(ctx context.Context, reqEditors ...RequestEditorFn) (*AgentAPIPingResponse, error)

+ AgentHeartbeatWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*AgentHeartbeatResponse, error)

+ AgentHeartbeatWithResponse func(ctx context.Context, body AgentHeartbeatJSONRequestBody, ...) (*AgentHeartbeatResponse, error)

+ HealthWithResponse func(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthResponse, error)

+ TaskPollWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*TaskPollResponse, error)

+ TaskPollWithResponse func(ctx context.Context, body TaskPollJSONRequestBody, ...) (*TaskPollResponse, error)

+ UpdateTaskWithBodyWithResponse func(ctx context.Context, taskName TaskName, contentType string, body io.Reader, ...) (*UpdateTaskResponse, error)

+ UpdateTaskWithResponse func(ctx context.Context, taskName TaskName, body UpdateTaskJSONRequestBody, ...) (*UpdateTaskResponse, error)

+ type EnvironmentVariable = []string

+ type HealthResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ func ParseHealthResponse(rsp *http.Response) (*HealthResponse, error)

+ func (r HealthResponse) Status() string

+ func (r HealthResponse) StatusCode() int

+ type HttpRequestDoer interface

+ Do func(req *http.Request) (*http.Response, error)

+ type PoolLabel = string

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

+ type TagPair = []string

+ type TaskName = string

+ type TaskPollInput struct

+ AgentID string

+ PoolLabels []PoolLabel

+ type TaskPollJSONRequestBody = TaskPollInput

+ type TaskPollOutput struct

+ Tags *[]TagPair

+ TaskName *TaskName

+ WorkerEnvironmentVariables *[]EnvironmentVariable

+ WorkerImageURI *string

+ type TaskPollResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *TaskPollOutput

+ func ParseTaskPollResponse(rsp *http.Response) (*TaskPollResponse, error)

+ func (r TaskPollResponse) Status() string

+ func (r TaskPollResponse) StatusCode() int

+ type TaskStatus string

+ const ERROR

+ const RUNNING

+ const STARTING

+ const SUCCEEDED

+ type UpdateTaskInput struct

+ Output *string

+ Status *TaskStatus

+ type UpdateTaskJSONRequestBody = UpdateTaskInput

+ type UpdateTaskResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ func ParseUpdateTaskResponse(rsp *http.Response) (*UpdateTaskResponse, error)

+ func (r UpdateTaskResponse) Status() string

+ func (r UpdateTaskResponse) StatusCode() int