project

Documentation

Index

• type CreateProjectInfo
• type ProjectClient
• type ProjectEnvironmentVariable
• type ProjectInfo
• type ProjectRestClient
  • func NewProjectRestClient(config settings.Config) (*ProjectRestClient, error)
  • func (c *ProjectRestClient) CreateEnvironmentVariable(vcs string, org string, project string, v ProjectEnvironmentVariable) (*ProjectEnvironmentVariable, error)
  • func (c *ProjectRestClient) CreateProject(vcs string, org string, name string) (*CreateProjectInfo, error)
  • func (c *ProjectRestClient) GetEnvironmentVariable(vcs string, org string, project string, envName string) (*ProjectEnvironmentVariable, error)
  • func (p *ProjectRestClient) ListAllEnvironmentVariables(vcs, org, project string) ([]*ProjectEnvironmentVariable, error)
  • func (c *ProjectRestClient) ProjectInfo(vcs string, org string, project string) (*ProjectInfo, error)

Types

type CreateProjectInfo

type CreateProjectInfo struct {
	Id      string
	Name    string
	Slug    string
	OrgName string
}

type ProjectClient

type ProjectClient interface {
	ProjectInfo(vcs, org, project string) (*ProjectInfo, error)
	ListAllEnvironmentVariables(vcs, org, project string) ([]*ProjectEnvironmentVariable, error)
	GetEnvironmentVariable(vcs, org, project, envName string) (*ProjectEnvironmentVariable, error)
	CreateEnvironmentVariable(vcs, org, project string, v ProjectEnvironmentVariable) (*ProjectEnvironmentVariable, error)
	CreateProject(vcs, org, project string) (*CreateProjectInfo, error)
}

ProjectClient is the interface to interact with project and it's components.

type ProjectEnvironmentVariable

type ProjectEnvironmentVariable struct {
	Name  string
	Value string
}

ProjectEnvironmentVariable is a Environment Variable of a Project

type ProjectInfo

type ProjectInfo struct {
	Id string
}

ProjectInfo is the info of a Project

type ProjectRestClient

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

func NewProjectRestClient

func NewProjectRestClient(config settings.Config) (*ProjectRestClient, error)

NewProjectRestClient returns a new ProjectRestClient satisfying the api.ProjectInterface interface via the REST API.

func (*ProjectRestClient) CreateEnvironmentVariable

func (c *ProjectRestClient) CreateEnvironmentVariable(vcs string, org string, project string, v ProjectEnvironmentVariable) (*ProjectEnvironmentVariable, error)

CreateEnvironmentVariable creates a variable on the given project. This returns the variable if successfully created.

func (*ProjectRestClient) CreateProject

func (c *ProjectRestClient) CreateProject(vcs string, org string, name string) (*CreateProjectInfo, error)

func (*ProjectRestClient) GetEnvironmentVariable

func (c *ProjectRestClient) GetEnvironmentVariable(vcs string, org string, project string, envName string) (*ProjectEnvironmentVariable, error)

GetEnvironmentVariable retrieves and returns a variable with the given name. If the response status code is 404, nil is returned.

func (*ProjectRestClient) ListAllEnvironmentVariables

func (p *ProjectRestClient) ListAllEnvironmentVariables(vcs, org, project string) ([]*ProjectEnvironmentVariable, error)

ListAllEnvironmentVariables returns all of the environment variables owned by the given project. Note that pagination is not supported - we get all pages of env vars and return them all.

func (*ProjectRestClient) ProjectInfo

func (c *ProjectRestClient) ProjectInfo(vcs string, org string, project string) (*ProjectInfo, error)

ProjectInfo retrieves and returns the project info.