Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pluginservicev1

package

Go to main page

Versions in this module

v0

v0.4.0

Jan 27, 2026

v0.3.0

Jan 27, 2026

Changes in this version

type Manager

+ Close func()

+ SetPluginProcess func(pluginType PluginType, id string, killProcess func() error)

type PluginInstance

+ KillProcess func() error

v0.2.0

Jan 6, 2026

v0.1.4

Dec 16, 2025

v0.1.3

Dec 9, 2025

v0.1.2

Dec 6, 2025

v0.1.1

Dec 6, 2025

Changes in this version

+ const DefaultPluginToPluginCallTimeout

+ const DefaultPort

+ const DefaultResourceStabilisationTimeout

+ const Service_AcquireResourceLock_FullMethodName

+ const Service_CallFunction_FullMethodName

+ const Service_DeployResource_FullMethodName

+ const Service_Deregister_FullMethodName

+ const Service_DestroyResource_FullMethodName

+ const Service_GetFunctionDefinition_FullMethodName

+ const Service_HasFunction_FullMethodName

+ const Service_ListFunctions_FullMethodName

+ const Service_LookupResourceInState_FullMethodName

+ const Service_Register_FullMethodName

+ var File_plugin_framework_pluginservicev1_service_proto protoreflect.FileDescriptor

+ var PluginType_name = map[int32]string

+ var PluginType_value = map[string]int32

+ var Service_ServiceDesc = grpc.ServiceDesc

+ func FunctionRegistryFromClient(client ServiceClient, hostInfo pluginutils.HostInfoContainer) provider.FunctionRegistry

+ func GetProviderPluginAdaptors(manager Manager) map[string]provider.Provider

+ func RegisterServiceServer(s grpc.ServiceRegistrar, srv ServiceServer)

+ func ResourceServiceFromClient(client ServiceClient) provider.ResourceService

+ type AcquireResourceLockRequest struct

+ AcquiredBy string

+ Context *sharedtypesv1.ProviderContext

+ InstanceId string

+ ResourceName string

+ func (*AcquireResourceLockRequest) Descriptor() ([]byte, []int)

+ func (*AcquireResourceLockRequest) ProtoMessage()

+ func (x *AcquireResourceLockRequest) GetAcquiredBy() string

+ func (x *AcquireResourceLockRequest) GetContext() *sharedtypesv1.ProviderContext

+ func (x *AcquireResourceLockRequest) GetInstanceId() string

+ func (x *AcquireResourceLockRequest) GetResourceName() string

+ func (x *AcquireResourceLockRequest) ProtoReflect() protoreflect.Message

+ func (x *AcquireResourceLockRequest) Reset()

+ func (x *AcquireResourceLockRequest) String() string

+ type AcquireResourceLockResponse struct

+ Response isAcquireResourceLockResponse_Response

+ func (*AcquireResourceLockResponse) Descriptor() ([]byte, []int)

+ func (*AcquireResourceLockResponse) ProtoMessage()

+ func (x *AcquireResourceLockResponse) GetErrorResponse() *sharedtypesv1.ErrorResponse

+ func (x *AcquireResourceLockResponse) GetResponse() isAcquireResourceLockResponse_Response

+ func (x *AcquireResourceLockResponse) GetResult() *AcquireResourceLockResult

+ func (x *AcquireResourceLockResponse) ProtoReflect() protoreflect.Message

+ func (x *AcquireResourceLockResponse) Reset()

+ func (x *AcquireResourceLockResponse) String() string

+ type AcquireResourceLockResponse_ErrorResponse struct

+ ErrorResponse *sharedtypesv1.ErrorResponse

+ type AcquireResourceLockResponse_Result struct

+ Result *AcquireResourceLockResult

+ type AcquireResourceLockResult struct

+ Acquired bool

+ func (*AcquireResourceLockResult) Descriptor() ([]byte, []int)

+ func (*AcquireResourceLockResult) ProtoMessage()

+ func (x *AcquireResourceLockResult) GetAcquired() bool

+ func (x *AcquireResourceLockResult) ProtoReflect() protoreflect.Message

+ func (x *AcquireResourceLockResult) Reset()

+ func (x *AcquireResourceLockResult) String() string

+ type DeployResourceServiceRequest struct

+ DeployRequest *sharedtypesv1.DeployResourceRequest

+ WaitUntilStable bool

+ func (*DeployResourceServiceRequest) Descriptor() ([]byte, []int)

+ func (*DeployResourceServiceRequest) ProtoMessage()

+ func (x *DeployResourceServiceRequest) GetDeployRequest() *sharedtypesv1.DeployResourceRequest

+ func (x *DeployResourceServiceRequest) GetWaitUntilStable() bool

+ func (x *DeployResourceServiceRequest) ProtoReflect() protoreflect.Message

+ func (x *DeployResourceServiceRequest) Reset()

+ func (x *DeployResourceServiceRequest) String() string

+ type FunctionCheckResult struct

+ HasFunction bool

+ func (*FunctionCheckResult) Descriptor() ([]byte, []int)

+ func (*FunctionCheckResult) ProtoMessage()

+ func (x *FunctionCheckResult) GetHasFunction() bool

+ func (x *FunctionCheckResult) ProtoReflect() protoreflect.Message

+ func (x *FunctionCheckResult) Reset()

+ func (x *FunctionCheckResult) String() string

+ type FunctionList struct

+ Functions []string

+ func (*FunctionList) Descriptor() ([]byte, []int)

+ func (*FunctionList) ProtoMessage()

+ func (x *FunctionList) GetFunctions() []string

+ func (x *FunctionList) ProtoReflect() protoreflect.Message

+ func (x *FunctionList) Reset()

+ func (x *FunctionList) String() string

+ type HasFunctionRequest struct

+ FunctionName string

+ func (*HasFunctionRequest) Descriptor() ([]byte, []int)

+ func (*HasFunctionRequest) ProtoMessage()

+ func (x *HasFunctionRequest) GetFunctionName() string

+ func (x *HasFunctionRequest) ProtoReflect() protoreflect.Message

+ func (x *HasFunctionRequest) Reset()

+ func (x *HasFunctionRequest) String() string

+ type HasFunctionResponse struct

+ Response isHasFunctionResponse_Response

+ func (*HasFunctionResponse) Descriptor() ([]byte, []int)

+ func (*HasFunctionResponse) ProtoMessage()

+ func (x *HasFunctionResponse) GetErrorResponse() *sharedtypesv1.ErrorResponse

+ func (x *HasFunctionResponse) GetFunctionCheckResult() *FunctionCheckResult

+ func (x *HasFunctionResponse) GetResponse() isHasFunctionResponse_Response

+ func (x *HasFunctionResponse) ProtoReflect() protoreflect.Message

+ func (x *HasFunctionResponse) Reset()

+ func (x *HasFunctionResponse) String() string

+ type HasFunctionResponse_ErrorResponse struct

+ ErrorResponse *sharedtypesv1.ErrorResponse

+ type HasFunctionResponse_FunctionCheckResult struct

+ FunctionCheckResult *FunctionCheckResult

+ type ListFunctionsResponse struct

+ Response isListFunctionsResponse_Response

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

+ func (*ListFunctionsResponse) ProtoMessage()

+ func (x *ListFunctionsResponse) GetErrorResponse() *sharedtypesv1.ErrorResponse

+ func (x *ListFunctionsResponse) GetFunctionList() *FunctionList

+ func (x *ListFunctionsResponse) GetResponse() isListFunctionsResponse_Response

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

+ func (x *ListFunctionsResponse) Reset()

+ func (x *ListFunctionsResponse) String() string

+ type ListFunctionsResponse_ErrorResponse struct

+ ErrorResponse *sharedtypesv1.ErrorResponse

+ type ListFunctionsResponse_FunctionList struct

+ FunctionList *FunctionList

+ type LookupResourceInStateRequest struct

+ Context *sharedtypesv1.ProviderContext

+ ExternalId string

+ InstanceId string

+ ResourceType string

+ func (*LookupResourceInStateRequest) Descriptor() ([]byte, []int)

+ func (*LookupResourceInStateRequest) ProtoMessage()

+ func (x *LookupResourceInStateRequest) GetContext() *sharedtypesv1.ProviderContext

+ func (x *LookupResourceInStateRequest) GetExternalId() string

+ func (x *LookupResourceInStateRequest) GetInstanceId() string

+ func (x *LookupResourceInStateRequest) GetResourceType() string

+ func (x *LookupResourceInStateRequest) ProtoReflect() protoreflect.Message

+ func (x *LookupResourceInStateRequest) Reset()

+ func (x *LookupResourceInStateRequest) String() string

+ type LookupResourceInStateResponse struct

+ Response isLookupResourceInStateResponse_Response

+ func (*LookupResourceInStateResponse) Descriptor() ([]byte, []int)

+ func (*LookupResourceInStateResponse) ProtoMessage()

+ func (x *LookupResourceInStateResponse) GetErrorResponse() *sharedtypesv1.ErrorResponse

+ func (x *LookupResourceInStateResponse) GetResource() *sharedtypesv1.ResourceState

+ func (x *LookupResourceInStateResponse) GetResponse() isLookupResourceInStateResponse_Response

+ func (x *LookupResourceInStateResponse) ProtoReflect() protoreflect.Message

+ func (x *LookupResourceInStateResponse) Reset()

+ func (x *LookupResourceInStateResponse) String() string

+ type LookupResourceInStateResponse_ErrorResponse struct

+ ErrorResponse *sharedtypesv1.ErrorResponse

+ type LookupResourceInStateResponse_Resource struct

+ Resource *sharedtypesv1.ResourceState

+ type Manager interface

+ DeregisterPlugin func(pluginType PluginType, id string) error

+ GetPlugin func(pluginType PluginType, id string) *PluginInstance

+ GetPluginMetadata func(pluginType PluginType, id string) *PluginExtendedMetadata

+ GetPlugins func(pluginType PluginType) []*PluginInstance

+ RegisterPlugin func(info *PluginInstanceInfo) error

+ func NewManager(protocolVersions map[PluginType]string, pluginFactory PluginFactory, ...) Manager

+ type PluginDeregistrationRequest struct

+ HostId string

+ InstanceId string

+ PluginType PluginType

+ func (*PluginDeregistrationRequest) Descriptor() ([]byte, []int)

+ func (*PluginDeregistrationRequest) ProtoMessage()

+ func (x *PluginDeregistrationRequest) GetHostId() string

+ func (x *PluginDeregistrationRequest) GetInstanceId() string

+ func (x *PluginDeregistrationRequest) GetPluginType() PluginType

+ func (x *PluginDeregistrationRequest) ProtoReflect() protoreflect.Message

+ func (x *PluginDeregistrationRequest) Reset()

+ func (x *PluginDeregistrationRequest) String() string

+ type PluginDeregistrationResponse struct

+ Message string

+ Success bool

+ func (*PluginDeregistrationResponse) Descriptor() ([]byte, []int)

+ func (*PluginDeregistrationResponse) ProtoMessage()

+ func (x *PluginDeregistrationResponse) GetMessage() string

+ func (x *PluginDeregistrationResponse) GetSuccess() bool

+ func (x *PluginDeregistrationResponse) ProtoReflect() protoreflect.Message

+ func (x *PluginDeregistrationResponse) Reset()

+ func (x *PluginDeregistrationResponse) String() string

+ type PluginExtendedMetadata struct

+ Author string

+ DisplayName string

+ FormattedDescription string

+ PlainTextDescription string

+ PluginVersion string

+ ProtocolVersions []string

+ RepositoryUrl string

+ type PluginFactory func(*PluginInstanceInfo, string) (any, func(), error)

+ type PluginInstance struct

+ Client any

+ CloseConn func()

+ Info *PluginInstanceInfo

+ type PluginInstanceInfo struct

+ ID string

+ InstanceID string

+ Metadata *PluginMetadata

+ PluginType PluginType

+ ProtocolVersions []string

+ TCPPort int

+ UnixSocketPath string

+ type PluginMetadata struct

+ Author string

+ DisplayName string

+ FormattedDescription string

+ PlainTextDescription string

+ PluginVersion string

+ RepositoryUrl string

+ func (*PluginMetadata) Descriptor() ([]byte, []int)

+ func (*PluginMetadata) ProtoMessage()

+ func (x *PluginMetadata) GetAuthor() string

+ func (x *PluginMetadata) GetDisplayName() string

+ func (x *PluginMetadata) GetFormattedDescription() string

+ func (x *PluginMetadata) GetPlainTextDescription() string

+ func (x *PluginMetadata) GetPluginVersion() string

+ func (x *PluginMetadata) GetRepositoryUrl() string

+ func (x *PluginMetadata) ProtoReflect() protoreflect.Message

+ func (x *PluginMetadata) Reset()

+ func (x *PluginMetadata) String() string

+ type PluginRegistrationRequest struct

+ InstanceId string

+ Metadata *PluginMetadata

+ PluginId string

+ PluginType PluginType

+ Port int32

+ ProtocolVersions []string

+ UnixSocket string

+ func (*PluginRegistrationRequest) Descriptor() ([]byte, []int)

+ func (*PluginRegistrationRequest) ProtoMessage()

+ func (x *PluginRegistrationRequest) GetInstanceId() string

+ func (x *PluginRegistrationRequest) GetMetadata() *PluginMetadata

+ func (x *PluginRegistrationRequest) GetPluginId() string

+ func (x *PluginRegistrationRequest) GetPluginType() PluginType

+ func (x *PluginRegistrationRequest) GetPort() int32

+ func (x *PluginRegistrationRequest) GetProtocolVersions() []string

+ func (x *PluginRegistrationRequest) GetUnixSocket() string

+ func (x *PluginRegistrationRequest) ProtoReflect() protoreflect.Message

+ func (x *PluginRegistrationRequest) Reset()

+ func (x *PluginRegistrationRequest) String() string

+ type PluginRegistrationResponse struct

+ HostId string

+ Message string

+ Success bool

+ func (*PluginRegistrationResponse) Descriptor() ([]byte, []int)

+ func (*PluginRegistrationResponse) ProtoMessage()

+ func (x *PluginRegistrationResponse) GetHostId() string

+ func (x *PluginRegistrationResponse) GetMessage() string

+ func (x *PluginRegistrationResponse) GetSuccess() bool

+ func (x *PluginRegistrationResponse) ProtoReflect() protoreflect.Message

+ func (x *PluginRegistrationResponse) Reset()

+ func (x *PluginRegistrationResponse) String() string

+ type PluginType int32

+ const PluginType_PLUGIN_TYPE_NONE

+ const PluginType_PLUGIN_TYPE_PROVIDER

+ const PluginType_PLUGIN_TYPE_TRANSFORMER

+ func PluginTypeFromString(typeString string) PluginType

+ func (PluginType) Descriptor() protoreflect.EnumDescriptor

+ func (PluginType) EnumDescriptor() ([]byte, []int)

+ func (PluginType) Type() protoreflect.EnumType

+ func (x PluginType) Enum() *PluginType

+ func (x PluginType) Number() protoreflect.EnumNumber

+ func (x PluginType) String() string

+ type Server struct

+ func NewServer(pluginService ServiceServer, opts ...ServerOption) *Server

+ func (s *Server) Serve() (func(), error)

+ type ServerOption func(*Server)

+ func WithDebug() ServerOption

+ func WithListener(listener net.Listener) ServerOption

+ func WithTCPPort(port int) ServerOption

+ func WithUnixSocket(path string) ServerOption

+ type ServiceClient interface

+ AcquireResourceLock func(ctx context.Context, in *AcquireResourceLockRequest, opts ...grpc.CallOption) (*AcquireResourceLockResponse, error)

+ CallFunction func(ctx context.Context, in *sharedtypesv1.FunctionCallRequest, ...) (*sharedtypesv1.FunctionCallResponse, error)

+ DeployResource func(ctx context.Context, in *DeployResourceServiceRequest, opts ...grpc.CallOption) (*sharedtypesv1.DeployResourceResponse, error)

+ Deregister func(ctx context.Context, in *PluginDeregistrationRequest, opts ...grpc.CallOption) (*PluginDeregistrationResponse, error)

+ DestroyResource func(ctx context.Context, in *sharedtypesv1.DestroyResourceRequest, ...) (*sharedtypesv1.DestroyResourceResponse, error)

+ GetFunctionDefinition func(ctx context.Context, in *sharedtypesv1.FunctionDefinitionRequest, ...) (*sharedtypesv1.FunctionDefinitionResponse, error)

+ HasFunction func(ctx context.Context, in *HasFunctionRequest, opts ...grpc.CallOption) (*HasFunctionResponse, error)

+ ListFunctions func(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*ListFunctionsResponse, error)

+ LookupResourceInState func(ctx context.Context, in *LookupResourceInStateRequest, opts ...grpc.CallOption) (*LookupResourceInStateResponse, error)

+ Register func(ctx context.Context, in *PluginRegistrationRequest, opts ...grpc.CallOption) (*PluginRegistrationResponse, error)

+ func NewEnvServiceClient() (ServiceClient, func(), error)

+ func NewServiceClient(cc grpc.ClientConnInterface) ServiceClient

+ type ServiceServer interface

+ AcquireResourceLock func(context.Context, *AcquireResourceLockRequest) (*AcquireResourceLockResponse, error)

+ CallFunction func(context.Context, *sharedtypesv1.FunctionCallRequest) (*sharedtypesv1.FunctionCallResponse, error)

+ DeployResource func(context.Context, *DeployResourceServiceRequest) (*sharedtypesv1.DeployResourceResponse, error)

+ Deregister func(context.Context, *PluginDeregistrationRequest) (*PluginDeregistrationResponse, error)

+ DestroyResource func(context.Context, *sharedtypesv1.DestroyResourceRequest) (*sharedtypesv1.DestroyResourceResponse, error)

+ GetFunctionDefinition func(context.Context, *sharedtypesv1.FunctionDefinitionRequest) (*sharedtypesv1.FunctionDefinitionResponse, error)

+ HasFunction func(context.Context, *HasFunctionRequest) (*HasFunctionResponse, error)

+ ListFunctions func(context.Context, *emptypb.Empty) (*ListFunctionsResponse, error)

+ LookupResourceInState func(context.Context, *LookupResourceInStateRequest) (*LookupResourceInStateResponse, error)

+ Register func(context.Context, *PluginRegistrationRequest) (*PluginRegistrationResponse, error)

+ func NewServiceServer(pluginManager Manager, functionRegistry provider.FunctionRegistry, ...) ServiceServer

+ type ServiceServerOption func(*pluginServiceServer)

+ func WithPluginToPluginCallTimeout(timeout int) ServiceServerOption

+ func WithResourceStabilisationTimeout(timeout int) ServiceServerOption

+ type UnimplementedServiceServer struct

+ func (UnimplementedServiceServer) AcquireResourceLock(context.Context, *AcquireResourceLockRequest) (*AcquireResourceLockResponse, error)

+ func (UnimplementedServiceServer) CallFunction(context.Context, *sharedtypesv1.FunctionCallRequest) (*sharedtypesv1.FunctionCallResponse, error)

+ func (UnimplementedServiceServer) DeployResource(context.Context, *DeployResourceServiceRequest) (*sharedtypesv1.DeployResourceResponse, error)

+ func (UnimplementedServiceServer) Deregister(context.Context, *PluginDeregistrationRequest) (*PluginDeregistrationResponse, error)

+ func (UnimplementedServiceServer) DestroyResource(context.Context, *sharedtypesv1.DestroyResourceRequest) (*sharedtypesv1.DestroyResourceResponse, error)

+ func (UnimplementedServiceServer) GetFunctionDefinition(context.Context, *sharedtypesv1.FunctionDefinitionRequest) (*sharedtypesv1.FunctionDefinitionResponse, error)

+ func (UnimplementedServiceServer) HasFunction(context.Context, *HasFunctionRequest) (*HasFunctionResponse, error)

+ func (UnimplementedServiceServer) ListFunctions(context.Context, *emptypb.Empty) (*ListFunctionsResponse, error)

+ func (UnimplementedServiceServer) LookupResourceInState(context.Context, *LookupResourceInStateRequest) (*LookupResourceInStateResponse, error)

+ func (UnimplementedServiceServer) Register(context.Context, *PluginRegistrationRequest) (*PluginRegistrationResponse, error)

+ type UnsafeServiceServer interface