faas

Documentation

Index

• func Start(f NitricFunction) error
• func StartWithClient(f NitricFunction, faasClient pb.FaasClient) error
• type HttpResponseContext
• type NitricFunction
• type NitricHttpTriggerContext
• type NitricResponse
  • func (n *NitricResponse) GetContext() *ResponseContext
  • func (n *NitricResponse) SetData(data []byte)
  • func (n *NitricResponse) ToTriggerResponse() *pb.TriggerResponse
• type NitricTopicTriggerContext
• type NitricTrigger
  • func FromGrpcTriggerRequest(triggerReq *pb.TriggerRequest) (*NitricTrigger, error)
  • func (n *NitricTrigger) DefaultResponse() *NitricResponse
  • func (n *NitricTrigger) GetContext() *NitricTriggerContext
  • func (n *NitricTrigger) GetData() []byte
  • func (n *NitricTrigger) GetDataAsStruct(object interface{}) error
  • func (n *NitricTrigger) GetMimeType() string
• type NitricTriggerContext
  • func ContextFromTriggerRequest(grpcTrigger *pb.TriggerRequest) *NitricTriggerContext
  • func (c *NitricTriggerContext) AsHttp() *NitricHttpTriggerContext
  • func (c *NitricTriggerContext) AsTopic() *NitricTopicTriggerContext
  • func (c *NitricTriggerContext) IsHttp() bool
  • func (c *NitricTriggerContext) IsTopic() bool
• type ResponseContext
  • func (c *ResponseContext) AsHttp() *HttpResponseContext
  • func (c *ResponseContext) AsTopic() *TopicResponseContext
  • func (c *ResponseContext) IsHttp() bool
  • func (c *ResponseContext) IsTopic() bool
• type TopicResponseContext

Functions

func Start

func Start(f NitricFunction) error

Start - Starts accepting requests for the provided NitricFunction Begins streaming using the default Nitric FaaS gRPC client This should be the only method called in the 'main' method of your entrypoint package

func StartWithClient

func StartWithClient(f NitricFunction, faasClient pb.FaasClient) error

Types

type HttpResponseContext

type HttpResponseContext struct {
	Headers map[string]string
	Status  int
}

type NitricFunction

type NitricFunction func(*NitricTrigger) (*NitricResponse, error)

NitricFunction - a function built using Nitric, to be executed

type NitricHttpTriggerContext

type NitricHttpTriggerContext struct {
	Method      string
	Headers     map[string]string
	Path        string
	QueryParams map[string]string
}

type NitricResponse

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

NitricResponse - represents the results of calling a function.

func (*NitricResponse) GetContext

func (n *NitricResponse) GetContext() *ResponseContext

func (*NitricResponse) SetData

func (n *NitricResponse) SetData(data []byte)

func (*NitricResponse) ToTriggerResponse

func (n *NitricResponse) ToTriggerResponse() *pb.TriggerResponse

ToTriggerResponse - Tranlates a Nitric Response for gRPC transport to the membrane

type NitricTopicTriggerContext

type NitricTopicTriggerContext struct {
	Topic string
}

type NitricTrigger

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

NitricRequest - represents a request to trigger a function, with payload and context required to execute that function.

func FromGrpcTriggerRequest

func FromGrpcTriggerRequest(triggerReq *pb.TriggerRequest) (*NitricTrigger, error)

FromGrpcTriggerRequest - converts a standard nitric TriggerRequest request into a Trigger to be passed to functions.

func (*NitricTrigger) DefaultResponse

func (n *NitricTrigger) DefaultResponse() *NitricResponse

DefaultResponse - Returns a default response object dependent on the Trigger context

func (*NitricTrigger) GetContext

func (n *NitricTrigger) GetContext() *NitricTriggerContext

GetContext - return the context of a request, with metadata about that request.

func (*NitricTrigger) GetData

func (n *NitricTrigger) GetData() []byte

GetData - return the []byte data of the request.

func (*NitricTrigger) GetDataAsStruct

func (n *NitricTrigger) GetDataAsStruct(object interface{}) error

GetDataAsStruct - Unmarshals the request body from JSON to the provided interface{}

func (*NitricTrigger) GetMimeType

func (n *NitricTrigger) GetMimeType() string

GetMimeType - return the mime-type of the data for this trigger

type NitricTriggerContext

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

NitricTriggerContext - Represents the contextual metadata for a Nitric function request.

func ContextFromTriggerRequest

func ContextFromTriggerRequest(grpcTrigger *pb.TriggerRequest) *NitricTriggerContext

ContextFromTriggerRequest - Creates TriggerContext from grpc TriggerRequest

func (*NitricTriggerContext) AsHttp

func (c *NitricTriggerContext) AsHttp() *NitricHttpTriggerContext

AsHttp - Returns NitricTriggerContext as NitricHttpTriggerContext if IsHttp is true otherwise returns nil

func (*NitricTriggerContext) AsTopic

func (c *NitricTriggerContext) AsTopic() *NitricTopicTriggerContext

AsTopic - Returns NitricTriggerContext as NitricTopicTriggerContext if IsTopic is true otherwise returns nil

func (*NitricTriggerContext) IsHttp

func (c *NitricTriggerContext) IsHttp() bool

IsHttp - Returns true if the trigger was via an HTTP Request and HTTP metadata is available

func (*NitricTriggerContext) IsTopic

func (c *NitricTriggerContext) IsTopic() bool

IsTopic - Returns true if the trigger was an Event via a Topic and Event/Topic metadata is available

type ResponseContext

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

ResponseContext

func (*ResponseContext) AsHttp

func (c *ResponseContext) AsHttp() *HttpResponseContext

func (*ResponseContext) AsTopic

func (c *ResponseContext) AsTopic() *TopicResponseContext

func (*ResponseContext) IsHttp

func (c *ResponseContext) IsHttp() bool

func (*ResponseContext) IsTopic

func (c *ResponseContext) IsTopic() bool

type TopicResponseContext

type TopicResponseContext struct {
	Success bool
}