projects

Documentation

Index

• Variables
• type Client
  • func New(wectx config.Context) *Client
  • func (c *Client) Create(ctx context.Context, project Project) (p Project, err error)
  • func (c *Client) CreateOrUpdate(ctx context.Context, project Project) (pRec Project, created bool, err error)
  • func (c *Client) Get(ctx context.Context, id string) (project Project, err error)
  • func (c *Client) GetDeploymentOrder(ctx context.Context, projectID, groupUID string) (order []string, err error)
  • func (c *Client) GetWithServices(ctx context.Context, id string) (project Project, err error)
  • func (c *Client) List(ctx context.Context) (list []Project, err error)
  • func (c *Client) ListWithServices(ctx context.Context) (list []Project, err error)
  • func (c *Client) Unlink(ctx context.Context, projectID string) error
  • func (c *Client) Update(ctx context.Context, project Project) (p Project, err error)
• type Project

Variables

var (
	// ErrProjectNotFound happens when a project.json is not found
	ErrProjectNotFound = errors.New("Project not found")

	// ErrProjectAlreadyExists happens when a Project ID already exists
	ErrProjectAlreadyExists = errors.New("Project already exists")

	// ErrInvalidProjectID happens when a Project ID is invalid
	ErrInvalidProjectID = errors.New("Invalid project ID")

	// ErrEmptyProjectID happens when trying to access a project, but providing an empty ID
	ErrEmptyProjectID = errors.New("Can not get project: ID is empty")
)

Types

type Client

type Client struct {
	*apihelper.Client
}

Client for the projects

func New

func New(wectx config.Context) *Client

New Client

func (*Client) Create

func (c *Client) Create(ctx context.Context, project Project) (p Project, err error)

Create on the backend

func (*Client) CreateOrUpdate

func (c *Client) CreateOrUpdate(ctx context.Context, project Project) (pRec Project, created bool, err error)

CreateOrUpdate project

func (*Client) Get

func (c *Client) Get(ctx context.Context, id string) (project Project, err error)

Get project by ID

func (*Client) GetDeploymentOrder

func (c *Client) GetDeploymentOrder(ctx context.Context, projectID, groupUID string) (order []string, err error)

GetDeploymentOrder gets the order of a given deployment

func (*Client) GetWithServices

func (c *Client) GetWithServices(ctx context.Context, id string) (project Project, err error)

GetWithServices project by ID with a list of its services

func (*Client) List

func (c *Client) List(ctx context.Context) (list []Project, err error)

List projects

func (*Client) ListWithServices

func (c *Client) ListWithServices(ctx context.Context) (list []Project, err error)

ListWithServices projects with a list of its services

func (*Client) Unlink

func (c *Client) Unlink(ctx context.Context, projectID string) error

Unlink project

func (*Client) Update

func (c *Client) Update(ctx context.Context, project Project) (p Project, err error)

Update project

type Project

type Project struct {
	ProjectID   string `json:"projectId"`
	Health      string `json:"health,omitempty"`
	Description string `json:"description,omitempty"`

	Services services.Services `json:"services,omitempty"`
}

Project structure