Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterPluginServiceServer(s grpc.ServiceRegistrar, srv PluginServiceServer)
- type ExecuteProviderRequest
- func (*ExecuteProviderRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ExecuteProviderRequest) GetContext() []byte
- func (x *ExecuteProviderRequest) GetDryRun() bool
- func (x *ExecuteProviderRequest) GetInput() []byte
- func (x *ExecuteProviderRequest) GetProviderName() string
- func (*ExecuteProviderRequest) ProtoMessage()
- func (x *ExecuteProviderRequest) ProtoReflect() protoreflect.Message
- func (x *ExecuteProviderRequest) Reset()
- func (x *ExecuteProviderRequest) String() string
- type ExecuteProviderResponse
- func (*ExecuteProviderResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ExecuteProviderResponse) GetError() string
- func (x *ExecuteProviderResponse) GetOutput() []byte
- func (*ExecuteProviderResponse) ProtoMessage()
- func (x *ExecuteProviderResponse) ProtoReflect() protoreflect.Message
- func (x *ExecuteProviderResponse) Reset()
- func (x *ExecuteProviderResponse) String() string
- type GetProviderDescriptorRequest
- func (*GetProviderDescriptorRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetProviderDescriptorRequest) GetProviderName() string
- func (*GetProviderDescriptorRequest) ProtoMessage()
- func (x *GetProviderDescriptorRequest) ProtoReflect() protoreflect.Message
- func (x *GetProviderDescriptorRequest) Reset()
- func (x *GetProviderDescriptorRequest) String() string
- type GetProviderDescriptorResponse
- func (*GetProviderDescriptorResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetProviderDescriptorResponse) GetDescriptor_() *ProviderDescriptor
- func (*GetProviderDescriptorResponse) ProtoMessage()
- func (x *GetProviderDescriptorResponse) ProtoReflect() protoreflect.Message
- func (x *GetProviderDescriptorResponse) Reset()
- func (x *GetProviderDescriptorResponse) String() string
- type GetProvidersRequest
- type GetProvidersResponse
- func (*GetProvidersResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetProvidersResponse) GetProviderNames() []string
- func (*GetProvidersResponse) ProtoMessage()
- func (x *GetProvidersResponse) ProtoReflect() protoreflect.Message
- func (x *GetProvidersResponse) Reset()
- func (x *GetProvidersResponse) String() string
- type Parameter
- func (*Parameter) Descriptor() ([]byte, []int)deprecated
- func (x *Parameter) GetDefaultValue() []byte
- func (x *Parameter) GetDescription() string
- func (x *Parameter) GetExample() string
- func (x *Parameter) GetMaxLength() int32
- func (x *Parameter) GetPattern() string
- func (x *Parameter) GetPatternDescription() string
- func (x *Parameter) GetRequired() bool
- func (x *Parameter) GetType() string
- func (*Parameter) ProtoMessage()
- func (x *Parameter) ProtoReflect() protoreflect.Message
- func (x *Parameter) Reset()
- func (x *Parameter) String() string
- type PluginServiceClient
- type PluginServiceServer
- type ProviderDescriptor
- func (*ProviderDescriptor) Descriptor() ([]byte, []int)deprecated
- func (x *ProviderDescriptor) GetCapabilities() []string
- func (x *ProviderDescriptor) GetCategory() string
- func (x *ProviderDescriptor) GetDescription() string
- func (x *ProviderDescriptor) GetDisplayName() string
- func (x *ProviderDescriptor) GetName() string
- func (x *ProviderDescriptor) GetOutputSchemas() map[string]*Schema
- func (x *ProviderDescriptor) GetSchema() *Schema
- func (x *ProviderDescriptor) GetVersion() string
- func (*ProviderDescriptor) ProtoMessage()
- func (x *ProviderDescriptor) ProtoReflect() protoreflect.Message
- func (x *ProviderDescriptor) Reset()
- func (x *ProviderDescriptor) String() string
- type Schema
- type UnimplementedPluginServiceServer
- func (UnimplementedPluginServiceServer) ExecuteProvider(context.Context, *ExecuteProviderRequest) (*ExecuteProviderResponse, error)
- func (UnimplementedPluginServiceServer) GetProviderDescriptor(context.Context, *GetProviderDescriptorRequest) (*GetProviderDescriptorResponse, error)
- func (UnimplementedPluginServiceServer) GetProviders(context.Context, *GetProvidersRequest) (*GetProvidersResponse, error)
- type UnsafePluginServiceServer
Constants ¶
const ( PluginService_GetProviders_FullMethodName = "/plugin.PluginService/GetProviders" PluginService_GetProviderDescriptor_FullMethodName = "/plugin.PluginService/GetProviderDescriptor" PluginService_ExecuteProvider_FullMethodName = "/plugin.PluginService/ExecuteProvider" )
Variables ¶
var File_pkg_plugin_proto_plugin_proto protoreflect.FileDescriptor
var PluginService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "plugin.PluginService", HandlerType: (*PluginServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetProviders", Handler: _PluginService_GetProviders_Handler, }, { MethodName: "GetProviderDescriptor", Handler: _PluginService_GetProviderDescriptor_Handler, }, { MethodName: "ExecuteProvider", Handler: _PluginService_ExecuteProvider_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "pkg/plugin/proto/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 RegisterPluginServiceServer ¶
func RegisterPluginServiceServer(s grpc.ServiceRegistrar, srv PluginServiceServer)
Types ¶
type ExecuteProviderRequest ¶
type ExecuteProviderRequest struct {
ProviderName string `protobuf:"bytes,1,opt,name=provider_name,json=providerName,proto3" json:"provider_name,omitempty"`
Input []byte `protobuf:"bytes,2,opt,name=input,proto3" json:"input,omitempty"` // JSON-encoded input map
Context []byte `protobuf:"bytes,3,opt,name=context,proto3" json:"context,omitempty"` // JSON-encoded context data
DryRun bool `protobuf:"varint,4,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
// contains filtered or unexported fields
}
func (*ExecuteProviderRequest) Descriptor
deprecated
func (*ExecuteProviderRequest) Descriptor() ([]byte, []int)
Deprecated: Use ExecuteProviderRequest.ProtoReflect.Descriptor instead.
func (*ExecuteProviderRequest) GetContext ¶
func (x *ExecuteProviderRequest) GetContext() []byte
func (*ExecuteProviderRequest) GetDryRun ¶
func (x *ExecuteProviderRequest) GetDryRun() bool
func (*ExecuteProviderRequest) GetInput ¶
func (x *ExecuteProviderRequest) GetInput() []byte
func (*ExecuteProviderRequest) GetProviderName ¶
func (x *ExecuteProviderRequest) GetProviderName() string
func (*ExecuteProviderRequest) ProtoMessage ¶
func (*ExecuteProviderRequest) ProtoMessage()
func (*ExecuteProviderRequest) ProtoReflect ¶
func (x *ExecuteProviderRequest) ProtoReflect() protoreflect.Message
func (*ExecuteProviderRequest) Reset ¶
func (x *ExecuteProviderRequest) Reset()
func (*ExecuteProviderRequest) String ¶
func (x *ExecuteProviderRequest) String() string
type ExecuteProviderResponse ¶
type ExecuteProviderResponse struct {
Output []byte `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"` // JSON-encoded output (ProviderOutput)
Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` // Empty if no error
// contains filtered or unexported fields
}
func (*ExecuteProviderResponse) Descriptor
deprecated
func (*ExecuteProviderResponse) Descriptor() ([]byte, []int)
Deprecated: Use ExecuteProviderResponse.ProtoReflect.Descriptor instead.
func (*ExecuteProviderResponse) GetError ¶
func (x *ExecuteProviderResponse) GetError() string
func (*ExecuteProviderResponse) GetOutput ¶
func (x *ExecuteProviderResponse) GetOutput() []byte
func (*ExecuteProviderResponse) ProtoMessage ¶
func (*ExecuteProviderResponse) ProtoMessage()
func (*ExecuteProviderResponse) ProtoReflect ¶
func (x *ExecuteProviderResponse) ProtoReflect() protoreflect.Message
func (*ExecuteProviderResponse) Reset ¶
func (x *ExecuteProviderResponse) Reset()
func (*ExecuteProviderResponse) String ¶
func (x *ExecuteProviderResponse) String() string
type GetProviderDescriptorRequest ¶
type GetProviderDescriptorRequest struct {
ProviderName string `protobuf:"bytes,1,opt,name=provider_name,json=providerName,proto3" json:"provider_name,omitempty"`
// contains filtered or unexported fields
}
func (*GetProviderDescriptorRequest) Descriptor
deprecated
func (*GetProviderDescriptorRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetProviderDescriptorRequest.ProtoReflect.Descriptor instead.
func (*GetProviderDescriptorRequest) GetProviderName ¶
func (x *GetProviderDescriptorRequest) GetProviderName() string
func (*GetProviderDescriptorRequest) ProtoMessage ¶
func (*GetProviderDescriptorRequest) ProtoMessage()
func (*GetProviderDescriptorRequest) ProtoReflect ¶
func (x *GetProviderDescriptorRequest) ProtoReflect() protoreflect.Message
func (*GetProviderDescriptorRequest) Reset ¶
func (x *GetProviderDescriptorRequest) Reset()
func (*GetProviderDescriptorRequest) String ¶
func (x *GetProviderDescriptorRequest) String() string
type GetProviderDescriptorResponse ¶
type GetProviderDescriptorResponse struct {
Descriptor_ *ProviderDescriptor `protobuf:"bytes,1,opt,name=descriptor,proto3" json:"descriptor,omitempty"`
// contains filtered or unexported fields
}
func (*GetProviderDescriptorResponse) Descriptor
deprecated
func (*GetProviderDescriptorResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetProviderDescriptorResponse.ProtoReflect.Descriptor instead.
func (*GetProviderDescriptorResponse) GetDescriptor_ ¶
func (x *GetProviderDescriptorResponse) GetDescriptor_() *ProviderDescriptor
func (*GetProviderDescriptorResponse) ProtoMessage ¶
func (*GetProviderDescriptorResponse) ProtoMessage()
func (*GetProviderDescriptorResponse) ProtoReflect ¶
func (x *GetProviderDescriptorResponse) ProtoReflect() protoreflect.Message
func (*GetProviderDescriptorResponse) Reset ¶
func (x *GetProviderDescriptorResponse) Reset()
func (*GetProviderDescriptorResponse) String ¶
func (x *GetProviderDescriptorResponse) String() string
type GetProvidersRequest ¶
type GetProvidersRequest struct {
// contains filtered or unexported fields
}
func (*GetProvidersRequest) Descriptor
deprecated
func (*GetProvidersRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetProvidersRequest.ProtoReflect.Descriptor instead.
func (*GetProvidersRequest) ProtoMessage ¶
func (*GetProvidersRequest) ProtoMessage()
func (*GetProvidersRequest) ProtoReflect ¶
func (x *GetProvidersRequest) ProtoReflect() protoreflect.Message
func (*GetProvidersRequest) Reset ¶
func (x *GetProvidersRequest) Reset()
func (*GetProvidersRequest) String ¶
func (x *GetProvidersRequest) String() string
type GetProvidersResponse ¶
type GetProvidersResponse struct {
ProviderNames []string `protobuf:"bytes,1,rep,name=provider_names,json=providerNames,proto3" json:"provider_names,omitempty"`
// contains filtered or unexported fields
}
func (*GetProvidersResponse) Descriptor
deprecated
func (*GetProvidersResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetProvidersResponse.ProtoReflect.Descriptor instead.
func (*GetProvidersResponse) GetProviderNames ¶
func (x *GetProvidersResponse) GetProviderNames() []string
func (*GetProvidersResponse) ProtoMessage ¶
func (*GetProvidersResponse) ProtoMessage()
func (*GetProvidersResponse) ProtoReflect ¶
func (x *GetProvidersResponse) ProtoReflect() protoreflect.Message
func (*GetProvidersResponse) Reset ¶
func (x *GetProvidersResponse) Reset()
func (*GetProvidersResponse) String ¶
func (x *GetProvidersResponse) String() string
type Parameter ¶
type Parameter struct {
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
Required bool `protobuf:"varint,2,opt,name=required,proto3" json:"required,omitempty"`
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
DefaultValue []byte `protobuf:"bytes,4,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"` // JSON-encoded
Example string `protobuf:"bytes,5,opt,name=example,proto3" json:"example,omitempty"`
MaxLength int32 `protobuf:"varint,6,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
Pattern string `protobuf:"bytes,7,opt,name=pattern,proto3" json:"pattern,omitempty"`
PatternDescription string `protobuf:"bytes,8,opt,name=pattern_description,json=patternDescription,proto3" json:"pattern_description,omitempty"`
// contains filtered or unexported fields
}
func (*Parameter) Descriptor
deprecated
func (*Parameter) GetDefaultValue ¶
func (*Parameter) GetDescription ¶
func (*Parameter) GetExample ¶
func (*Parameter) GetMaxLength ¶
func (*Parameter) GetPattern ¶
func (*Parameter) GetPatternDescription ¶
func (*Parameter) GetRequired ¶
func (*Parameter) ProtoMessage ¶
func (*Parameter) ProtoMessage()
func (*Parameter) ProtoReflect ¶
func (x *Parameter) ProtoReflect() protoreflect.Message
type PluginServiceClient ¶
type PluginServiceClient interface {
// GetProviders returns all providers exposed by this plugin
GetProviders(ctx context.Context, in *GetProvidersRequest, opts ...grpc.CallOption) (*GetProvidersResponse, error)
// GetProviderDescriptor returns metadata for a specific provider
GetProviderDescriptor(ctx context.Context, in *GetProviderDescriptorRequest, opts ...grpc.CallOption) (*GetProviderDescriptorResponse, error)
// ExecuteProvider executes a provider
ExecuteProvider(ctx context.Context, in *ExecuteProviderRequest, opts ...grpc.CallOption) (*ExecuteProviderResponse, 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 the main plugin service
func NewPluginServiceClient ¶
func NewPluginServiceClient(cc grpc.ClientConnInterface) PluginServiceClient
type PluginServiceServer ¶
type PluginServiceServer interface {
// GetProviders returns all providers exposed by this plugin
GetProviders(context.Context, *GetProvidersRequest) (*GetProvidersResponse, error)
// GetProviderDescriptor returns metadata for a specific provider
GetProviderDescriptor(context.Context, *GetProviderDescriptorRequest) (*GetProviderDescriptorResponse, error)
// ExecuteProvider executes a provider
ExecuteProvider(context.Context, *ExecuteProviderRequest) (*ExecuteProviderResponse, error)
// contains filtered or unexported methods
}
PluginServiceServer is the server API for PluginService service. All implementations must embed UnimplementedPluginServiceServer for forward compatibility.
PluginService is the main plugin service
type ProviderDescriptor ¶
type ProviderDescriptor struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
Category string `protobuf:"bytes,5,opt,name=category,proto3" json:"category,omitempty"`
Capabilities []string `protobuf:"bytes,6,rep,name=capabilities,proto3" json:"capabilities,omitempty"`
Schema *Schema `protobuf:"bytes,7,opt,name=schema,proto3" json:"schema,omitempty"`
OutputSchemas map[string]*Schema `` // key is capability string (from, transform, validation, authentication, action)
/* 174-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*ProviderDescriptor) Descriptor
deprecated
func (*ProviderDescriptor) Descriptor() ([]byte, []int)
Deprecated: Use ProviderDescriptor.ProtoReflect.Descriptor instead.
func (*ProviderDescriptor) GetCapabilities ¶
func (x *ProviderDescriptor) GetCapabilities() []string
func (*ProviderDescriptor) GetCategory ¶
func (x *ProviderDescriptor) GetCategory() string
func (*ProviderDescriptor) GetDescription ¶
func (x *ProviderDescriptor) GetDescription() string
func (*ProviderDescriptor) GetDisplayName ¶
func (x *ProviderDescriptor) GetDisplayName() string
func (*ProviderDescriptor) GetName ¶
func (x *ProviderDescriptor) GetName() string
func (*ProviderDescriptor) GetOutputSchemas ¶
func (x *ProviderDescriptor) GetOutputSchemas() map[string]*Schema
func (*ProviderDescriptor) GetSchema ¶
func (x *ProviderDescriptor) GetSchema() *Schema
func (*ProviderDescriptor) GetVersion ¶
func (x *ProviderDescriptor) GetVersion() string
func (*ProviderDescriptor) ProtoMessage ¶
func (*ProviderDescriptor) ProtoMessage()
func (*ProviderDescriptor) ProtoReflect ¶
func (x *ProviderDescriptor) ProtoReflect() protoreflect.Message
func (*ProviderDescriptor) Reset ¶
func (x *ProviderDescriptor) Reset()
func (*ProviderDescriptor) String ¶
func (x *ProviderDescriptor) String() string
type Schema ¶
type Schema struct {
Parameters map[string]*Parameter `` /* 147-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*Schema) Descriptor
deprecated
func (*Schema) GetParameters ¶
func (*Schema) ProtoMessage ¶
func (*Schema) ProtoMessage()
func (*Schema) ProtoReflect ¶
func (x *Schema) ProtoReflect() protoreflect.Message
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) ExecuteProvider ¶
func (UnimplementedPluginServiceServer) ExecuteProvider(context.Context, *ExecuteProviderRequest) (*ExecuteProviderResponse, error)
func (UnimplementedPluginServiceServer) GetProviderDescriptor ¶
func (UnimplementedPluginServiceServer) GetProviderDescriptor(context.Context, *GetProviderDescriptorRequest) (*GetProviderDescriptorResponse, error)
func (UnimplementedPluginServiceServer) GetProviders ¶
func (UnimplementedPluginServiceServer) GetProviders(context.Context, *GetProvidersRequest) (*GetProvidersResponse, error)
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.