workspace

Documentation

Index

• Variables
• func GetWorkspaceEnvVars(workspace *Workspace, params WorkspaceEnvVarParams, telemetryEnabled bool) map[string]string
• func IsWorkspaceNotFound(err error) bool
• type Store
• type Workspace
  • func (w *Workspace) GetProject(projectName string) (*project.Project, error)
• type WorkspaceEnvVarParams
• type WorkspaceInfo

Variables

var (
	ErrWorkspaceNotFound = errors.New("workspace not found")
)

Functions

func GetWorkspaceEnvVars

func GetWorkspaceEnvVars(workspace *Workspace, params WorkspaceEnvVarParams, telemetryEnabled bool) map[string]string

func IsWorkspaceNotFound

func IsWorkspaceNotFound(err error) bool

Types

type Store

type Store interface {
	List() ([]*Workspace, error)
	Find(idOrName string) (*Workspace, error)
	Save(workspace *Workspace) error
	Delete(workspace *Workspace) error
}

type Workspace

type Workspace struct {
	Id       string             `json:"id" validate:"required"`
	Name     string             `json:"name" validate:"required"`
	Projects []*project.Project `json:"projects" validate:"required"`
	Target   string             `json:"target" validate:"required"`
	ApiKey   string             `json:"-"`
	EnvVars  map[string]string  `json:"-"`

} // @name Workspace

func (*Workspace) GetProject

func (w *Workspace) GetProject(projectName string) (*project.Project, error)

type WorkspaceEnvVarParams

type WorkspaceEnvVarParams struct {
	ApiUrl        string
	ServerUrl     string
	ServerVersion string
	ClientId      string
}

type WorkspaceInfo

type WorkspaceInfo struct {
	Name             string                 `json:"name" validate:"required"`
	Projects         []*project.ProjectInfo `json:"projects" validate:"required"`
	ProviderMetadata string                 `json:"providerMetadata,omitempty" validate:"optional"`

} // @name WorkspaceInfo