project

Documentation

Overview

Package project implements multi-function operations.

Index

• Constants
• Variables
• type Config
• type Project
  • func (p *Project) Clean(names []string) error
  • func (p *Project) Delete(names []string) error
  • func (p *Project) Deploy(names []string) error
  • func (p *Project) DeployAndClean(names []string) error
  • func (p *Project) FunctionByName(name string) (*function.Function, error)
  • func (p *Project) FunctionDirNames() (list []string, err error)
  • func (p *Project) FunctionNames() (list []string)
  • func (p *Project) Open() error
  • func (p *Project) SetEnv(name, value string)

Constants

const (
	// DefaultMemory defines default memory value (MB) for every function in a project
	DefaultMemory = 128
	// DefaultTimeout defines default timeout value (s) for every function in a project
	DefaultTimeout = 3
)

Variables

var ErrNotFound = errors.New("project: no function found")

ErrNotFound is returned when a function cannot be found.

Types

type Config

type Config struct {
	Name         string `json:"name" validate:"nonzero"`
	Description  string `json:"description"`
	Runtime      string `json:"runtime"`
	Memory       int64  `json:"memory"`
	Timeout      int64  `json:"timeout"`
	Role         string `json:"role"`
	NameTemplate string `json:"nameTemplate"`
}

Config for project.

type Project

type Project struct {
	Config
	Path        string
	Concurrency int
	Log         log.Interface
	Service     lambdaiface.LambdaAPI
	Functions   []*function.Function
	// contains filtered or unexported fields
}

Project represents zero or more Lambda functions.

func (*Project) Clean

func (p *Project) Clean(names []string) error

Clean up function build artifacts.

func (*Project) Delete

func (p *Project) Delete(names []string) error

Delete functions.

func (*Project) Deploy

func (p *Project) Deploy(names []string) error

Deploy functions and their configurations.

func (*Project) DeployAndClean

func (p *Project) DeployAndClean(names []string) error

DeployAndClean deploys functions and then cleans up their build artifacts.

func (*Project) FunctionByName

func (p *Project) FunctionByName(name string) (*function.Function, error)

FunctionByName returns a function by `name` or returns ErrNotFound.

func (*Project) FunctionDirNames

func (p *Project) FunctionDirNames() (list []string, err error)

FunctionDirNames returns a list of function directory names.

func (*Project) FunctionNames

func (p *Project) FunctionNames() (list []string)

FunctionNames returns a list of function names sans-directory.

func (*Project) Open

func (p *Project) Open() error

Open the project.json file and prime the config.

func (*Project) SetEnv

func (p *Project) SetEnv(name, value string)

SetEnv sets environment variable `name` to `value` on every function in project.