headchef

Documentation

Index

• Variables
• func NewBuildRequest(recipeID, orgID, projID strfmt.UUID, annotations BuildAnnotations) (*headchef_models.V1BuildRequest, error)
• type BuildAnnotations
• type BuildParams
  • func (b *BuildParams) SetTimeout(timeout time.Duration)
  • func (b *BuildParams) WithTimeout(timeout time.Duration) *BuildParams
  • func (b *BuildParams) WriteToRequest(req runtime.ClientRequest, reg strfmt.Registry) error
• type BuildStatus
  • func NewBuildStatus() *BuildStatus
  • func (s *BuildStatus) Close()
• type BuildStatusEnum
• type Client
  • func InitClient(auth *authentication.Auth) *Client
  • func NewClient(apiURL *url.URL, auth *authentication.Auth) *Client
  • func (r *Client) RequestBuild(buildRequest *headchef_models.V1BuildRequest) *BuildStatus
  • func (r *Client) RequestBuildSync(buildRequest *headchef_models.V1BuildRequest) (BuildStatusEnum, *headchef_models.V1BuildStatusResponse, error)

Variables

var (
	ErrBuildResp        = errs.New("Build responded with error")
	ErrBuildUnknownType = errs.New("Unknown build type")
)

Functions

func NewBuildRequest

func NewBuildRequest(recipeID, orgID, projID strfmt.UUID, annotations BuildAnnotations) (*headchef_models.V1BuildRequest, error)

Types

type BuildAnnotations

type BuildAnnotations struct {
	CommitID     string `json:"commit_id"`
	Project      string `json:"project"`
	Organization string `json:"organization"`
}

type BuildParams

type BuildParams struct {
	headchef_operations.StartBuildV1Params

	BuildRequest *headchef_models.V1BuildRequest
	// contains filtered or unexported fields
}

func (*BuildParams) SetTimeout

func (b *BuildParams) SetTimeout(timeout time.Duration)

func (*BuildParams) WithTimeout

func (b *BuildParams) WithTimeout(timeout time.Duration) *BuildParams

func (*BuildParams) WriteToRequest

func (b *BuildParams) WriteToRequest(req runtime.ClientRequest, reg strfmt.Registry) error

type BuildStatus

type BuildStatus struct {
	Started   chan *headchef_models.V1BuildStatusResponse
	Failed    chan string
	Completed chan *headchef_models.V1BuildStatusResponse
	RunError  chan error
}

func NewBuildStatus

func NewBuildStatus() *BuildStatus

func (*BuildStatus) Close

func (s *BuildStatus) Close()

type BuildStatusEnum

type BuildStatusEnum int

const (
	Accepted BuildStatusEnum = iota
	Started
	Completed
	Failed
	Error
)

type Client

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

func InitClient

func InitClient(auth *authentication.Auth) *Client

func NewClient

func NewClient(apiURL *url.URL, auth *authentication.Auth) *Client

func (*Client) RequestBuild

func (r *Client) RequestBuild(buildRequest *headchef_models.V1BuildRequest) *BuildStatus

func (*Client) RequestBuildSync

func (r *Client) RequestBuildSync(buildRequest *headchef_models.V1BuildRequest) (BuildStatusEnum, *headchef_models.V1BuildStatusResponse, error)