api

package

v0.6.3 Latest Latest Go to latest Published: Jun 11, 2026 License: MPL-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/leg100/otf

Documentation ¶

Index ¶

type API
- func (a *API) AddHandlers(r *mux.Router)
type Client
type RunnerClient
type TFEAPI
- func (a *TFEAPI) AddHandlers(r *mux.Router)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

type API struct {
	*tfeapi.Responder
	Client apiClient
}

func (*API) AddHandlers ¶

func (a *API) AddHandlers(r *mux.Router)

type Client ¶

type Client struct {
	*otfhttp.Client
	// contains filtered or unexported fields
}

client accesses the service endpoints via RPC.

func (*Client) AwaitAllocatedJobs ¶

func (c *Client) AwaitAllocatedJobs(ctx context.Context, agentID resource.TfeID) ([]*runner.Job, error)

func (*Client) AwaitJobSignal ¶

func (c *Client) AwaitJobSignal(ctx context.Context, jobID resource.TfeID) func() (runner.JobSignal, error)

func (*Client) CreateAgentToken ¶

func (c *Client) CreateAgentToken(ctx context.Context, poolID resource.TfeID, opts runner.CreateAgentTokenOptions) (*runner.AgentToken, []byte, error)

func (*Client) FinishJob ¶

func (c *Client) FinishJob(ctx context.Context, jobID resource.TfeID, opts runner.FinishJobOptions) error

func (*Client) GenerateDynamicCredentialsToken ¶

func (c *Client) GenerateDynamicCredentialsToken(ctx context.Context, jobID resource.TfeID, audience string) ([]byte, error)

func (*Client) GetJob ¶

func (c *Client) GetJob(ctx context.Context, jobID resource.TfeID) (*runner.Job, error)

func (*Client) Register ¶

func (c *Client) Register(ctx context.Context, opts runner.RegisterRunnerOptions) (*runner.RunnerMeta, error)

func (*Client) StartJob ¶

func (c *Client) StartJob(ctx context.Context, jobID resource.TfeID) ([]byte, error)

func (*Client) UpdateStatus ¶

func (c *Client) UpdateStatus(ctx context.Context, agentID resource.TfeID, status runner.RunnerStatus) error

type RunnerClient ¶

type RunnerClient = Client

Alias client to permit embedding it with other clients in a struct without a name clash.

type TFEAPI ¶

type TFEAPI struct {
	*tfeapi.Responder
	Client tfeClient
}

func (*TFEAPI) AddHandlers ¶

func (a *TFEAPI) AddHandlers(r *mux.Router)

Source Files ¶

View all Source files

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