concourse

package
v6.7.3-0...-1f455d7 Latest Latest
Warning

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

Go to latest
Published: Dec 7, 2020 License: Apache-2.0, Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrDestroyRefused = errors.New("not-permitted-to-destroy-as-requested")
View Source
var ErrForbidden = internal.ForbiddenError{}

ErrForbidden is returned for 403 response codes.

View Source
var ErrUnauthorized = internal.ErrUnauthorized

ErrUnauthorized is returned for 401 response codes.

Functions

This section is empty.

Types

type Client

type Client interface {
	URL() string
	HTTPClient() *http.Client
	Builds(Page) ([]atc.Build, Pagination, error)
	Build(buildID string) (atc.Build, bool, error)
	BuildEvents(buildID string) (Events, error)
	BuildResources(buildID int) (atc.BuildInputsOutputs, bool, error)
	ListBuildArtifacts(buildID string) ([]atc.WorkerArtifact, error)
	AbortBuild(buildID string) error
	BuildPlan(buildID int) (atc.PublicBuildPlan, bool, error)
	SaveWorker(atc.Worker, *time.Duration) (*atc.Worker, error)
	ListWorkers() ([]atc.Worker, error)
	PruneWorker(workerName string) error
	LandWorker(workerName string) error
	GetInfo() (atc.Info, error)
	GetCLIReader(arch, platform string) (io.ReadCloser, http.Header, error)
	ListPipelines() ([]atc.Pipeline, error)
	ListAllJobs() ([]atc.Job, error)
	ListTeams() ([]atc.Team, error)
	FindTeam(teamName string) (Team, error)
	Team(teamName string) Team
	UserInfo() (atc.UserInfo, error)
	ListActiveUsersSince(since time.Time) ([]atc.User, error)
}

func NewClient

func NewClient(apiURL string, httpClient *http.Client, tracing bool) Client

type ConfigWarning

type ConfigWarning struct {
	Type    string `json:"type"`
	Message string `json:"message"`
}

type Events

type Events interface {
	NextEvent() (atc.Event, error)
	Close() error
}

type GenericError

type GenericError struct {
	Message string
}

GenericError is used when no more specific error is available, i.e. a generic 500 Internal Server Error response with a message in the body.

func (GenericError) Error

func (err GenericError) Error() string

Error just returns the message from the response body.

type InvalidConfigError

type InvalidConfigError struct {
	Errors []string `json:"errors"`
}

InvalidConfigError is returned when saving a pipeline returns errors (i.e. validation failures).

func (InvalidConfigError) Error

func (c InvalidConfigError) Error() string

Error lists the errors returned for the config.

type Page

type Page struct {
	From       int
	To         int
	Limit      int
	Timestamps bool
}

func (Page) QueryParams

func (p Page) QueryParams() url.Values

type Pagination

type Pagination struct {
	Next     *Page
	Previous *Page
}

type PruneWorkerError

type PruneWorkerError struct {
	atc.PruneWorkerResponseBody
}

func (PruneWorkerError) Error

func (e PruneWorkerError) Error() string

type Team

type Team interface {
	Name() string
	ID() int
	Auth() atc.TeamAuth
	ATCTeam() atc.Team

	CreateOrUpdate(team atc.Team) (atc.Team, bool, bool, []ConfigWarning, error)
	RenameTeam(teamName, name string) (bool, []ConfigWarning, error)
	DestroyTeam(teamName string) error

	Pipeline(pipelineRef atc.PipelineRef) (atc.Pipeline, bool, error)
	PipelineBuilds(pipelineRef atc.PipelineRef, page Page) ([]atc.Build, Pagination, bool, error)
	DeletePipeline(pipelineRef atc.PipelineRef) (bool, error)
	PausePipeline(pipelineRef atc.PipelineRef) (bool, error)
	ArchivePipeline(pipelineRef atc.PipelineRef) (bool, error)
	UnpausePipeline(pipelineRef atc.PipelineRef) (bool, error)
	ExposePipeline(pipelineRef atc.PipelineRef) (bool, error)
	HidePipeline(pipelineRef atc.PipelineRef) (bool, error)
	RenamePipeline(pipelineRef atc.PipelineRef, name string) (bool, []ConfigWarning, error)
	ListPipelines() ([]atc.Pipeline, error)
	PipelineConfig(pipelineRef atc.PipelineRef) (atc.Config, string, bool, error)
	CreateOrUpdatePipelineConfig(pipelineRef atc.PipelineRef, configVersion string, passedConfig []byte, checkCredentials bool) (bool, bool, []ConfigWarning, error)

	CreatePipelineBuild(pipelineRef atc.PipelineRef, plan atc.Plan) (atc.Build, error)

	BuildInputsForJob(pipelineRef atc.PipelineRef, jobName string) ([]atc.BuildInput, bool, error)

	Job(pipelineRef atc.PipelineRef, jobName string) (atc.Job, bool, error)
	JobBuild(pipelineRef atc.PipelineRef, jobName, buildName string) (atc.Build, bool, error)
	JobBuilds(pipelineRef atc.PipelineRef, jobName string, page Page) ([]atc.Build, Pagination, bool, error)
	CreateJobBuild(pipelineRef atc.PipelineRef, jobName string) (atc.Build, error)
	RerunJobBuild(pipelineRef atc.PipelineRef, jobName string, buildName string) (atc.Build, error)
	ListJobs(pipelineRef atc.PipelineRef) ([]atc.Job, error)
	ScheduleJob(pipelineRef atc.PipelineRef, jobName string) (bool, error)

	PauseJob(pipelineRef atc.PipelineRef, jobName string) (bool, error)
	UnpauseJob(pipelineRef atc.PipelineRef, jobName string) (bool, error)

	ClearTaskCache(pipelineRef atc.PipelineRef, jobName string, stepName string, cachePath string) (int64, error)

	Resource(pipelineRef atc.PipelineRef, resourceName string) (atc.Resource, bool, error)
	ListResources(pipelineRef atc.PipelineRef) ([]atc.Resource, error)
	VersionedResourceTypes(pipelineRef atc.PipelineRef) (atc.VersionedResourceTypes, bool, error)
	ResourceVersions(pipelineRef atc.PipelineRef, resourceName string, page Page, filter atc.Version) ([]atc.ResourceVersion, Pagination, bool, error)
	CheckResource(pipelineRef atc.PipelineRef, resourceName string, version atc.Version) (atc.Build, bool, error)
	CheckResourceType(pipelineRef atc.PipelineRef, resourceTypeName string, version atc.Version) (atc.Build, bool, error)
	DisableResourceVersion(pipelineRef atc.PipelineRef, resourceName string, resourceVersionID int) (bool, error)
	EnableResourceVersion(pipelineRef atc.PipelineRef, resourceName string, resourceVersionID int) (bool, error)

	PinResourceVersion(pipelineRef atc.PipelineRef, resourceName string, resourceVersionID int) (bool, error)
	UnpinResource(pipelineRef atc.PipelineRef, resourceName string) (bool, error)
	SetPinComment(pipelineRef atc.PipelineRef, resourceName string, comment string) (bool, error)

	BuildsWithVersionAsInput(pipelineRef atc.PipelineRef, resourceName string, resourceVersionID int) ([]atc.Build, bool, error)
	BuildsWithVersionAsOutput(pipelineRef atc.PipelineRef, resourceName string, resourceVersionID int) ([]atc.Build, bool, error)

	ListContainers(queryList map[string]string) ([]atc.Container, error)
	GetContainer(id string) (atc.Container, error)
	ListVolumes() ([]atc.Volume, error)
	CreateBuild(plan atc.Plan) (atc.Build, error)
	Builds(page Page) ([]atc.Build, Pagination, error)
	OrderingPipelines(pipelineRefs atc.OrderPipelinesRequest) error

	CreateArtifact(io.Reader, string, []string) (atc.WorkerArtifact, error)
	GetArtifact(int) (io.ReadCloser, error)
}

Directories

Path Synopsis
Code generated by counterfeiter.
Code generated by counterfeiter.
eventstreamfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
internalfakes
Code generated by counterfeiter.
Code generated by counterfeiter.

Jump to

Keyboard shortcuts

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