proto

package
v0.19.2 Latest Latest
Warning

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

Go to latest
Published: Aug 26, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	PluginProvider_Describe_FullMethodName    = "/openrun.plugin.v1.PluginProvider/Describe"
	PluginProvider_InitApp_FullMethodName     = "/openrun.plugin.v1.PluginProvider/InitApp"
	PluginProvider_InitModule_FullMethodName  = "/openrun.plugin.v1.PluginProvider/InitModule"
	PluginProvider_Call_FullMethodName        = "/openrun.plugin.v1.PluginProvider/Call"
	PluginProvider_CursorNext_FullMethodName  = "/openrun.plugin.v1.PluginProvider/CursorNext"
	PluginProvider_CursorClose_FullMethodName = "/openrun.plugin.v1.PluginProvider/CursorClose"
	PluginProvider_EndSession_FullMethodName  = "/openrun.plugin.v1.PluginProvider/EndSession"
	PluginProvider_CheckHealth_FullMethodName = "/openrun.plugin.v1.PluginProvider/CheckHealth"
)

Variables

View Source
var File_plugin_proto protoreflect.FileDescriptor
View Source
var PluginProvider_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "openrun.plugin.v1.PluginProvider",
	HandlerType: (*PluginProviderServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Describe",
			Handler:    _PluginProvider_Describe_Handler,
		},
		{
			MethodName: "InitApp",
			Handler:    _PluginProvider_InitApp_Handler,
		},
		{
			MethodName: "InitModule",
			Handler:    _PluginProvider_InitModule_Handler,
		},
		{
			MethodName: "Call",
			Handler:    _PluginProvider_Call_Handler,
		},
		{
			MethodName: "CursorNext",
			Handler:    _PluginProvider_CursorNext_Handler,
		},
		{
			MethodName: "CursorClose",
			Handler:    _PluginProvider_CursorClose_Handler,
		},
		{
			MethodName: "EndSession",
			Handler:    _PluginProvider_EndSession_Handler,
		},
		{
			MethodName: "CheckHealth",
			Handler:    _PluginProvider_CheckHealth_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "plugin.proto",
}

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

Functions

func RegisterPluginProviderServer

func RegisterPluginProviderServer(s grpc.ServiceRegistrar, srv PluginProviderServer)

Types

type BigInt

type BigInt struct {
	Negative bool   `protobuf:"varint,1,opt,name=negative,proto3" json:"negative,omitempty"`
	Abs      []byte `protobuf:"bytes,2,opt,name=abs,proto3" json:"abs,omitempty"` // big-endian absolute value, big.Int.Bytes()
	// contains filtered or unexported fields
}

func (*BigInt) Descriptor deprecated

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

Deprecated: Use BigInt.ProtoReflect.Descriptor instead.

func (*BigInt) GetAbs

func (x *BigInt) GetAbs() []byte

func (*BigInt) GetNegative

func (x *BigInt) GetNegative() bool

func (*BigInt) ProtoMessage

func (*BigInt) ProtoMessage()

func (*BigInt) ProtoReflect

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

func (*BigInt) Reset

func (x *BigInt) Reset()

func (*BigInt) String

func (x *BigInt) String() string

type CallRequest

type CallRequest struct {
	Module   string       `protobuf:"bytes,1,opt,name=module,proto3" json:"module,omitempty"`
	Account  string       `protobuf:"bytes,2,opt,name=account,proto3" json:"account,omitempty"`
	Function string       `protobuf:"bytes,3,opt,name=function,proto3" json:"function,omitempty"`
	Args     []*StarValue `protobuf:"bytes,4,rep,name=args,proto3" json:"args,omitempty"`
	Kwargs   []*Kwarg     `protobuf:"bytes,5,rep,name=kwargs,proto3" json:"kwargs,omitempty"` // call-site order preserved
	Thread   *ThreadState `protobuf:"bytes,6,opt,name=thread,proto3" json:"thread,omitempty"`
	// Session groups the calls of one request: provider-side cross-call state
	// (transactions, cursors) is scoped to it and released by EndSession.
	SessionId string `protobuf:"bytes,7,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// contains filtered or unexported fields
}

func (*CallRequest) Descriptor deprecated

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

Deprecated: Use CallRequest.ProtoReflect.Descriptor instead.

func (*CallRequest) GetAccount

func (x *CallRequest) GetAccount() string

func (*CallRequest) GetArgs

func (x *CallRequest) GetArgs() []*StarValue

func (*CallRequest) GetFunction

func (x *CallRequest) GetFunction() string

func (*CallRequest) GetKwargs

func (x *CallRequest) GetKwargs() []*Kwarg

func (*CallRequest) GetModule

func (x *CallRequest) GetModule() string

func (*CallRequest) GetSessionId

func (x *CallRequest) GetSessionId() string

func (*CallRequest) GetThread

func (x *CallRequest) GetThread() *ThreadState

func (*CallRequest) ProtoMessage

func (*CallRequest) ProtoMessage()

func (*CallRequest) ProtoReflect

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

func (*CallRequest) Reset

func (x *CallRequest) Reset()

func (*CallRequest) String

func (x *CallRequest) String() string

type CallResponse

type CallResponse struct {
	Value     *StarValue `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	Error     string     `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	ErrorCode int64      `protobuf:"varint,3,opt,name=error_code,json=errorCode,proto3" json:"error_code,omitempty"` // 0 on success; 1 is the default error code
	// The session's strict deferred-cleanup keys after this call. The server
	// mirrors them as strict cleanup entries so a strict resource still
	// registered at request end fails the request as a leak, matching the
	// strict DeferCleanup contract of builtin plugins.
	StrictKeys []string `protobuf:"bytes,4,rep,name=strict_keys,json=strictKeys,proto3" json:"strict_keys,omitempty"`
	// contains filtered or unexported fields
}

func (*CallResponse) Descriptor deprecated

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

Deprecated: Use CallResponse.ProtoReflect.Descriptor instead.

func (*CallResponse) GetError

func (x *CallResponse) GetError() string

func (*CallResponse) GetErrorCode

func (x *CallResponse) GetErrorCode() int64

func (*CallResponse) GetStrictKeys

func (x *CallResponse) GetStrictKeys() []string

func (*CallResponse) GetValue

func (x *CallResponse) GetValue() *StarValue

func (*CallResponse) ProtoMessage

func (*CallResponse) ProtoMessage()

func (*CallResponse) ProtoReflect

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

func (*CallResponse) Reset

func (x *CallResponse) Reset()

func (*CallResponse) String

func (x *CallResponse) String() string

type CheckHealthRequest

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

func (*CheckHealthRequest) Descriptor deprecated

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

Deprecated: Use CheckHealthRequest.ProtoReflect.Descriptor instead.

func (*CheckHealthRequest) ProtoMessage

func (*CheckHealthRequest) ProtoMessage()

func (*CheckHealthRequest) ProtoReflect

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

func (*CheckHealthRequest) Reset

func (x *CheckHealthRequest) Reset()

func (*CheckHealthRequest) String

func (x *CheckHealthRequest) String() string

type CheckHealthResponse

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

func (*CheckHealthResponse) Descriptor deprecated

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

Deprecated: Use CheckHealthResponse.ProtoReflect.Descriptor instead.

func (*CheckHealthResponse) GetError

func (x *CheckHealthResponse) GetError() string

func (*CheckHealthResponse) ProtoMessage

func (*CheckHealthResponse) ProtoMessage()

func (*CheckHealthResponse) ProtoReflect

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

func (*CheckHealthResponse) Reset

func (x *CheckHealthResponse) Reset()

func (*CheckHealthResponse) String

func (x *CheckHealthResponse) String() string

type Cursor

type Cursor struct {
	CursorId string `protobuf:"bytes,1,opt,name=cursor_id,json=cursorId,proto3" json:"cursor_id,omitempty"`
	TypeName string `protobuf:"bytes,2,opt,name=type_name,json=typeName,proto3" json:"type_name,omitempty"` // Starlark Type() is "<type_name> iterator"
	LeakKey  string `protobuf:"bytes,3,opt,name=leak_key,json=leakKey,proto3" json:"leak_key,omitempty"`
	// Stream cursors are returned from the app handler as streaming HTTP
	// responses instead of being iterated in Starlark. Supported for
	// in-process modules only; reserved here for protocol completeness.
	Stream bool `protobuf:"varint,4,opt,name=stream,proto3" json:"stream,omitempty"`
	// contains filtered or unexported fields
}

Cursor is a handle to a lazy result iterator that stays in the provider process, scoped to the session that created it. The server wraps it in a Starlark iterable that batches CursorNext calls; leak_key names the strict deferred-cleanup entry the server registers so an unconsumed cursor fails the request the same way an unconsumed builtin cursor does.

func (*Cursor) Descriptor deprecated

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

Deprecated: Use Cursor.ProtoReflect.Descriptor instead.

func (*Cursor) GetCursorId

func (x *Cursor) GetCursorId() string

func (*Cursor) GetLeakKey

func (x *Cursor) GetLeakKey() string

func (*Cursor) GetStream

func (x *Cursor) GetStream() bool

func (*Cursor) GetTypeName

func (x *Cursor) GetTypeName() string

func (*Cursor) ProtoMessage

func (*Cursor) ProtoMessage()

func (*Cursor) ProtoReflect

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

func (*Cursor) Reset

func (x *Cursor) Reset()

func (*Cursor) String

func (x *Cursor) String() string

type CursorCloseRequest

type CursorCloseRequest struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	CursorId  string `protobuf:"bytes,2,opt,name=cursor_id,json=cursorId,proto3" json:"cursor_id,omitempty"`
	// contains filtered or unexported fields
}

func (*CursorCloseRequest) Descriptor deprecated

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

Deprecated: Use CursorCloseRequest.ProtoReflect.Descriptor instead.

func (*CursorCloseRequest) GetCursorId

func (x *CursorCloseRequest) GetCursorId() string

func (*CursorCloseRequest) GetSessionId

func (x *CursorCloseRequest) GetSessionId() string

func (*CursorCloseRequest) ProtoMessage

func (*CursorCloseRequest) ProtoMessage()

func (*CursorCloseRequest) ProtoReflect

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

func (*CursorCloseRequest) Reset

func (x *CursorCloseRequest) Reset()

func (*CursorCloseRequest) String

func (x *CursorCloseRequest) String() string

type CursorCloseResponse

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

func (*CursorCloseResponse) Descriptor deprecated

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

Deprecated: Use CursorCloseResponse.ProtoReflect.Descriptor instead.

func (*CursorCloseResponse) GetError

func (x *CursorCloseResponse) GetError() string

func (*CursorCloseResponse) ProtoMessage

func (*CursorCloseResponse) ProtoMessage()

func (*CursorCloseResponse) ProtoReflect

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

func (*CursorCloseResponse) Reset

func (x *CursorCloseResponse) Reset()

func (*CursorCloseResponse) String

func (x *CursorCloseResponse) String() string

type CursorNextRequest

type CursorNextRequest struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	CursorId  string `protobuf:"bytes,2,opt,name=cursor_id,json=cursorId,proto3" json:"cursor_id,omitempty"`
	MaxItems  int32  `protobuf:"varint,3,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"`
	// contains filtered or unexported fields
}

func (*CursorNextRequest) Descriptor deprecated

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

Deprecated: Use CursorNextRequest.ProtoReflect.Descriptor instead.

func (*CursorNextRequest) GetCursorId

func (x *CursorNextRequest) GetCursorId() string

func (*CursorNextRequest) GetMaxItems

func (x *CursorNextRequest) GetMaxItems() int32

func (*CursorNextRequest) GetSessionId

func (x *CursorNextRequest) GetSessionId() string

func (*CursorNextRequest) ProtoMessage

func (*CursorNextRequest) ProtoMessage()

func (*CursorNextRequest) ProtoReflect

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

func (*CursorNextRequest) Reset

func (x *CursorNextRequest) Reset()

func (*CursorNextRequest) String

func (x *CursorNextRequest) String() string

type CursorNextResponse

type CursorNextResponse struct {
	Items []*StarValue `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	Done  bool         `protobuf:"varint,2,opt,name=done,proto3" json:"done,omitempty"` // no more items; the provider has closed the cursor
	Error string       `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*CursorNextResponse) Descriptor deprecated

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

Deprecated: Use CursorNextResponse.ProtoReflect.Descriptor instead.

func (*CursorNextResponse) GetDone

func (x *CursorNextResponse) GetDone() bool

func (*CursorNextResponse) GetError

func (x *CursorNextResponse) GetError() string

func (*CursorNextResponse) GetItems

func (x *CursorNextResponse) GetItems() []*StarValue

func (*CursorNextResponse) ProtoMessage

func (*CursorNextResponse) ProtoMessage()

func (*CursorNextResponse) ProtoReflect

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

func (*CursorNextResponse) Reset

func (x *CursorNextResponse) Reset()

func (*CursorNextResponse) String

func (x *CursorNextResponse) String() string

type DescribeRequest

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

func (*DescribeRequest) Descriptor deprecated

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

Deprecated: Use DescribeRequest.ProtoReflect.Descriptor instead.

func (*DescribeRequest) ProtoMessage

func (*DescribeRequest) ProtoMessage()

func (*DescribeRequest) ProtoReflect

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

func (*DescribeRequest) Reset

func (x *DescribeRequest) Reset()

func (*DescribeRequest) String

func (x *DescribeRequest) String() string

type DescribeResponse

type DescribeResponse struct {
	ProviderVersion string            `protobuf:"bytes,1,opt,name=provider_version,json=providerVersion,proto3" json:"provider_version,omitempty"`
	Modules         []*ModuleManifest `protobuf:"bytes,2,rep,name=modules,proto3" json:"modules,omitempty"`
	// contains filtered or unexported fields
}

func (*DescribeResponse) Descriptor deprecated

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

Deprecated: Use DescribeResponse.ProtoReflect.Descriptor instead.

func (*DescribeResponse) GetModules

func (x *DescribeResponse) GetModules() []*ModuleManifest

func (*DescribeResponse) GetProviderVersion

func (x *DescribeResponse) GetProviderVersion() string

func (*DescribeResponse) ProtoMessage

func (*DescribeResponse) ProtoMessage()

func (*DescribeResponse) ProtoReflect

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

func (*DescribeResponse) Reset

func (x *DescribeResponse) Reset()

func (*DescribeResponse) String

func (x *DescribeResponse) String() string

type EndSessionRequest

type EndSessionRequest struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	Failed    bool   `protobuf:"varint,2,opt,name=failed,proto3" json:"failed,omitempty"`
	// contains filtered or unexported fields
}

func (*EndSessionRequest) Descriptor deprecated

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

Deprecated: Use EndSessionRequest.ProtoReflect.Descriptor instead.

func (*EndSessionRequest) GetFailed

func (x *EndSessionRequest) GetFailed() bool

func (*EndSessionRequest) GetSessionId

func (x *EndSessionRequest) GetSessionId() string

func (*EndSessionRequest) ProtoMessage

func (*EndSessionRequest) ProtoMessage()

func (*EndSessionRequest) ProtoReflect

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

func (*EndSessionRequest) Reset

func (x *EndSessionRequest) Reset()

func (*EndSessionRequest) String

func (x *EndSessionRequest) String() string

type EndSessionResponse

type EndSessionResponse struct {
	Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"` // deferred cleanup failures, for server-side logging
	// contains filtered or unexported fields
}

func (*EndSessionResponse) Descriptor deprecated

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

Deprecated: Use EndSessionResponse.ProtoReflect.Descriptor instead.

func (*EndSessionResponse) GetError

func (x *EndSessionResponse) GetError() string

func (*EndSessionResponse) ProtoMessage

func (*EndSessionResponse) ProtoMessage()

func (*EndSessionResponse) ProtoReflect

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

func (*EndSessionResponse) Reset

func (x *EndSessionResponse) Reset()

func (*EndSessionResponse) String

func (x *EndSessionResponse) String() string

type FuncRef

type FuncRef struct {
	Function string       `protobuf:"bytes,1,opt,name=function,proto3" json:"function,omitempty"`
	Args     []*StarValue `protobuf:"bytes,2,rep,name=args,proto3" json:"args,omitempty"`
	// contains filtered or unexported fields
}

FuncRef carries a value the server materializes as a zero-argument callable: calling it invokes the named plugin function with args, in the same module, account, and session as the call that returned it. Function names starting with "_" are internal: not exposed as module attributes, callable only through a FuncRef.

func (*FuncRef) Descriptor deprecated

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

Deprecated: Use FuncRef.ProtoReflect.Descriptor instead.

func (*FuncRef) GetArgs

func (x *FuncRef) GetArgs() []*StarValue

func (*FuncRef) GetFunction

func (x *FuncRef) GetFunction() string

func (*FuncRef) ProtoMessage

func (*FuncRef) ProtoMessage()

func (*FuncRef) ProtoReflect

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

func (*FuncRef) Reset

func (x *FuncRef) Reset()

func (*FuncRef) String

func (x *FuncRef) String() string

type FunctionManifest

type FunctionManifest struct {
	Name   string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	IsRead bool   `protobuf:"varint,2,opt,name=is_read,json=isRead,proto3" json:"is_read,omitempty"` // drives stage/preview write gating on the server
	// contains filtered or unexported fields
}

func (*FunctionManifest) Descriptor deprecated

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

Deprecated: Use FunctionManifest.ProtoReflect.Descriptor instead.

func (*FunctionManifest) GetIsRead

func (x *FunctionManifest) GetIsRead() bool

func (*FunctionManifest) GetName

func (x *FunctionManifest) GetName() string

func (*FunctionManifest) ProtoMessage

func (*FunctionManifest) ProtoMessage()

func (*FunctionManifest) ProtoReflect

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

func (*FunctionManifest) Reset

func (x *FunctionManifest) Reset()

func (*FunctionManifest) String

func (x *FunctionManifest) String() string

type InitAppRequest

type InitAppRequest struct {
	AppId   string `protobuf:"bytes,1,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
	AppPath string `protobuf:"bytes,2,opt,name=app_path,json=appPath,proto3" json:"app_path,omitempty"`
	IsDev   bool   `protobuf:"varint,3,opt,name=is_dev,json=isDev,proto3" json:"is_dev,omitempty"`
	// Raw contents of the app's schema.star, empty if the app has none.
	AppSchema []byte `protobuf:"bytes,4,opt,name=app_schema,json=appSchema,proto3" json:"app_schema,omitempty"`
	// contains filtered or unexported fields
}

func (*InitAppRequest) Descriptor deprecated

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

Deprecated: Use InitAppRequest.ProtoReflect.Descriptor instead.

func (*InitAppRequest) GetAppId

func (x *InitAppRequest) GetAppId() string

func (*InitAppRequest) GetAppPath

func (x *InitAppRequest) GetAppPath() string

func (*InitAppRequest) GetAppSchema

func (x *InitAppRequest) GetAppSchema() []byte

func (*InitAppRequest) GetIsDev

func (x *InitAppRequest) GetIsDev() bool

func (*InitAppRequest) ProtoMessage

func (*InitAppRequest) ProtoMessage()

func (*InitAppRequest) ProtoReflect

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

func (*InitAppRequest) Reset

func (x *InitAppRequest) Reset()

func (*InitAppRequest) String

func (x *InitAppRequest) String() string

type InitAppResponse

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

func (*InitAppResponse) Descriptor deprecated

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

Deprecated: Use InitAppResponse.ProtoReflect.Descriptor instead.

func (*InitAppResponse) GetError

func (x *InitAppResponse) GetError() string

func (*InitAppResponse) ProtoMessage

func (*InitAppResponse) ProtoMessage()

func (*InitAppResponse) ProtoReflect

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

func (*InitAppResponse) Reset

func (x *InitAppResponse) Reset()

func (*InitAppResponse) String

func (x *InitAppResponse) String() string

type InitModuleRequest

type InitModuleRequest struct {
	Module  string `protobuf:"bytes,1,opt,name=module,proto3" json:"module,omitempty"`
	Account string `protobuf:"bytes,2,opt,name=account,proto3" json:"account,omitempty"` // "" for the default account
	// Per-account plugin settings from the server config, e.g.
	// [plugin."store.ex#myaccount"]. Secrets are expanded by the server.
	Settings map[string]*StarValue `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*InitModuleRequest) Descriptor deprecated

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

Deprecated: Use InitModuleRequest.ProtoReflect.Descriptor instead.

func (*InitModuleRequest) GetAccount

func (x *InitModuleRequest) GetAccount() string

func (*InitModuleRequest) GetModule

func (x *InitModuleRequest) GetModule() string

func (*InitModuleRequest) GetSettings

func (x *InitModuleRequest) GetSettings() map[string]*StarValue

func (*InitModuleRequest) ProtoMessage

func (*InitModuleRequest) ProtoMessage()

func (*InitModuleRequest) ProtoReflect

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

func (*InitModuleRequest) Reset

func (x *InitModuleRequest) Reset()

func (*InitModuleRequest) String

func (x *InitModuleRequest) String() string

type InitModuleResponse

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

func (*InitModuleResponse) Descriptor deprecated

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

Deprecated: Use InitModuleResponse.ProtoReflect.Descriptor instead.

func (*InitModuleResponse) GetError

func (x *InitModuleResponse) GetError() string

func (*InitModuleResponse) ProtoMessage

func (*InitModuleResponse) ProtoMessage()

func (*InitModuleResponse) ProtoReflect

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

func (*InitModuleResponse) Reset

func (x *InitModuleResponse) Reset()

func (*InitModuleResponse) String

func (x *InitModuleResponse) String() string

type Kwarg

type Kwarg struct {
	Name  string     `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Value *StarValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*Kwarg) Descriptor deprecated

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

Deprecated: Use Kwarg.ProtoReflect.Descriptor instead.

func (*Kwarg) GetName

func (x *Kwarg) GetName() string

func (*Kwarg) GetValue

func (x *Kwarg) GetValue() *StarValue

func (*Kwarg) ProtoMessage

func (*Kwarg) ProtoMessage()

func (*Kwarg) ProtoReflect

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

func (*Kwarg) Reset

func (x *Kwarg) Reset()

func (*Kwarg) String

func (x *Kwarg) String() string

type ModuleManifest

type ModuleManifest struct {
	Name      string                `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // module "store" is loaded as "store.ex"
	Functions []*FunctionManifest   `protobuf:"bytes,2,rep,name=functions,proto3" json:"functions,omitempty"`
	Constants map[string]*StarValue `` /* 145-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ModuleManifest) Descriptor deprecated

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

Deprecated: Use ModuleManifest.ProtoReflect.Descriptor instead.

func (*ModuleManifest) GetConstants

func (x *ModuleManifest) GetConstants() map[string]*StarValue

func (*ModuleManifest) GetFunctions

func (x *ModuleManifest) GetFunctions() []*FunctionManifest

func (*ModuleManifest) GetName

func (x *ModuleManifest) GetName() string

func (*ModuleManifest) ProtoMessage

func (*ModuleManifest) ProtoMessage()

func (*ModuleManifest) ProtoReflect

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

func (*ModuleManifest) Reset

func (x *ModuleManifest) Reset()

func (*ModuleManifest) String

func (x *ModuleManifest) String() string

type PluginProviderClient

type PluginProviderClient interface {
	// Describe reports the modules served by this provider binary: function
	// manifests (used to build the Starlark module at load time without
	// launching a provider process) and module constants. Valid before InitApp.
	Describe(ctx context.Context, in *DescribeRequest, opts ...grpc.CallOption) (*DescribeResponse, error)
	// InitApp establishes the app identity for this provider process. The
	// server launches one provider process per app; InitApp is called once,
	// immediately after the handshake. A second call is a protocol error.
	InitApp(ctx context.Context, in *InitAppRequest, opts ...grpc.CallOption) (*InitAppResponse, error)
	// InitModule initializes one (module, account) instance in this process,
	// called lazily before the instance's first Call.
	InitModule(ctx context.Context, in *InitModuleRequest, opts ...grpc.CallOption) (*InitModuleResponse, error)
	// Call invokes one plugin function. The hot path.
	Call(ctx context.Context, in *CallRequest, opts ...grpc.CallOption) (*CallResponse, error)
	// CursorNext fetches the next batch of items from a cursor returned by a
	// previous Call in the same session.
	CursorNext(ctx context.Context, in *CursorNextRequest, opts ...grpc.CallOption) (*CursorNextResponse, error)
	// CursorClose releases a cursor. Closing an unknown cursor or session is
	// not an error (the cursor may have been drained or the session ended).
	CursorClose(ctx context.Context, in *CursorCloseRequest, opts ...grpc.CallOption) (*CursorCloseResponse, error)
	// EndSession releases all state held for a session: remaining deferred
	// cleanups run (open transactions roll back, cursors close) and the session
	// is forgotten. Called by the server when the request handler finishes.
	EndSession(ctx context.Context, in *EndSessionRequest, opts ...grpc.CallOption) (*EndSessionResponse, error)
	// CheckHealth reports whether the provider process is healthy.
	CheckHealth(ctx context.Context, in *CheckHealthRequest, opts ...grpc.CallOption) (*CheckHealthResponse, error)
}

PluginProviderClient is the client API for PluginProvider 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.

type PluginProviderServer

type PluginProviderServer interface {
	// Describe reports the modules served by this provider binary: function
	// manifests (used to build the Starlark module at load time without
	// launching a provider process) and module constants. Valid before InitApp.
	Describe(context.Context, *DescribeRequest) (*DescribeResponse, error)
	// InitApp establishes the app identity for this provider process. The
	// server launches one provider process per app; InitApp is called once,
	// immediately after the handshake. A second call is a protocol error.
	InitApp(context.Context, *InitAppRequest) (*InitAppResponse, error)
	// InitModule initializes one (module, account) instance in this process,
	// called lazily before the instance's first Call.
	InitModule(context.Context, *InitModuleRequest) (*InitModuleResponse, error)
	// Call invokes one plugin function. The hot path.
	Call(context.Context, *CallRequest) (*CallResponse, error)
	// CursorNext fetches the next batch of items from a cursor returned by a
	// previous Call in the same session.
	CursorNext(context.Context, *CursorNextRequest) (*CursorNextResponse, error)
	// CursorClose releases a cursor. Closing an unknown cursor or session is
	// not an error (the cursor may have been drained or the session ended).
	CursorClose(context.Context, *CursorCloseRequest) (*CursorCloseResponse, error)
	// EndSession releases all state held for a session: remaining deferred
	// cleanups run (open transactions roll back, cursors close) and the session
	// is forgotten. Called by the server when the request handler finishes.
	EndSession(context.Context, *EndSessionRequest) (*EndSessionResponse, error)
	// CheckHealth reports whether the provider process is healthy.
	CheckHealth(context.Context, *CheckHealthRequest) (*CheckHealthResponse, error)
	// contains filtered or unexported methods
}

PluginProviderServer is the server API for PluginProvider service. All implementations must embed UnimplementedPluginProviderServer for forward compatibility.

type StarDict

type StarDict struct {
	Entries []*StarEntry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"` // insertion order preserved
	// contains filtered or unexported fields
}

func (*StarDict) Descriptor deprecated

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

Deprecated: Use StarDict.ProtoReflect.Descriptor instead.

func (*StarDict) GetEntries

func (x *StarDict) GetEntries() []*StarEntry

func (*StarDict) ProtoMessage

func (*StarDict) ProtoMessage()

func (*StarDict) ProtoReflect

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

func (*StarDict) Reset

func (x *StarDict) Reset()

func (*StarDict) String

func (x *StarDict) String() string

type StarEntry

type StarEntry struct {
	Key   *StarValue `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value *StarValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*StarEntry) Descriptor deprecated

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

Deprecated: Use StarEntry.ProtoReflect.Descriptor instead.

func (*StarEntry) GetKey

func (x *StarEntry) GetKey() *StarValue

func (*StarEntry) GetValue

func (x *StarEntry) GetValue() *StarValue

func (*StarEntry) ProtoMessage

func (*StarEntry) ProtoMessage()

func (*StarEntry) ProtoReflect

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

func (*StarEntry) Reset

func (x *StarEntry) Reset()

func (*StarEntry) String

func (x *StarEntry) String() string

type StarValue

type StarValue struct {

	// Types that are valid to be assigned to Kind:
	//
	//	*StarValue_None
	//	*StarValue_Bool
	//	*StarValue_Int
	//	*StarValue_Bigint
	//	*StarValue_Float
	//	*StarValue_Str
	//	*StarValue_Bytes
	//	*StarValue_List
	//	*StarValue_Tuple
	//	*StarValue_Set
	//	*StarValue_Dict
	//	*StarValue_Struct
	//	*StarValue_TimeUnixNanos
	//	*StarValue_Cursor
	//	*StarValue_Thunk
	//	*StarValue_Funcref
	Kind isStarValue_Kind `protobuf_oneof:"kind"`
	// contains filtered or unexported fields
}

StarValue is the wire representation of a Starlark value. Full fidelity is preserved for the value shapes plugin calls can carry: big ints stay exact, int and float stay distinct types, tuples/sets/bytes are not folded into lists/strings, and dict entry order is preserved.

func (*StarValue) Descriptor deprecated

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

Deprecated: Use StarValue.ProtoReflect.Descriptor instead.

func (*StarValue) GetBigint

func (x *StarValue) GetBigint() *BigInt

func (*StarValue) GetBool

func (x *StarValue) GetBool() bool

func (*StarValue) GetBytes

func (x *StarValue) GetBytes() []byte

func (*StarValue) GetCursor

func (x *StarValue) GetCursor() *Cursor

func (*StarValue) GetDict

func (x *StarValue) GetDict() *StarDict

func (*StarValue) GetFloat

func (x *StarValue) GetFloat() float64

func (*StarValue) GetFuncref

func (x *StarValue) GetFuncref() *FuncRef

func (*StarValue) GetInt

func (x *StarValue) GetInt() int64

func (*StarValue) GetKind

func (x *StarValue) GetKind() isStarValue_Kind

func (*StarValue) GetList

func (x *StarValue) GetList() *ValueList

func (*StarValue) GetNone

func (x *StarValue) GetNone() bool

func (*StarValue) GetSet

func (x *StarValue) GetSet() *ValueList

func (*StarValue) GetStr

func (x *StarValue) GetStr() string

func (*StarValue) GetStruct

func (x *StarValue) GetStruct() *TypedStruct

func (*StarValue) GetThunk

func (x *StarValue) GetThunk() *Thunk

func (*StarValue) GetTimeUnixNanos

func (x *StarValue) GetTimeUnixNanos() int64

func (*StarValue) GetTuple

func (x *StarValue) GetTuple() *ValueList

func (*StarValue) ProtoMessage

func (*StarValue) ProtoMessage()

func (*StarValue) ProtoReflect

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

func (*StarValue) Reset

func (x *StarValue) Reset()

func (*StarValue) String

func (x *StarValue) String() string

type StarValue_Bigint

type StarValue_Bigint struct {
	Bigint *BigInt `protobuf:"bytes,4,opt,name=bigint,proto3,oneof"`
}

type StarValue_Bool

type StarValue_Bool struct {
	Bool bool `protobuf:"varint,2,opt,name=bool,proto3,oneof"`
}

type StarValue_Bytes

type StarValue_Bytes struct {
	Bytes []byte `protobuf:"bytes,7,opt,name=bytes,proto3,oneof"`
}

type StarValue_Cursor

type StarValue_Cursor struct {
	Cursor *Cursor `protobuf:"bytes,14,opt,name=cursor,proto3,oneof"` // handle to a provider-side lazy iterator
}

type StarValue_Dict

type StarValue_Dict struct {
	Dict *StarDict `protobuf:"bytes,11,opt,name=dict,proto3,oneof"`
}

type StarValue_Float

type StarValue_Float struct {
	Float float64 `protobuf:"fixed64,5,opt,name=float,proto3,oneof"`
}

type StarValue_Funcref

type StarValue_Funcref struct {
	Funcref *FuncRef `protobuf:"bytes,16,opt,name=funcref,proto3,oneof"` // zero-arg callable dispatching a plugin function
}

type StarValue_Int

type StarValue_Int struct {
	Int int64 `protobuf:"varint,3,opt,name=int,proto3,oneof"` // fast path for ints representable in 64 bits
}

type StarValue_List

type StarValue_List struct {
	List *ValueList `protobuf:"bytes,8,opt,name=list,proto3,oneof"`
}

type StarValue_None

type StarValue_None struct {
	None bool `protobuf:"varint,1,opt,name=none,proto3,oneof"` // presence marker; the bool value is ignored
}

type StarValue_Set

type StarValue_Set struct {
	Set *ValueList `protobuf:"bytes,10,opt,name=set,proto3,oneof"`
}

type StarValue_Str

type StarValue_Str struct {
	Str string `protobuf:"bytes,6,opt,name=str,proto3,oneof"`
}

type StarValue_Struct

type StarValue_Struct struct {
	Struct *TypedStruct `protobuf:"bytes,12,opt,name=struct,proto3,oneof"` // schema-typed record (attribute access)
}

type StarValue_Thunk

type StarValue_Thunk struct {
	Thunk *Thunk `protobuf:"bytes,15,opt,name=thunk,proto3,oneof"` // zero-arg callable over pre-computed data
}

type StarValue_TimeUnixNanos

type StarValue_TimeUnixNanos struct {
	TimeUnixNanos int64 `protobuf:"varint,13,opt,name=time_unix_nanos,json=timeUnixNanos,proto3,oneof"` // starlark time.time
}

type StarValue_Tuple

type StarValue_Tuple struct {
	Tuple *ValueList `protobuf:"bytes,9,opt,name=tuple,proto3,oneof"`
}

type ThreadState

type ThreadState struct {
	RequestId   string   `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	UserId      string   `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	UserSubject string   `protobuf:"bytes,3,opt,name=user_subject,json=userSubject,proto3" json:"user_subject,omitempty"`
	UserEmail   string   `protobuf:"bytes,4,opt,name=user_email,json=userEmail,proto3" json:"user_email,omitempty"`
	Groups      []string `protobuf:"bytes,5,rep,name=groups,proto3" json:"groups,omitempty"`
	AppUrl      string   `protobuf:"bytes,6,opt,name=app_url,json=appUrl,proto3" json:"app_url,omitempty"`
	// contains filtered or unexported fields
}

ThreadState snapshots the request-scoped Starlark thread state a plugin function may read.

func (*ThreadState) Descriptor deprecated

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

Deprecated: Use ThreadState.ProtoReflect.Descriptor instead.

func (*ThreadState) GetAppUrl

func (x *ThreadState) GetAppUrl() string

func (*ThreadState) GetGroups

func (x *ThreadState) GetGroups() []string

func (*ThreadState) GetRequestId

func (x *ThreadState) GetRequestId() string

func (*ThreadState) GetUserEmail

func (x *ThreadState) GetUserEmail() string

func (*ThreadState) GetUserId

func (x *ThreadState) GetUserId() string

func (*ThreadState) GetUserSubject

func (x *ThreadState) GetUserSubject() string

func (*ThreadState) ProtoMessage

func (*ThreadState) ProtoMessage()

func (*ThreadState) ProtoReflect

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

func (*ThreadState) Reset

func (x *ThreadState) Reset()

func (*ThreadState) String

func (x *ThreadState) String() string

type Thunk

type Thunk struct {
	Name  string     `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // callable name, for error messages
	Value *StarValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	Error string     `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

Thunk carries a value the server materializes as a zero-argument callable in the app: calling it returns the value, or fails with error if set. Used for records with callable members over pre-computed data, e.g. the http plugin's response.body() and response.json().

func (*Thunk) Descriptor deprecated

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

Deprecated: Use Thunk.ProtoReflect.Descriptor instead.

func (*Thunk) GetError

func (x *Thunk) GetError() string

func (*Thunk) GetName

func (x *Thunk) GetName() string

func (*Thunk) GetValue

func (x *Thunk) GetValue() *StarValue

func (*Thunk) ProtoMessage

func (*Thunk) ProtoMessage()

func (*Thunk) ProtoReflect

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

func (*Thunk) Reset

func (x *Thunk) Reset()

func (*Thunk) String

func (x *Thunk) String() string

type TypedStruct

type TypedStruct struct {
	TypeName string    `protobuf:"bytes,1,opt,name=type_name,json=typeName,proto3" json:"type_name,omitempty"`
	Fields   *StarDict `protobuf:"bytes,2,opt,name=fields,proto3" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

TypedStruct carries a schema-typed record: the server materializes it as a StarlarkType (attribute access, mutable fields), matching what builtin plugins return for typed values.

func (*TypedStruct) Descriptor deprecated

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

Deprecated: Use TypedStruct.ProtoReflect.Descriptor instead.

func (*TypedStruct) GetFields

func (x *TypedStruct) GetFields() *StarDict

func (*TypedStruct) GetTypeName

func (x *TypedStruct) GetTypeName() string

func (*TypedStruct) ProtoMessage

func (*TypedStruct) ProtoMessage()

func (*TypedStruct) ProtoReflect

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

func (*TypedStruct) Reset

func (x *TypedStruct) Reset()

func (*TypedStruct) String

func (x *TypedStruct) String() string

type UnimplementedPluginProviderServer

type UnimplementedPluginProviderServer struct{}

UnimplementedPluginProviderServer 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 (UnimplementedPluginProviderServer) Call

func (UnimplementedPluginProviderServer) CheckHealth

func (UnimplementedPluginProviderServer) CursorClose

func (UnimplementedPluginProviderServer) CursorNext

func (UnimplementedPluginProviderServer) Describe

func (UnimplementedPluginProviderServer) EndSession

func (UnimplementedPluginProviderServer) InitApp

func (UnimplementedPluginProviderServer) InitModule

type UnsafePluginProviderServer

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

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

type ValueList

type ValueList struct {
	Values []*StarValue `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

func (*ValueList) Descriptor deprecated

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

Deprecated: Use ValueList.ProtoReflect.Descriptor instead.

func (*ValueList) GetValues

func (x *ValueList) GetValues() []*StarValue

func (*ValueList) ProtoMessage

func (*ValueList) ProtoMessage()

func (*ValueList) ProtoReflect

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

func (*ValueList) Reset

func (x *ValueList) Reset()

func (*ValueList) String

func (x *ValueList) String() string

Jump to

Keyboard shortcuts

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