aaliflowkitgrpc

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: May 8, 2025 License: MIT Imports: 9 Imported by: 3

Documentation

Index

Constants

View Source
const (
	ExternalFunctions_ListFunctions_FullMethodName  = "/aaliflowkitgrpc.ExternalFunctions/ListFunctions"
	ExternalFunctions_RunFunction_FullMethodName    = "/aaliflowkitgrpc.ExternalFunctions/RunFunction"
	ExternalFunctions_StreamFunction_FullMethodName = "/aaliflowkitgrpc.ExternalFunctions/StreamFunction"
)

Variables

View Source
var ExternalFunctions_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "aaliflowkitgrpc.ExternalFunctions",
	HandlerType: (*ExternalFunctionsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListFunctions",
			Handler:    _ExternalFunctions_ListFunctions_Handler,
		},
		{
			MethodName: "RunFunction",
			Handler:    _ExternalFunctions_RunFunction_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamFunction",
			Handler:       _ExternalFunctions_StreamFunction_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "pkg/aaliflowkitgrpc/aali-flowkit.proto",
}

ExternalFunctions_ServiceDesc is the grpc.ServiceDesc for ExternalFunctions 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_pkg_aaliflowkitgrpc_aali_flowkit_proto protoreflect.FileDescriptor

Functions

func RegisterExternalFunctionsServer

func RegisterExternalFunctionsServer(s grpc.ServiceRegistrar, srv ExternalFunctionsServer)

Types

type ExternalFunctionsClient

type ExternalFunctionsClient interface {
	// Lists all available functions with description, inputs and outputs.
	ListFunctions(ctx context.Context, in *ListFunctionsRequest, opts ...grpc.CallOption) (*ListFunctionsResponse, error)
	// Runs a specified function with provided inputs and returns the function outputs.
	RunFunction(ctx context.Context, in *FunctionInputs, opts ...grpc.CallOption) (*FunctionOutputs, error)
	// Runs a specified function with provided inputs and returns the function output as a stream.
	StreamFunction(ctx context.Context, in *FunctionInputs, opts ...grpc.CallOption) (grpc.ServerStreamingClient[StreamOutput], error)
}

ExternalFunctionsClient is the client API for ExternalFunctions 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.

ExternalFunctions is a gRPC service that allows for listing and running the function available in the externalfunctions package.

type ExternalFunctionsServer

type ExternalFunctionsServer interface {
	// Lists all available functions with description, inputs and outputs.
	ListFunctions(context.Context, *ListFunctionsRequest) (*ListFunctionsResponse, error)
	// Runs a specified function with provided inputs and returns the function outputs.
	RunFunction(context.Context, *FunctionInputs) (*FunctionOutputs, error)
	// Runs a specified function with provided inputs and returns the function output as a stream.
	StreamFunction(*FunctionInputs, grpc.ServerStreamingServer[StreamOutput]) error
	// contains filtered or unexported methods
}

ExternalFunctionsServer is the server API for ExternalFunctions service. All implementations must embed UnimplementedExternalFunctionsServer for forward compatibility.

ExternalFunctions is a gRPC service that allows for listing and running the function available in the externalfunctions package.

type ExternalFunctions_StreamFunctionClient

type ExternalFunctions_StreamFunctionClient = grpc.ServerStreamingClient[StreamOutput]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type ExternalFunctions_StreamFunctionServer

type ExternalFunctions_StreamFunctionServer = grpc.ServerStreamingServer[StreamOutput]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type FunctionDefinition

type FunctionDefinition struct {

	// Name of the function.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the function.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Category of the function.
	Category string `protobuf:"bytes,3,opt,name=category,proto3" json:"category,omitempty"`
	// Display name of the function;
	DisplayName string `protobuf:"bytes,4,opt,name=displayName,proto3" json:"displayName,omitempty"`
	// List of input definitions for the function.
	Input []*FunctionInputDefinition `protobuf:"bytes,5,rep,name=input,proto3" json:"input,omitempty"`
	// List of output definitions for the function.
	Output []*FunctionOutputDefinition `protobuf:"bytes,6,rep,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

FunctionDefinition is the definition of an individual function. It contains the name, description, inputs and outputs of the function.

func (*FunctionDefinition) Descriptor deprecated

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

Deprecated: Use FunctionDefinition.ProtoReflect.Descriptor instead.

func (*FunctionDefinition) GetCategory

func (x *FunctionDefinition) GetCategory() string

func (*FunctionDefinition) GetDescription

func (x *FunctionDefinition) GetDescription() string

func (*FunctionDefinition) GetDisplayName

func (x *FunctionDefinition) GetDisplayName() string

func (*FunctionDefinition) GetInput

func (*FunctionDefinition) GetName

func (x *FunctionDefinition) GetName() string

func (*FunctionDefinition) GetOutput

func (x *FunctionDefinition) GetOutput() []*FunctionOutputDefinition

func (*FunctionDefinition) ProtoMessage

func (*FunctionDefinition) ProtoMessage()

func (*FunctionDefinition) ProtoReflect

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

func (*FunctionDefinition) Reset

func (x *FunctionDefinition) Reset()

func (*FunctionDefinition) String

func (x *FunctionDefinition) String() string

type FunctionInput

type FunctionInput struct {

	// Name of the input.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Go language type of the input.
	GoType string `protobuf:"bytes,2,opt,name=go_type,json=goType,proto3" json:"go_type,omitempty"`
	// Value of the input.
	Value string `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Single input for a function.

func (*FunctionInput) Descriptor deprecated

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

Deprecated: Use FunctionInput.ProtoReflect.Descriptor instead.

func (*FunctionInput) GetGoType

func (x *FunctionInput) GetGoType() string

func (*FunctionInput) GetName

func (x *FunctionInput) GetName() string

func (*FunctionInput) GetValue

func (x *FunctionInput) GetValue() string

func (*FunctionInput) ProtoMessage

func (*FunctionInput) ProtoMessage()

func (*FunctionInput) ProtoReflect

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

func (*FunctionInput) Reset

func (x *FunctionInput) Reset()

func (*FunctionInput) String

func (x *FunctionInput) String() string

type FunctionInputDefinition

type FunctionInputDefinition struct {

	// Name of the input.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Type of the input.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Go language type of the input.
	GoType string `protobuf:"bytes,3,opt,name=go_type,json=goType,proto3" json:"go_type,omitempty"`
	// List of options for the input, if applicable.
	Options []string `protobuf:"bytes,4,rep,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

FunctionInputDefinition is the definition of an input for a function. It contains the name, type, Go language type and options for the input.

func (*FunctionInputDefinition) Descriptor deprecated

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

Deprecated: Use FunctionInputDefinition.ProtoReflect.Descriptor instead.

func (*FunctionInputDefinition) GetGoType

func (x *FunctionInputDefinition) GetGoType() string

func (*FunctionInputDefinition) GetName

func (x *FunctionInputDefinition) GetName() string

func (*FunctionInputDefinition) GetOptions

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

func (*FunctionInputDefinition) GetType

func (x *FunctionInputDefinition) GetType() string

func (*FunctionInputDefinition) ProtoMessage

func (*FunctionInputDefinition) ProtoMessage()

func (*FunctionInputDefinition) ProtoReflect

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

func (*FunctionInputDefinition) Reset

func (x *FunctionInputDefinition) Reset()

func (*FunctionInputDefinition) String

func (x *FunctionInputDefinition) String() string

type FunctionInputs

type FunctionInputs struct {

	// Name of the function to run.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// List of inputs for the function.
	Inputs []*FunctionInput `protobuf:"bytes,2,rep,name=inputs,proto3" json:"inputs,omitempty"`
	// contains filtered or unexported fields
}

FunctionInputs is the input message for the RunFunction method. It contains the name of the function to run and a list of inputs.

func (*FunctionInputs) Descriptor deprecated

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

Deprecated: Use FunctionInputs.ProtoReflect.Descriptor instead.

func (*FunctionInputs) GetInputs

func (x *FunctionInputs) GetInputs() []*FunctionInput

func (*FunctionInputs) GetName

func (x *FunctionInputs) GetName() string

func (*FunctionInputs) ProtoMessage

func (*FunctionInputs) ProtoMessage()

func (*FunctionInputs) ProtoReflect

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

func (*FunctionInputs) Reset

func (x *FunctionInputs) Reset()

func (*FunctionInputs) String

func (x *FunctionInputs) String() string

type FunctionOutput

type FunctionOutput struct {

	// Name of the output.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Go language type of the output.
	GoType string `protobuf:"bytes,2,opt,name=go_type,json=goType,proto3" json:"go_type,omitempty"`
	// Value of the output.
	Value string `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// Code validation of the output. Only relevant for code generation.
	CodeValidation string `protobuf:"bytes,4,opt,name=code_validation,json=codeValidation,proto3" json:"code_validation,omitempty"`
	// contains filtered or unexported fields
}

FunctionOutput is a single output from a function. It contains the name, Go language type and value of the output.

func (*FunctionOutput) Descriptor deprecated

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

Deprecated: Use FunctionOutput.ProtoReflect.Descriptor instead.

func (*FunctionOutput) GetCodeValidation

func (x *FunctionOutput) GetCodeValidation() string

func (*FunctionOutput) GetGoType

func (x *FunctionOutput) GetGoType() string

func (*FunctionOutput) GetName

func (x *FunctionOutput) GetName() string

func (*FunctionOutput) GetValue

func (x *FunctionOutput) GetValue() string

func (*FunctionOutput) ProtoMessage

func (*FunctionOutput) ProtoMessage()

func (*FunctionOutput) ProtoReflect

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

func (*FunctionOutput) Reset

func (x *FunctionOutput) Reset()

func (*FunctionOutput) String

func (x *FunctionOutput) String() string

type FunctionOutputDefinition

type FunctionOutputDefinition struct {

	// Name of the output.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Type of the output.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Go language type of the output.
	GoType string `protobuf:"bytes,3,opt,name=go_type,json=goType,proto3" json:"go_type,omitempty"`
	// contains filtered or unexported fields
}

FunctionOutputDefinition is the definition of an output for a function. It contains the name, type and Go language type of the output.

func (*FunctionOutputDefinition) Descriptor deprecated

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

Deprecated: Use FunctionOutputDefinition.ProtoReflect.Descriptor instead.

func (*FunctionOutputDefinition) GetGoType

func (x *FunctionOutputDefinition) GetGoType() string

func (*FunctionOutputDefinition) GetName

func (x *FunctionOutputDefinition) GetName() string

func (*FunctionOutputDefinition) GetType

func (x *FunctionOutputDefinition) GetType() string

func (*FunctionOutputDefinition) ProtoMessage

func (*FunctionOutputDefinition) ProtoMessage()

func (*FunctionOutputDefinition) ProtoReflect

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

func (*FunctionOutputDefinition) Reset

func (x *FunctionOutputDefinition) Reset()

func (*FunctionOutputDefinition) String

func (x *FunctionOutputDefinition) String() string

type FunctionOutputs

type FunctionOutputs struct {

	// Name of the function that was run.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// List of outputs from the function.
	Outputs []*FunctionOutput `protobuf:"bytes,2,rep,name=outputs,proto3" json:"outputs,omitempty"`
	// contains filtered or unexported fields
}

FunctionOutputs is the output message for the RunFunction method. It contains the name of the function that was run and a list of outputs.

func (*FunctionOutputs) Descriptor deprecated

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

Deprecated: Use FunctionOutputs.ProtoReflect.Descriptor instead.

func (*FunctionOutputs) GetName

func (x *FunctionOutputs) GetName() string

func (*FunctionOutputs) GetOutputs

func (x *FunctionOutputs) GetOutputs() []*FunctionOutput

func (*FunctionOutputs) ProtoMessage

func (*FunctionOutputs) ProtoMessage()

func (*FunctionOutputs) ProtoReflect

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

func (*FunctionOutputs) Reset

func (x *FunctionOutputs) Reset()

func (*FunctionOutputs) String

func (x *FunctionOutputs) String() string

type ListFunctionsRequest

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

ListFunctionsRequest is the input message for the ListFunctions method. As no input is required, this message is empty.

func (*ListFunctionsRequest) Descriptor deprecated

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

Deprecated: Use ListFunctionsRequest.ProtoReflect.Descriptor instead.

func (*ListFunctionsRequest) ProtoMessage

func (*ListFunctionsRequest) ProtoMessage()

func (*ListFunctionsRequest) ProtoReflect

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

func (*ListFunctionsRequest) Reset

func (x *ListFunctionsRequest) Reset()

func (*ListFunctionsRequest) String

func (x *ListFunctionsRequest) String() string

type ListFunctionsResponse

type ListFunctionsResponse struct {

	// Map of function names to their definitions.
	Functions map[string]*FunctionDefinition `` /* 145-byte string literal not displayed */
	// contains filtered or unexported fields
}

ListFunctionsResponse is the output message for the ListFunctions method. It contains a map of function names to their definitions.

func (*ListFunctionsResponse) Descriptor deprecated

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

Deprecated: Use ListFunctionsResponse.ProtoReflect.Descriptor instead.

func (*ListFunctionsResponse) GetFunctions

func (x *ListFunctionsResponse) GetFunctions() map[string]*FunctionDefinition

func (*ListFunctionsResponse) ProtoMessage

func (*ListFunctionsResponse) ProtoMessage()

func (*ListFunctionsResponse) ProtoReflect

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

func (*ListFunctionsResponse) Reset

func (x *ListFunctionsResponse) Reset()

func (*ListFunctionsResponse) String

func (x *ListFunctionsResponse) String() string

type StreamOutput

type StreamOutput struct {

	// Counter for the message in the stream.
	MessageCounter int32 `protobuf:"varint,1,opt,name=message_counter,json=messageCounter,proto3" json:"message_counter,omitempty"`
	// Indicates if this is the last message in the stream.
	IsLast bool `protobuf:"varint,2,opt,name=is_last,json=isLast,proto3" json:"is_last,omitempty"`
	// Value of the output.
	Value string `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// Code validation of the output. Only relevant for code generation.
	CodeValidation string `protobuf:"bytes,4,opt,name=code_validation,json=codeValidation,proto3" json:"code_validation,omitempty"`
	// contains filtered or unexported fields
}

StreamOutput is the output message for the StreamFunction method. It contains the message counter, a flag indicating if this is the last message

func (*StreamOutput) Descriptor deprecated

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

Deprecated: Use StreamOutput.ProtoReflect.Descriptor instead.

func (*StreamOutput) GetCodeValidation

func (x *StreamOutput) GetCodeValidation() string

func (*StreamOutput) GetIsLast

func (x *StreamOutput) GetIsLast() bool

func (*StreamOutput) GetMessageCounter

func (x *StreamOutput) GetMessageCounter() int32

func (*StreamOutput) GetValue

func (x *StreamOutput) GetValue() string

func (*StreamOutput) ProtoMessage

func (*StreamOutput) ProtoMessage()

func (*StreamOutput) ProtoReflect

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

func (*StreamOutput) Reset

func (x *StreamOutput) Reset()

func (*StreamOutput) String

func (x *StreamOutput) String() string

type UnimplementedExternalFunctionsServer

type UnimplementedExternalFunctionsServer struct{}

UnimplementedExternalFunctionsServer 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 (UnimplementedExternalFunctionsServer) ListFunctions

func (UnimplementedExternalFunctionsServer) RunFunction

func (UnimplementedExternalFunctionsServer) StreamFunction

type UnsafeExternalFunctionsServer

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

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

Jump to

Keyboard shortcuts

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