api

Documentation

Index

• Variables
• func OAuthHTTPClient(token TargetToken, insecure bool) *http.Client
• type Client
  • func NewClient(url string, teamClients map[string]*http.Client) *Client
  • func (c Client) DeletePipeline(teamName string, pipelineName string) error
  • func (c Client) PipelineConfig(teamName string, pipelineName string) (atc.Config, string, string, error)
  • func (c Client) Pipelines(teamName string) ([]Pipeline, error)
  • func (c Client) SetPipelineConfig(teamName string, pipelineName string, configVersion string, ...) error
• type ConcourseClient
  • func DefaultNewGCClientFunc(url string, teamName string, httpClient *http.Client) ConcourseClient
• type Pipeline
• type TargetToken
  • func LoginWithBasicAuth(url string, teamName string, username string, password string, insecure bool) (TargetToken, error)

Variables

var NewGCClientFunc func(url string, teamName string, httpClient *http.Client) ConcourseClient = DefaultNewGCClientFunc

Enables mocking out of the go-concourse client during tests.

Functions

func OAuthHTTPClient

func OAuthHTTPClient(token TargetToken, insecure bool) *http.Client

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(url string, teamClients map[string]*http.Client) *Client

func (Client) DeletePipeline

func (c Client) DeletePipeline(teamName string, pipelineName string) error

func (Client) PipelineConfig

func (c Client) PipelineConfig(teamName string, pipelineName string) (atc.Config, string, string, error)

func (Client) Pipelines

func (c Client) Pipelines(teamName string) ([]Pipeline, error)

func (Client) SetPipelineConfig

func (c Client) SetPipelineConfig(
	teamName string,
	pipelineName string,
	configVersion string,
	passedConfig atc.Config,
) error

type ConcourseClient

type ConcourseClient interface {
	DeletePipeline(pipelineName string) (bool, error)
	ListPipelines() ([]atc.Pipeline, error)
	PipelineConfig(pipelineName string) (atc.Config, atc.RawConfig, string, bool, error)
	CreateOrUpdatePipelineConfig(pipelineName string, configVersion string, passedConfig atc.Config) (bool, bool, []gc.ConfigWarning, error)
}

func DefaultNewGCClientFunc

func DefaultNewGCClientFunc(url string, teamName string, httpClient *http.Client) ConcourseClient

type Pipeline

type Pipeline struct {
	Name     string `json:"name"`
	URL      string `json:"url"`
	TeamName string `json:"team_name"`
}

type TargetToken

type TargetToken struct {
	Type  string
	Value string
}

func LoginWithBasicAuth

func LoginWithBasicAuth(
	url string,
	teamName string,
	username string,
	password string,
	insecure bool,
) (TargetToken, error)