create_doc

Documentation

Index

• Constants
• type Component
  • func (g *Component) GetInfo() module.ComponentInfo
  • func (g *Component) Handle(ctx context.Context, output module.Handler, port string, msg interface{}) error
  • func (g *Component) Instance() module.Component
  • func (g *Component) Ports() []module.Port
• type Context
• type Error
• type Request
• type Response
• type Settings

Constants

const (
	ComponentName = "firestore_create_doc"
	RequestPort   = "request"
	ResponsePort  = "response"
	ErrorPort     = "error"
)

Types

type Component

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

func (*Component) GetInfo

func (g *Component) GetInfo() module.ComponentInfo

func (*Component) Handle

func (g *Component) Handle(ctx context.Context, output module.Handler, port string, msg interface{}) error

func (*Component) Instance

func (g *Component) Instance() module.Component

func (*Component) Ports

func (g *Component) Ports() []module.Port

type Context

type Context any

type Error

type Error struct {
	Context Context `json:"context"`
	Error   string  `json:"error"`
}

type Request

type Request struct {
	Context    Context                `json:"context,omitempty" title:"Context" configurable:"true"`
	Config     etc.ClientConfig       `json:"config" title:"Config" required:"true" description:"Client Config"`
	Collection string                 `json:"collection" title:"Collection" required:"true"`
	RefID      string                 `json:"refID,omitempty" title:"RefID" description:"Optional"`
	Document   map[string]interface{} `json:"document" configurable:"true" title:"Document" required:"true"`
}

type Response

type Response struct {
	Context Context `json:"context" title:"Context"`
	RefID   string  `json:"refID"`
	RefPath string  `json:"refPath"`
}

type Settings

type Settings struct {
	EnableErrorPort    bool `` /* 137-byte string literal not displayed */
	EnableResponsePort bool `json:"enableResponsePort" required:"true" title:"Enable Response Port" description:""`
}