Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v2

v2.9.0-rc.1

Jun 16, 2026

v2.8.1

Jun 15, 2026

v2.8.1-rc.2

Jun 12, 2026

v2.8.1-rc.1

Jun 9, 2026

v2.8.0

Jun 5, 2026

v2.7.0

May 29, 2026

Changes in this version

type Client

+ UploadBaseURL string

+ func (c *Client) UploadTestResults(ctx context.Context, token string, filePath string, format string, ...) error

type ClientConfig

+ UploadBaseURL string

v2.7.0-rc.1

May 28, 2026

v2.6.0

May 20, 2026

Changes in this version

type Client

+ ServerBaseURL string

type ClientConfig

+ ServerBaseURL string

v2.6.0-rc.1

May 19, 2026

v2.5.1

May 15, 2026

Changes in this version

+ var ErrRetryTimeout = errors.New("request retry timeout")

+ type AuthError struct

+ Message string

+ func (e *AuthError) Error() string

+ type BadRequestError struct

+ Message string

+ func (e *BadRequestError) Error() string

+ type BillingError struct

+ Message string

+ func (e *BillingError) Error() string

+ type Client struct

+ OrganizationSlug string

+ ServerBaseUrl string

+ func NewClient(cfg ClientConfig) *Client

+ func (c *Client) DoWithRetry(ctx context.Context, reqOptions httpRequest, v interface{}) (*http.Response, error)

+ func (c Client) CreateTestPlan(ctx context.Context, suiteSlug string, params TestPlanParams) (plan.TestPlan, error)

+ func (c Client) FetchCommitList(ctx context.Context, suiteSlug string, days int) ([]string, error)

+ func (c Client) FetchFilesTiming(ctx context.Context, suiteSlug string, files []string) (map[string]time.Duration, error)

+ func (c Client) FetchTestPlan(ctx context.Context, suiteSlug string, identifier string, jobRetryCount int) (*plan.TestPlan, error)

+ func (c Client) FilterTests(ctx context.Context, suiteSlug string, params FilterTestsParams) ([]FilteredTest, error)

+ func (c Client) PostTestPlanMetadata(ctx context.Context, suiteSlug string, identifier string, ...) error

+ func (c Client) PresignUpload(ctx context.Context, suiteSlug string) (PresignedUploadResponse, error)

+ type ClientConfig struct

+ AccessToken string

+ OrganizationSlug string

+ ServerBaseUrl string

+ type FilterTestsParams struct

+ Env *config.Config

+ Files []plan.TestCase

+ type FilteredTest struct

+ Path string

+ type FilteredTestResponse struct

+ Tests []FilteredTest

+ type ForbiddenError struct

+ Message string

+ func (e *ForbiddenError) Error() string

+ type NotFoundError struct

+ Message string

+ func (e *NotFoundError) Error() string

+ type PresignedUploadResponse struct

+ Form upload.PresignedUploadForm

+ URI string

+ type SelectionParams struct

+ Params map[string]string

+ Strategy string

+ type TestPlanMetadataParams struct

+ Env *config.Config

+ Statistics runner.RunStatistics

+ Timeline []Timeline

+ Version string

+ type TestPlanParams struct

+ Branch string

+ Identifier string

+ MaxParallelism int

+ Metadata map[string]string

+ Parallelism int

+ Runner string

+ Selection *SelectionParams

+ TargetTime float64

+ Tests TestPlanParamsTest

+ type TestPlanParamsTest struct

+ Examples []plan.TestCase

+ Files []plan.TestCase

+ type Timeline struct

+ Event string

+ Timestamp string

+ type UnprocessableEntityError struct

+ Message string

+ func (e *UnprocessableEntityError) Error() string

Other modules containing this package

github.com/buildkite/test-engine-client