client

package

v1.1.4 Latest Latest Go to latest Published: Oct 21, 2021 License: Apache-2.0 Imports: 10 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/adaptavist/bitbucket_pipelines_client

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

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

func (Client) GetPipeline ¶

func (h Client) GetPipeline(request model.GetPipelineRequest) (pipeline *model.Pipeline, err error)

GetPipeline gets current status of a running pipeline

func (Client) GetPipelineStepLog ¶

func (h Client) GetPipelineStepLog(request model.GetPipelineStepRequest) ([]byte, error)

func (Client) GetPipelineSteps ¶

func (h Client) GetPipelineSteps(request model.GetPipelineRequest) (steps model.PipelineSteps, err error)

GetPipelineSteps will return all steps and their status associated with a given pipeline.

func (Client) GetTag ¶

func (h Client) GetTag(request model.GetTagRequest) (response *model.TagResponse, err error)

func (Client) PostPipeline ¶

func (h Client) PostPipeline(request model.PostPipelineRequest) (pipeline *model.Pipeline, err error)

PostPipeline will post a pipeline but will not wait for the pipeline to complete.

func (Client) RunPipeline ¶

func (h Client) RunPipeline(request model.PostPipelineRequest) (pipeline *model.Pipeline, err error)

RunPipeline will POST the pipeline but will monitor its status until completion.

type Config ¶

type Config struct {
	BaseURL  string
	Username string
	Password string
	// Default workspace used if one isn't provided on request
	Workspace *string
	// Default repository used if one isn't provided
	Repository *string
}

func (Config) GetBaseURL ¶

func (c Config) GetBaseURL() string

func (Config) GetPassword ¶

func (c Config) GetPassword() string

func (Config) GetRepository ¶

func (c Config) GetRepository(r *string) (*string, error)

func (Config) GetUsername ¶

func (c Config) GetUsername() string

func (Config) GetWorkspace ¶

func (c Config) GetWorkspace(w *string) (*string, error)

func (Config) GetWorkspaceAndRepository ¶

func (c Config) GetWorkspaceAndRepository(workspace, repository *string) (w, r *string, err error)

GetWorkspaceAndRepository is a helper to minimise repeating GetWorkspace and GetRepository

Source Files ¶

View all Source files

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