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.ErrForbidden
ErrForbidden is returned for 403 response codes.
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)
Check(checkID string) (atc.Check, bool, error)
}
type ConfigWarning ¶
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 ¶
func (Page) QueryParams ¶
type Pagination ¶
type PruneWorkerError ¶
type PruneWorkerError struct {
atc.PruneWorkerResponseBody
}
func (PruneWorkerError) Error ¶
func (e PruneWorkerError) Error() string
type Team ¶
type Team interface {
Name() string
Auth() atc.TeamAuth
CreateOrUpdate(team atc.Team) (atc.Team, bool, bool, []ConfigWarning, error)
RenameTeam(teamName, name string) (bool, []ConfigWarning, error)
DestroyTeam(teamName string) error
Pipeline(name string) (atc.Pipeline, bool, error)
PipelineBuilds(pipelineName string, page Page) ([]atc.Build, Pagination, bool, error)
DeletePipeline(pipelineName string) (bool, error)
PausePipeline(pipelineName string) (bool, error)
ArchivePipeline(pipelineName string) (bool, error)
UnpausePipeline(pipelineName string) (bool, error)
ExposePipeline(pipelineName string) (bool, error)
HidePipeline(pipelineName string) (bool, error)
RenamePipeline(pipelineName, name string) (bool, []ConfigWarning, error)
ListPipelines() ([]atc.Pipeline, error)
PipelineConfig(pipelineName string) (atc.Config, string, bool, error)
CreateOrUpdatePipelineConfig(pipelineName string, configVersion string, passedConfig []byte, checkCredentials bool) (bool, bool, []ConfigWarning, error)
CreatePipelineBuild(pipelineName string, plan atc.Plan) (atc.Build, error)
BuildInputsForJob(pipelineName string, jobName string) ([]atc.BuildInput, bool, error)
Job(pipelineName, jobName string) (atc.Job, bool, error)
JobBuild(pipelineName, jobName, buildName string) (atc.Build, bool, error)
JobBuilds(pipelineName string, jobName string, page Page) ([]atc.Build, Pagination, bool, error)
CreateJobBuild(pipelineName string, jobName string) (atc.Build, error)
RerunJobBuild(pipelineName string, jobName string, buildName string) (atc.Build, error)
ListJobs(pipelineName string) ([]atc.Job, error)
ScheduleJob(pipelineName string, jobName string) (bool, error)
PauseJob(pipelineName string, jobName string) (bool, error)
UnpauseJob(pipelineName string, jobName string) (bool, error)
ClearTaskCache(pipelineName string, jobName string, stepName string, cachePath string) (int64, error)
Resource(pipelineName string, resourceName string) (atc.Resource, bool, error)
ListResources(pipelineName string) ([]atc.Resource, error)
VersionedResourceTypes(pipelineName string) (atc.VersionedResourceTypes, bool, error)
ResourceVersions(pipelineName string, resourceName string, page Page, filter atc.Version) ([]atc.ResourceVersion, Pagination, bool, error)
CheckResource(pipelineName string, resourceName string, version atc.Version) (atc.Check, bool, error)
CheckResourceType(pipelineName string, resourceTypeName string, version atc.Version) (atc.Check, bool, error)
DisableResourceVersion(pipelineName string, resourceName string, resourceVersionID int) (bool, error)
EnableResourceVersion(pipelineName string, resourceName string, resourceVersionID int) (bool, error)
PinResourceVersion(pipelineName string, resourceName string, resourceVersionID int) (bool, error)
UnpinResource(pipelineName string, resourceName string) (bool, error)
SetPinComment(pipelineName string, resourceName string, comment string) (bool, error)
BuildsWithVersionAsInput(pipelineName string, resourceName string, resourceVersionID int) ([]atc.Build, bool, error)
BuildsWithVersionAsOutput(pipelineName string, 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(pipelineNames []string) error
CreateArtifact(io.Reader, string) (atc.WorkerArtifact, error)
GetArtifact(int) (io.ReadCloser, error)
}
Source Files
¶
- artifacts.go
- build_inputs.go
- build_outputs_of.go
- build_plan.go
- build_resources.go
- builds.go
- check.go
- check_resource.go
- check_resource_type.go
- cli.go
- client.go
- configs.go
- containers.go
- errors.go
- events.go
- info.go
- jobs.go
- pagination.go
- pipelines.go
- resource.go
- resourceversions.go
- team.go
- teams.go
- user.go
- users.go
- version_resource_types.go
- volumes.go
- workers.go
Directories
¶
| Path | Synopsis |
|---|---|
|
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
eventstreamfakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
Click to show internal directories.
Click to hide internal directories.