fn

package

v0.0.0-...-d52247b Latest Latest Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 17 Imported by: 4

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/fnproject/cli

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func BashCompleteFns(c *cli.Context)
func Create() cli.Command
func CreateFn(r *fnclient.Fn, appID string, fn *models.Fn) (*models.Fn, error)
func Delete() cli.Command
func GetConfig() cli.Command
func GetFnByName(client *fnclient.Fn, appID, fnName string) (*models.Fn, error)
func Inspect() cli.Command
func List() cli.Command
func ListConfig() cli.Command
func PutFn(f *fnclient.Fn, fnID string, fn *models.Fn) error
func SetConfig() cli.Command
func UnsetConfig() cli.Command
func Update() cli.Command
func WithFlags(c *cli.Context, fn *models.Fn)
func WithFuncFileV20180708(ff *common.FuncFileV20180708, fn *models.Fn) error
func WithSlash(p string) string
func WithoutSlash(p string) string
type NameNotFoundError
- func (n NameNotFoundError) Error() string

Constants ¶

This section is empty.

Variables ¶

View Source

var FnFlags = []cli.Flag{
	cli.Uint64Flag{
		Name:  "memory,m",
		Usage: "Memory in MiB",
	},
	cli.StringSliceFlag{
		Name:  "config,c",
		Usage: "Function configuration",
	},
	cli.IntFlag{
		Name:  "timeout",
		Usage: "Function timeout (eg. 30)",
	},
	cli.IntFlag{
		Name:  "idle-timeout",
		Usage: "Function idle timeout (eg. 30)",
	},
	cli.StringSliceFlag{
		Name:  "annotation",
		Usage: "Function annotation (can be specified multiple times)",
	},
	cli.StringFlag{
		Name:  "image",
		Usage: "Function image",
	},
}

FnFlags used to create/update functions

Functions ¶

func BashCompleteFns ¶

func BashCompleteFns(c *cli.Context)

BashCompleteFns can be called from a BashComplete function to provide function completion suggestions (Assumes the current context already contains an app name as an argument. This should be confirmed before calling this)

func Create ¶

func Create() cli.Command

Create function command

func CreateFn ¶

func CreateFn(r *fnclient.Fn, appID string, fn *models.Fn) (*models.Fn, error)

CreateFn request

func Delete ¶

func Delete() cli.Command

Delete function command

func GetConfig ¶

func GetConfig() cli.Command

GetConfig for function command

func GetFnByName ¶

func GetFnByName(client *fnclient.Fn, appID, fnName string) (*models.Fn, error)

GetFnByName looks up a fn by name using the given client

func Inspect ¶

func Inspect() cli.Command

Inspect function command

func List ¶

func List() cli.Command

List functions command

func ListConfig ¶

func ListConfig() cli.Command

ListConfig for function command

func PutFn ¶

func PutFn(f *fnclient.Fn, fnID string, fn *models.Fn) error

PutFn updates the fn with the given ID using the content of the provided fn

func SetConfig ¶

func SetConfig() cli.Command

SetConfig for function command

func UnsetConfig ¶

func UnsetConfig() cli.Command

UnsetConfig for function command

func Update ¶

func Update() cli.Command

Update function command

func WithFlags ¶

func WithFlags(c *cli.Context, fn *models.Fn)

WithFlags returns a function with specified flags

func WithFuncFileV20180708 ¶

func WithFuncFileV20180708(ff *common.FuncFileV20180708, fn *models.Fn) error

WithFuncFileV20180708 used when creating a function from a funcfile

func WithSlash ¶

func WithSlash(p string) string

WithSlash appends "/" to function path

func WithoutSlash ¶

func WithoutSlash(p string) string

WithoutSlash removes "/" from function path

Types ¶

type NameNotFoundError ¶

type NameNotFoundError struct {
	Name string
}

NameNotFoundError error for app not found when looked up by name

func (NameNotFoundError) Error ¶

func (n NameNotFoundError) Error() string

Source Files ¶

View all Source files

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