proto

package
v0.0.0-...-54d7c77 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 20, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const (
	PluginService_GetManifest_FullMethodName      = "/workflow.plugin.v1.PluginService/GetManifest"
	PluginService_GetModuleTypes_FullMethodName   = "/workflow.plugin.v1.PluginService/GetModuleTypes"
	PluginService_GetStepTypes_FullMethodName     = "/workflow.plugin.v1.PluginService/GetStepTypes"
	PluginService_GetTriggerTypes_FullMethodName  = "/workflow.plugin.v1.PluginService/GetTriggerTypes"
	PluginService_GetModuleSchemas_FullMethodName = "/workflow.plugin.v1.PluginService/GetModuleSchemas"
	PluginService_CreateModule_FullMethodName     = "/workflow.plugin.v1.PluginService/CreateModule"
	PluginService_InitModule_FullMethodName       = "/workflow.plugin.v1.PluginService/InitModule"
	PluginService_StartModule_FullMethodName      = "/workflow.plugin.v1.PluginService/StartModule"
	PluginService_StopModule_FullMethodName       = "/workflow.plugin.v1.PluginService/StopModule"
	PluginService_DestroyModule_FullMethodName    = "/workflow.plugin.v1.PluginService/DestroyModule"
	PluginService_CreateStep_FullMethodName       = "/workflow.plugin.v1.PluginService/CreateStep"
	PluginService_ExecuteStep_FullMethodName      = "/workflow.plugin.v1.PluginService/ExecuteStep"
	PluginService_DestroyStep_FullMethodName      = "/workflow.plugin.v1.PluginService/DestroyStep"
	PluginService_InvokeService_FullMethodName    = "/workflow.plugin.v1.PluginService/InvokeService"
)
View Source
const (
	EngineCallbackService_TriggerWorkflow_FullMethodName = "/workflow.plugin.v1.EngineCallbackService/TriggerWorkflow"
	EngineCallbackService_GetService_FullMethodName      = "/workflow.plugin.v1.EngineCallbackService/GetService"
	EngineCallbackService_Log_FullMethodName             = "/workflow.plugin.v1.EngineCallbackService/Log"
)

Variables

View Source
var EngineCallbackService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "workflow.plugin.v1.EngineCallbackService",
	HandlerType: (*EngineCallbackServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "TriggerWorkflow",
			Handler:    _EngineCallbackService_TriggerWorkflow_Handler,
		},
		{
			MethodName: "GetService",
			Handler:    _EngineCallbackService_GetService_Handler,
		},
		{
			MethodName: "Log",
			Handler:    _EngineCallbackService_Log_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "plugin.proto",
}

EngineCallbackService_ServiceDesc is the grpc.ServiceDesc for EngineCallbackService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_plugin_proto protoreflect.FileDescriptor
View Source
var PluginService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "workflow.plugin.v1.PluginService",
	HandlerType: (*PluginServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetManifest",
			Handler:    _PluginService_GetManifest_Handler,
		},
		{
			MethodName: "GetModuleTypes",
			Handler:    _PluginService_GetModuleTypes_Handler,
		},
		{
			MethodName: "GetStepTypes",
			Handler:    _PluginService_GetStepTypes_Handler,
		},
		{
			MethodName: "GetTriggerTypes",
			Handler:    _PluginService_GetTriggerTypes_Handler,
		},
		{
			MethodName: "GetModuleSchemas",
			Handler:    _PluginService_GetModuleSchemas_Handler,
		},
		{
			MethodName: "CreateModule",
			Handler:    _PluginService_CreateModule_Handler,
		},
		{
			MethodName: "InitModule",
			Handler:    _PluginService_InitModule_Handler,
		},
		{
			MethodName: "StartModule",
			Handler:    _PluginService_StartModule_Handler,
		},
		{
			MethodName: "StopModule",
			Handler:    _PluginService_StopModule_Handler,
		},
		{
			MethodName: "DestroyModule",
			Handler:    _PluginService_DestroyModule_Handler,
		},
		{
			MethodName: "CreateStep",
			Handler:    _PluginService_CreateStep_Handler,
		},
		{
			MethodName: "ExecuteStep",
			Handler:    _PluginService_ExecuteStep_Handler,
		},
		{
			MethodName: "DestroyStep",
			Handler:    _PluginService_DestroyStep_Handler,
		},
		{
			MethodName: "InvokeService",
			Handler:    _PluginService_InvokeService_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "plugin.proto",
}

PluginService_ServiceDesc is the grpc.ServiceDesc for PluginService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterEngineCallbackServiceServer

func RegisterEngineCallbackServiceServer(s grpc.ServiceRegistrar, srv EngineCallbackServiceServer)

func RegisterPluginServiceServer

func RegisterPluginServiceServer(s grpc.ServiceRegistrar, srv PluginServiceServer)

Types

type ConfigFieldDef

type ConfigFieldDef struct {
	Name         string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Type         string   `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	Description  string   `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	DefaultValue string   `protobuf:"bytes,4,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	Required     bool     `protobuf:"varint,5,opt,name=required,proto3" json:"required,omitempty"`
	Options      []string `protobuf:"bytes,6,rep,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

ConfigFieldDef describes a configuration field for the UI.

func (*ConfigFieldDef) Descriptor deprecated

func (*ConfigFieldDef) Descriptor() ([]byte, []int)

Deprecated: Use ConfigFieldDef.ProtoReflect.Descriptor instead.

func (*ConfigFieldDef) GetDefaultValue

func (x *ConfigFieldDef) GetDefaultValue() string

func (*ConfigFieldDef) GetDescription

func (x *ConfigFieldDef) GetDescription() string

func (*ConfigFieldDef) GetName

func (x *ConfigFieldDef) GetName() string

func (*ConfigFieldDef) GetOptions

func (x *ConfigFieldDef) GetOptions() []string

func (*ConfigFieldDef) GetRequired

func (x *ConfigFieldDef) GetRequired() bool

func (*ConfigFieldDef) GetType

func (x *ConfigFieldDef) GetType() string

func (*ConfigFieldDef) ProtoMessage

func (*ConfigFieldDef) ProtoMessage()

func (*ConfigFieldDef) ProtoReflect

func (x *ConfigFieldDef) ProtoReflect() protoreflect.Message

func (*ConfigFieldDef) Reset

func (x *ConfigFieldDef) Reset()

func (*ConfigFieldDef) String

func (x *ConfigFieldDef) String() string

type CreateModuleRequest

type CreateModuleRequest struct {
	Type   string           `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Name   string           `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Config *structpb.Struct `protobuf:"bytes,3,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

CreateModuleRequest asks the plugin to instantiate a module.

func (*CreateModuleRequest) Descriptor deprecated

func (*CreateModuleRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateModuleRequest.ProtoReflect.Descriptor instead.

func (*CreateModuleRequest) GetConfig

func (x *CreateModuleRequest) GetConfig() *structpb.Struct

func (*CreateModuleRequest) GetName

func (x *CreateModuleRequest) GetName() string

func (*CreateModuleRequest) GetType

func (x *CreateModuleRequest) GetType() string

func (*CreateModuleRequest) ProtoMessage

func (*CreateModuleRequest) ProtoMessage()

func (*CreateModuleRequest) ProtoReflect

func (x *CreateModuleRequest) ProtoReflect() protoreflect.Message

func (*CreateModuleRequest) Reset

func (x *CreateModuleRequest) Reset()

func (*CreateModuleRequest) String

func (x *CreateModuleRequest) String() string

type CreateStepRequest

type CreateStepRequest struct {
	Type   string           `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Name   string           `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Config *structpb.Struct `protobuf:"bytes,3,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

CreateStepRequest asks the plugin to instantiate a pipeline step.

func (*CreateStepRequest) Descriptor deprecated

func (*CreateStepRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateStepRequest.ProtoReflect.Descriptor instead.

func (*CreateStepRequest) GetConfig

func (x *CreateStepRequest) GetConfig() *structpb.Struct

func (*CreateStepRequest) GetName

func (x *CreateStepRequest) GetName() string

func (*CreateStepRequest) GetType

func (x *CreateStepRequest) GetType() string

func (*CreateStepRequest) ProtoMessage

func (*CreateStepRequest) ProtoMessage()

func (*CreateStepRequest) ProtoReflect

func (x *CreateStepRequest) ProtoReflect() protoreflect.Message

func (*CreateStepRequest) Reset

func (x *CreateStepRequest) Reset()

func (*CreateStepRequest) String

func (x *CreateStepRequest) String() string

type EngineCallbackServiceClient

type EngineCallbackServiceClient interface {
	// TriggerWorkflow fires a workflow trigger from the plugin side.
	TriggerWorkflow(ctx context.Context, in *TriggerWorkflowRequest, opts ...grpc.CallOption) (*ErrorResponse, error)
	// GetService checks if a named service exists in the host registry.
	GetService(ctx context.Context, in *GetServiceRequest, opts ...grpc.CallOption) (*GetServiceResponse, error)
	// Log sends a log entry from the plugin to the host logger.
	Log(ctx context.Context, in *LogRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

EngineCallbackServiceClient is the client API for EngineCallbackService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

EngineCallbackService is implemented by the host and called by the plugin.

type EngineCallbackServiceServer

type EngineCallbackServiceServer interface {
	// TriggerWorkflow fires a workflow trigger from the plugin side.
	TriggerWorkflow(context.Context, *TriggerWorkflowRequest) (*ErrorResponse, error)
	// GetService checks if a named service exists in the host registry.
	GetService(context.Context, *GetServiceRequest) (*GetServiceResponse, error)
	// Log sends a log entry from the plugin to the host logger.
	Log(context.Context, *LogRequest) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

EngineCallbackServiceServer is the server API for EngineCallbackService service. All implementations must embed UnimplementedEngineCallbackServiceServer for forward compatibility.

EngineCallbackService is implemented by the host and called by the plugin.

type ErrorResponse

type ErrorResponse struct {
	Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

ErrorResponse returns an optional error message.

func (*ErrorResponse) Descriptor deprecated

func (*ErrorResponse) Descriptor() ([]byte, []int)

Deprecated: Use ErrorResponse.ProtoReflect.Descriptor instead.

func (*ErrorResponse) GetError

func (x *ErrorResponse) GetError() string

func (*ErrorResponse) ProtoMessage

func (*ErrorResponse) ProtoMessage()

func (*ErrorResponse) ProtoReflect

func (x *ErrorResponse) ProtoReflect() protoreflect.Message

func (*ErrorResponse) Reset

func (x *ErrorResponse) Reset()

func (*ErrorResponse) String

func (x *ErrorResponse) String() string

type ExecuteStepRequest

type ExecuteStepRequest struct {
	HandleId    string                      `protobuf:"bytes,1,opt,name=handle_id,json=handleId,proto3" json:"handle_id,omitempty"`
	TriggerData *structpb.Struct            `protobuf:"bytes,2,opt,name=trigger_data,json=triggerData,proto3" json:"trigger_data,omitempty"`
	StepOutputs map[string]*structpb.Struct `` /* 168-byte string literal not displayed */
	Current     *structpb.Struct            `protobuf:"bytes,4,opt,name=current,proto3" json:"current,omitempty"`
	Metadata    *structpb.Struct            `protobuf:"bytes,5,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

ExecuteStepRequest runs a step with pipeline context data.

func (*ExecuteStepRequest) Descriptor deprecated

func (*ExecuteStepRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExecuteStepRequest.ProtoReflect.Descriptor instead.

func (*ExecuteStepRequest) GetCurrent

func (x *ExecuteStepRequest) GetCurrent() *structpb.Struct

func (*ExecuteStepRequest) GetHandleId

func (x *ExecuteStepRequest) GetHandleId() string

func (*ExecuteStepRequest) GetMetadata

func (x *ExecuteStepRequest) GetMetadata() *structpb.Struct

func (*ExecuteStepRequest) GetStepOutputs

func (x *ExecuteStepRequest) GetStepOutputs() map[string]*structpb.Struct

func (*ExecuteStepRequest) GetTriggerData

func (x *ExecuteStepRequest) GetTriggerData() *structpb.Struct

func (*ExecuteStepRequest) ProtoMessage

func (*ExecuteStepRequest) ProtoMessage()

func (*ExecuteStepRequest) ProtoReflect

func (x *ExecuteStepRequest) ProtoReflect() protoreflect.Message

func (*ExecuteStepRequest) Reset

func (x *ExecuteStepRequest) Reset()

func (*ExecuteStepRequest) String

func (x *ExecuteStepRequest) String() string

type ExecuteStepResponse

type ExecuteStepResponse struct {
	Output       *structpb.Struct `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	Error        string           `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	StopPipeline bool             `protobuf:"varint,3,opt,name=stop_pipeline,json=stopPipeline,proto3" json:"stop_pipeline,omitempty"`
	// contains filtered or unexported fields
}

ExecuteStepResponse returns the step result.

func (*ExecuteStepResponse) Descriptor deprecated

func (*ExecuteStepResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExecuteStepResponse.ProtoReflect.Descriptor instead.

func (*ExecuteStepResponse) GetError

func (x *ExecuteStepResponse) GetError() string

func (*ExecuteStepResponse) GetOutput

func (x *ExecuteStepResponse) GetOutput() *structpb.Struct

func (*ExecuteStepResponse) GetStopPipeline

func (x *ExecuteStepResponse) GetStopPipeline() bool

func (*ExecuteStepResponse) ProtoMessage

func (*ExecuteStepResponse) ProtoMessage()

func (*ExecuteStepResponse) ProtoReflect

func (x *ExecuteStepResponse) ProtoReflect() protoreflect.Message

func (*ExecuteStepResponse) Reset

func (x *ExecuteStepResponse) Reset()

func (*ExecuteStepResponse) String

func (x *ExecuteStepResponse) String() string

type GetServiceRequest

type GetServiceRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

GetServiceRequest asks if a named service exists on the host.

func (*GetServiceRequest) Descriptor deprecated

func (*GetServiceRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetServiceRequest.ProtoReflect.Descriptor instead.

func (*GetServiceRequest) GetName

func (x *GetServiceRequest) GetName() string

func (*GetServiceRequest) ProtoMessage

func (*GetServiceRequest) ProtoMessage()

func (*GetServiceRequest) ProtoReflect

func (x *GetServiceRequest) ProtoReflect() protoreflect.Message

func (*GetServiceRequest) Reset

func (x *GetServiceRequest) Reset()

func (*GetServiceRequest) String

func (x *GetServiceRequest) String() string

type GetServiceResponse

type GetServiceResponse struct {
	Found bool `protobuf:"varint,1,opt,name=found,proto3" json:"found,omitempty"`
	// contains filtered or unexported fields
}

GetServiceResponse indicates whether the service was found.

func (*GetServiceResponse) Descriptor deprecated

func (*GetServiceResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetServiceResponse.ProtoReflect.Descriptor instead.

func (*GetServiceResponse) GetFound

func (x *GetServiceResponse) GetFound() bool

func (*GetServiceResponse) ProtoMessage

func (*GetServiceResponse) ProtoMessage()

func (*GetServiceResponse) ProtoReflect

func (x *GetServiceResponse) ProtoReflect() protoreflect.Message

func (*GetServiceResponse) Reset

func (x *GetServiceResponse) Reset()

func (*GetServiceResponse) String

func (x *GetServiceResponse) String() string

type HandleRequest

type HandleRequest struct {
	HandleId string `protobuf:"bytes,1,opt,name=handle_id,json=handleId,proto3" json:"handle_id,omitempty"`
	// contains filtered or unexported fields
}

HandleRequest identifies a resource by its handle.

func (*HandleRequest) Descriptor deprecated

func (*HandleRequest) Descriptor() ([]byte, []int)

Deprecated: Use HandleRequest.ProtoReflect.Descriptor instead.

func (*HandleRequest) GetHandleId

func (x *HandleRequest) GetHandleId() string

func (*HandleRequest) ProtoMessage

func (*HandleRequest) ProtoMessage()

func (*HandleRequest) ProtoReflect

func (x *HandleRequest) ProtoReflect() protoreflect.Message

func (*HandleRequest) Reset

func (x *HandleRequest) Reset()

func (*HandleRequest) String

func (x *HandleRequest) String() string

type HandleResponse

type HandleResponse struct {
	HandleId string `protobuf:"bytes,1,opt,name=handle_id,json=handleId,proto3" json:"handle_id,omitempty"`
	Error    string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

HandleResponse returns a handle ID for a created resource.

func (*HandleResponse) Descriptor deprecated

func (*HandleResponse) Descriptor() ([]byte, []int)

Deprecated: Use HandleResponse.ProtoReflect.Descriptor instead.

func (*HandleResponse) GetError

func (x *HandleResponse) GetError() string

func (*HandleResponse) GetHandleId

func (x *HandleResponse) GetHandleId() string

func (*HandleResponse) ProtoMessage

func (*HandleResponse) ProtoMessage()

func (*HandleResponse) ProtoReflect

func (x *HandleResponse) ProtoReflect() protoreflect.Message

func (*HandleResponse) Reset

func (x *HandleResponse) Reset()

func (*HandleResponse) String

func (x *HandleResponse) String() string

type InvokeServiceRequest

type InvokeServiceRequest struct {
	HandleId string           `protobuf:"bytes,1,opt,name=handle_id,json=handleId,proto3" json:"handle_id,omitempty"`
	Method   string           `protobuf:"bytes,2,opt,name=method,proto3" json:"method,omitempty"`
	Args     *structpb.Struct `protobuf:"bytes,3,opt,name=args,proto3" json:"args,omitempty"`
	// contains filtered or unexported fields
}

InvokeServiceRequest calls a method on a module service.

func (*InvokeServiceRequest) Descriptor deprecated

func (*InvokeServiceRequest) Descriptor() ([]byte, []int)

Deprecated: Use InvokeServiceRequest.ProtoReflect.Descriptor instead.

func (*InvokeServiceRequest) GetArgs

func (x *InvokeServiceRequest) GetArgs() *structpb.Struct

func (*InvokeServiceRequest) GetHandleId

func (x *InvokeServiceRequest) GetHandleId() string

func (*InvokeServiceRequest) GetMethod

func (x *InvokeServiceRequest) GetMethod() string

func (*InvokeServiceRequest) ProtoMessage

func (*InvokeServiceRequest) ProtoMessage()

func (*InvokeServiceRequest) ProtoReflect

func (x *InvokeServiceRequest) ProtoReflect() protoreflect.Message

func (*InvokeServiceRequest) Reset

func (x *InvokeServiceRequest) Reset()

func (*InvokeServiceRequest) String

func (x *InvokeServiceRequest) String() string

type InvokeServiceResponse

type InvokeServiceResponse struct {
	Result *structpb.Struct `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"`
	Error  string           `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

InvokeServiceResponse returns the service method result.

func (*InvokeServiceResponse) Descriptor deprecated

func (*InvokeServiceResponse) Descriptor() ([]byte, []int)

Deprecated: Use InvokeServiceResponse.ProtoReflect.Descriptor instead.

func (*InvokeServiceResponse) GetError

func (x *InvokeServiceResponse) GetError() string

func (*InvokeServiceResponse) GetResult

func (x *InvokeServiceResponse) GetResult() *structpb.Struct

func (*InvokeServiceResponse) ProtoMessage

func (*InvokeServiceResponse) ProtoMessage()

func (*InvokeServiceResponse) ProtoReflect

func (x *InvokeServiceResponse) ProtoReflect() protoreflect.Message

func (*InvokeServiceResponse) Reset

func (x *InvokeServiceResponse) Reset()

func (*InvokeServiceResponse) String

func (x *InvokeServiceResponse) String() string

type LogRequest

type LogRequest struct {
	Level   string           `protobuf:"bytes,1,opt,name=level,proto3" json:"level,omitempty"`
	Message string           `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	Fields  *structpb.Struct `protobuf:"bytes,3,opt,name=fields,proto3" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

LogRequest sends a log entry to the host.

func (*LogRequest) Descriptor deprecated

func (*LogRequest) Descriptor() ([]byte, []int)

Deprecated: Use LogRequest.ProtoReflect.Descriptor instead.

func (*LogRequest) GetFields

func (x *LogRequest) GetFields() *structpb.Struct

func (*LogRequest) GetLevel

func (x *LogRequest) GetLevel() string

func (*LogRequest) GetMessage

func (x *LogRequest) GetMessage() string

func (*LogRequest) ProtoMessage

func (*LogRequest) ProtoMessage()

func (*LogRequest) ProtoReflect

func (x *LogRequest) ProtoReflect() protoreflect.Message

func (*LogRequest) Reset

func (x *LogRequest) Reset()

func (*LogRequest) String

func (x *LogRequest) String() string

type Manifest

type Manifest struct {
	Name        string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Version     string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	Author      string `protobuf:"bytes,3,opt,name=author,proto3" json:"author,omitempty"`
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Manifest describes the plugin's metadata.

func (*Manifest) Descriptor deprecated

func (*Manifest) Descriptor() ([]byte, []int)

Deprecated: Use Manifest.ProtoReflect.Descriptor instead.

func (*Manifest) GetAuthor

func (x *Manifest) GetAuthor() string

func (*Manifest) GetDescription

func (x *Manifest) GetDescription() string

func (*Manifest) GetName

func (x *Manifest) GetName() string

func (*Manifest) GetVersion

func (x *Manifest) GetVersion() string

func (*Manifest) ProtoMessage

func (*Manifest) ProtoMessage()

func (*Manifest) ProtoReflect

func (x *Manifest) ProtoReflect() protoreflect.Message

func (*Manifest) Reset

func (x *Manifest) Reset()

func (*Manifest) String

func (x *Manifest) String() string

type ModuleSchema

type ModuleSchema struct {
	Type         string            `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Label        string            `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
	Category     string            `protobuf:"bytes,3,opt,name=category,proto3" json:"category,omitempty"`
	Description  string            `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	Inputs       []*ServiceIODef   `protobuf:"bytes,5,rep,name=inputs,proto3" json:"inputs,omitempty"`
	Outputs      []*ServiceIODef   `protobuf:"bytes,6,rep,name=outputs,proto3" json:"outputs,omitempty"`
	ConfigFields []*ConfigFieldDef `protobuf:"bytes,7,rep,name=config_fields,json=configFields,proto3" json:"config_fields,omitempty"`
	// contains filtered or unexported fields
}

ModuleSchema describes a module type for the UI.

func (*ModuleSchema) Descriptor deprecated

func (*ModuleSchema) Descriptor() ([]byte, []int)

Deprecated: Use ModuleSchema.ProtoReflect.Descriptor instead.

func (*ModuleSchema) GetCategory

func (x *ModuleSchema) GetCategory() string

func (*ModuleSchema) GetConfigFields

func (x *ModuleSchema) GetConfigFields() []*ConfigFieldDef

func (*ModuleSchema) GetDescription

func (x *ModuleSchema) GetDescription() string

func (*ModuleSchema) GetInputs

func (x *ModuleSchema) GetInputs() []*ServiceIODef

func (*ModuleSchema) GetLabel

func (x *ModuleSchema) GetLabel() string

func (*ModuleSchema) GetOutputs

func (x *ModuleSchema) GetOutputs() []*ServiceIODef

func (*ModuleSchema) GetType

func (x *ModuleSchema) GetType() string

func (*ModuleSchema) ProtoMessage

func (*ModuleSchema) ProtoMessage()

func (*ModuleSchema) ProtoReflect

func (x *ModuleSchema) ProtoReflect() protoreflect.Message

func (*ModuleSchema) Reset

func (x *ModuleSchema) Reset()

func (*ModuleSchema) String

func (x *ModuleSchema) String() string

type ModuleSchemaList

type ModuleSchemaList struct {
	Schemas []*ModuleSchema `protobuf:"bytes,1,rep,name=schemas,proto3" json:"schemas,omitempty"`
	// contains filtered or unexported fields
}

ModuleSchemaList contains UI schema definitions.

func (*ModuleSchemaList) Descriptor deprecated

func (*ModuleSchemaList) Descriptor() ([]byte, []int)

Deprecated: Use ModuleSchemaList.ProtoReflect.Descriptor instead.

func (*ModuleSchemaList) GetSchemas

func (x *ModuleSchemaList) GetSchemas() []*ModuleSchema

func (*ModuleSchemaList) ProtoMessage

func (*ModuleSchemaList) ProtoMessage()

func (*ModuleSchemaList) ProtoReflect

func (x *ModuleSchemaList) ProtoReflect() protoreflect.Message

func (*ModuleSchemaList) Reset

func (x *ModuleSchemaList) Reset()

func (*ModuleSchemaList) String

func (x *ModuleSchemaList) String() string

type PluginServiceClient

type PluginServiceClient interface {
	// GetManifest returns the plugin's metadata.
	GetManifest(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*Manifest, error)
	// GetModuleTypes returns the module type names this plugin provides.
	GetModuleTypes(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*TypeList, error)
	// GetStepTypes returns the step type names this plugin provides.
	GetStepTypes(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*TypeList, error)
	// GetTriggerTypes returns the trigger type names this plugin provides.
	GetTriggerTypes(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*TypeList, error)
	// GetModuleSchemas returns UI schema definitions for the plugin's module types.
	GetModuleSchemas(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*ModuleSchemaList, error)
	// CreateModule instantiates a module of the given type.
	CreateModule(ctx context.Context, in *CreateModuleRequest, opts ...grpc.CallOption) (*HandleResponse, error)
	// InitModule initializes a previously created module.
	InitModule(ctx context.Context, in *HandleRequest, opts ...grpc.CallOption) (*ErrorResponse, error)
	// StartModule starts a previously initialized module.
	StartModule(ctx context.Context, in *HandleRequest, opts ...grpc.CallOption) (*ErrorResponse, error)
	// StopModule stops a running module.
	StopModule(ctx context.Context, in *HandleRequest, opts ...grpc.CallOption) (*ErrorResponse, error)
	// DestroyModule destroys a module and releases its resources.
	DestroyModule(ctx context.Context, in *HandleRequest, opts ...grpc.CallOption) (*ErrorResponse, error)
	// CreateStep instantiates a pipeline step of the given type.
	CreateStep(ctx context.Context, in *CreateStepRequest, opts ...grpc.CallOption) (*HandleResponse, error)
	// ExecuteStep runs a pipeline step with the given context.
	ExecuteStep(ctx context.Context, in *ExecuteStepRequest, opts ...grpc.CallOption) (*ExecuteStepResponse, error)
	// DestroyStep destroys a step and releases its resources.
	DestroyStep(ctx context.Context, in *HandleRequest, opts ...grpc.CallOption) (*ErrorResponse, error)
	// InvokeService calls a named method on a module's service interface.
	InvokeService(ctx context.Context, in *InvokeServiceRequest, opts ...grpc.CallOption) (*InvokeServiceResponse, error)
}

PluginServiceClient is the client API for PluginService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

PluginService is implemented by the plugin process and called by the host.

type PluginServiceServer

type PluginServiceServer interface {
	// GetManifest returns the plugin's metadata.
	GetManifest(context.Context, *emptypb.Empty) (*Manifest, error)
	// GetModuleTypes returns the module type names this plugin provides.
	GetModuleTypes(context.Context, *emptypb.Empty) (*TypeList, error)
	// GetStepTypes returns the step type names this plugin provides.
	GetStepTypes(context.Context, *emptypb.Empty) (*TypeList, error)
	// GetTriggerTypes returns the trigger type names this plugin provides.
	GetTriggerTypes(context.Context, *emptypb.Empty) (*TypeList, error)
	// GetModuleSchemas returns UI schema definitions for the plugin's module types.
	GetModuleSchemas(context.Context, *emptypb.Empty) (*ModuleSchemaList, error)
	// CreateModule instantiates a module of the given type.
	CreateModule(context.Context, *CreateModuleRequest) (*HandleResponse, error)
	// InitModule initializes a previously created module.
	InitModule(context.Context, *HandleRequest) (*ErrorResponse, error)
	// StartModule starts a previously initialized module.
	StartModule(context.Context, *HandleRequest) (*ErrorResponse, error)
	// StopModule stops a running module.
	StopModule(context.Context, *HandleRequest) (*ErrorResponse, error)
	// DestroyModule destroys a module and releases its resources.
	DestroyModule(context.Context, *HandleRequest) (*ErrorResponse, error)
	// CreateStep instantiates a pipeline step of the given type.
	CreateStep(context.Context, *CreateStepRequest) (*HandleResponse, error)
	// ExecuteStep runs a pipeline step with the given context.
	ExecuteStep(context.Context, *ExecuteStepRequest) (*ExecuteStepResponse, error)
	// DestroyStep destroys a step and releases its resources.
	DestroyStep(context.Context, *HandleRequest) (*ErrorResponse, error)
	// InvokeService calls a named method on a module's service interface.
	InvokeService(context.Context, *InvokeServiceRequest) (*InvokeServiceResponse, error)
	// contains filtered or unexported methods
}

PluginServiceServer is the server API for PluginService service. All implementations must embed UnimplementedPluginServiceServer for forward compatibility.

PluginService is implemented by the plugin process and called by the host.

type ServiceIODef

type ServiceIODef struct {
	Name        string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Type        string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

ServiceIODef describes a service input or output.

func (*ServiceIODef) Descriptor deprecated

func (*ServiceIODef) Descriptor() ([]byte, []int)

Deprecated: Use ServiceIODef.ProtoReflect.Descriptor instead.

func (*ServiceIODef) GetDescription

func (x *ServiceIODef) GetDescription() string

func (*ServiceIODef) GetName

func (x *ServiceIODef) GetName() string

func (*ServiceIODef) GetType

func (x *ServiceIODef) GetType() string

func (*ServiceIODef) ProtoMessage

func (*ServiceIODef) ProtoMessage()

func (*ServiceIODef) ProtoReflect

func (x *ServiceIODef) ProtoReflect() protoreflect.Message

func (*ServiceIODef) Reset

func (x *ServiceIODef) Reset()

func (*ServiceIODef) String

func (x *ServiceIODef) String() string

type TriggerWorkflowRequest

type TriggerWorkflowRequest struct {
	TriggerType string           `protobuf:"bytes,1,opt,name=trigger_type,json=triggerType,proto3" json:"trigger_type,omitempty"`
	Action      string           `protobuf:"bytes,2,opt,name=action,proto3" json:"action,omitempty"`
	Data        *structpb.Struct `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

TriggerWorkflowRequest fires a trigger from the plugin.

func (*TriggerWorkflowRequest) Descriptor deprecated

func (*TriggerWorkflowRequest) Descriptor() ([]byte, []int)

Deprecated: Use TriggerWorkflowRequest.ProtoReflect.Descriptor instead.

func (*TriggerWorkflowRequest) GetAction

func (x *TriggerWorkflowRequest) GetAction() string

func (*TriggerWorkflowRequest) GetData

func (x *TriggerWorkflowRequest) GetData() *structpb.Struct

func (*TriggerWorkflowRequest) GetTriggerType

func (x *TriggerWorkflowRequest) GetTriggerType() string

func (*TriggerWorkflowRequest) ProtoMessage

func (*TriggerWorkflowRequest) ProtoMessage()

func (*TriggerWorkflowRequest) ProtoReflect

func (x *TriggerWorkflowRequest) ProtoReflect() protoreflect.Message

func (*TriggerWorkflowRequest) Reset

func (x *TriggerWorkflowRequest) Reset()

func (*TriggerWorkflowRequest) String

func (x *TriggerWorkflowRequest) String() string

type TypeList

type TypeList struct {
	Types []string `protobuf:"bytes,1,rep,name=types,proto3" json:"types,omitempty"`
	// contains filtered or unexported fields
}

TypeList is a list of type name strings.

func (*TypeList) Descriptor deprecated

func (*TypeList) Descriptor() ([]byte, []int)

Deprecated: Use TypeList.ProtoReflect.Descriptor instead.

func (*TypeList) GetTypes

func (x *TypeList) GetTypes() []string

func (*TypeList) ProtoMessage

func (*TypeList) ProtoMessage()

func (*TypeList) ProtoReflect

func (x *TypeList) ProtoReflect() protoreflect.Message

func (*TypeList) Reset

func (x *TypeList) Reset()

func (*TypeList) String

func (x *TypeList) String() string

type UnimplementedEngineCallbackServiceServer

type UnimplementedEngineCallbackServiceServer struct{}

UnimplementedEngineCallbackServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedEngineCallbackServiceServer) GetService

func (UnimplementedEngineCallbackServiceServer) Log

func (UnimplementedEngineCallbackServiceServer) TriggerWorkflow

type UnimplementedPluginServiceServer

type UnimplementedPluginServiceServer struct{}

UnimplementedPluginServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedPluginServiceServer) CreateModule

func (UnimplementedPluginServiceServer) CreateStep

func (UnimplementedPluginServiceServer) DestroyModule

func (UnimplementedPluginServiceServer) DestroyStep

func (UnimplementedPluginServiceServer) ExecuteStep

func (UnimplementedPluginServiceServer) GetManifest

func (UnimplementedPluginServiceServer) GetModuleSchemas

func (UnimplementedPluginServiceServer) GetModuleTypes

func (UnimplementedPluginServiceServer) GetStepTypes

func (UnimplementedPluginServiceServer) GetTriggerTypes

func (UnimplementedPluginServiceServer) InitModule

func (UnimplementedPluginServiceServer) InvokeService

func (UnimplementedPluginServiceServer) StartModule

func (UnimplementedPluginServiceServer) StopModule

type UnsafeEngineCallbackServiceServer

type UnsafeEngineCallbackServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeEngineCallbackServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EngineCallbackServiceServer will result in compilation errors.

type UnsafePluginServiceServer

type UnsafePluginServiceServer interface {
	// contains filtered or unexported methods
}

UnsafePluginServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PluginServiceServer will result in compilation errors.

Jump to

Keyboard shortcuts

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