triggers

Documentation

Index

• type Event
  • func (*Event) GetTriggerType() TriggerType
• type HttpRequest
  • func FromHttpRequest(ctx *fasthttp.RequestCtx) *HttpRequest
  • func (*HttpRequest) GetTriggerType() TriggerType
• type HttpResponse
  • func FromHttpResponse(resp *fasthttp.Response) *HttpResponse
  • func FromTriggerResponse(triggerResponse *pb.TriggerResponse) (*HttpResponse, error)
• type Trigger
• type TriggerType
  • func (e TriggerType) String() string

Types

type Event

type Event struct {
	ID      string
	Topic   string
	Payload []byte
}

Event - A nitric event that has come from a trigger source

func (*Event) GetTriggerType

func (*Event) GetTriggerType() TriggerType

type HttpRequest

type HttpRequest struct {
	// The original Headers
	// Header *fasthttp.RequestHeader
	Header map[string]string
	// The original body stream
	Body []byte
	// The original method
	Method string
	// The original path
	Path string
	// URL query parameters
	Query map[string]string
}

HttpRequest - Storage information that captures a HTTP Request

func FromHttpRequest

func FromHttpRequest(ctx *fasthttp.RequestCtx) *HttpRequest

FromHttpRequest (constructs a HttpRequest source type from a HttpRequest)

func (*HttpRequest) GetTriggerType

func (*HttpRequest) GetTriggerType() TriggerType

type HttpResponse

type HttpResponse struct {
	// The original Headers
	Header *fasthttp.ResponseHeader
	// The original body stream
	Body []byte
	// The original method
	StatusCode int
}

HttpRequest - Storage information that captures a HTTP Request

func FromHttpResponse

func FromHttpResponse(resp *fasthttp.Response) *HttpResponse

FromHttpRequest (constructs a HttpRequest source type from a HttpRequest)

func FromTriggerResponse

func FromTriggerResponse(triggerResponse *pb.TriggerResponse) (*HttpResponse, error)

FromTriggerResponse (constructs a HttpResponse from a FaaS TriggerResponse)

type Trigger

type Trigger interface {
	GetTriggerType() TriggerType
}

type TriggerType

type TriggerType int

SourceType enum

const (
	TriggerType_Subscription TriggerType = iota
	TriggerType_Request
	TriggerType_Custom
)

func (TriggerType) String

func (e TriggerType) String() string