Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterDSPluginServer(s grpc.ServiceRegistrar, srv DSPluginServer)
- func RegisterHostConfigServer(s grpc.ServiceRegistrar, srv HostConfigServer)
- type DSPlugin
- type DSPluginClient
- type DSPluginServer
- type ExecuteRequest
- func (*ExecuteRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ExecuteRequest) GetArgs() []string
- func (x *ExecuteRequest) GetEnv() map[string]string
- func (x *ExecuteRequest) GetHostConfigBrokerId() uint32
- func (x *ExecuteRequest) GetOperation() string
- func (*ExecuteRequest) ProtoMessage()
- func (x *ExecuteRequest) ProtoReflect() protoreflect.Message
- func (x *ExecuteRequest) Reset()
- func (x *ExecuteRequest) String() string
- type ExecuteResponse
- func (*ExecuteResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ExecuteResponse) GetError() string
- func (x *ExecuteResponse) GetExitCode() int32
- func (x *ExecuteResponse) GetFinalizers() []*FinalizerRequest
- func (x *ExecuteResponse) GetStderr() string
- func (x *ExecuteResponse) GetStdout() string
- func (*ExecuteResponse) ProtoMessage()
- func (x *ExecuteResponse) ProtoReflect() protoreflect.Message
- func (x *ExecuteResponse) Reset()
- func (x *ExecuteResponse) String() string
- type FinalizerRequest
- func (*FinalizerRequest) Descriptor() ([]byte, []int)deprecated
- func (x *FinalizerRequest) GetArgs() []string
- func (x *FinalizerRequest) GetName() string
- func (x *FinalizerRequest) GetOperation() string
- func (*FinalizerRequest) ProtoMessage()
- func (x *FinalizerRequest) ProtoReflect() protoreflect.Message
- func (x *FinalizerRequest) Reset()
- func (x *FinalizerRequest) String() string
- type GRPCClient
- func (m *GRPCClient) Execute(ctx context.Context, operation string, args []string) (*types.ExecutionResult, error)
- func (m *GRPCClient) GetManifest(ctx context.Context) (*types.PluginInfo, error)
- func (m *GRPCClient) GetSchema(ctx context.Context) (*types.PluginSchema, error)
- func (m *GRPCClient) ValidateConfig(ctx context.Context, config map[string]interface{}) error
- type GRPCServer
- func (m *GRPCServer) Execute(ctx context.Context, req *ExecuteRequest) (*ExecuteResponse, error)
- func (m *GRPCServer) GetManifest(ctx context.Context, req *GetManifestRequest) (*GetManifestResponse, error)
- func (m *GRPCServer) GetSchema(ctx context.Context, req *GetSchemaRequest) (*GetSchemaResponse, error)
- func (m *GRPCServer) ValidateConfig(ctx context.Context, req *ValidateConfigRequest) (*ValidateConfigResponse, error)
- type GetEffectiveConfigRequest
- type GetEffectiveConfigResponse
- func (*GetEffectiveConfigResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetEffectiveConfigResponse) GetConfigJson() []byte
- func (*GetEffectiveConfigResponse) ProtoMessage()
- func (x *GetEffectiveConfigResponse) ProtoReflect() protoreflect.Message
- func (x *GetEffectiveConfigResponse) Reset()
- func (x *GetEffectiveConfigResponse) String() string
- type GetManifestRequest
- type GetManifestResponse
- func (*GetManifestResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetManifestResponse) GetAnnotations() map[string]string
- func (x *GetManifestResponse) GetCommands() []*PluginCommand
- func (x *GetManifestResponse) GetDescription() string
- func (x *GetManifestResponse) GetName() string
- func (x *GetManifestResponse) GetPlatform() *Platform
- func (x *GetManifestResponse) GetVersion() string
- func (*GetManifestResponse) ProtoMessage()
- func (x *GetManifestResponse) ProtoReflect() protoreflect.Message
- func (x *GetManifestResponse) Reset()
- func (x *GetManifestResponse) String() string
- type GetSchemaRequest
- type GetSchemaResponse
- func (*GetSchemaResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetSchemaResponse) GetProperties() map[string]*SchemaProperty
- func (x *GetSchemaResponse) GetVersion() string
- func (*GetSchemaResponse) ProtoMessage()
- func (x *GetSchemaResponse) ProtoReflect() protoreflect.Message
- func (x *GetSchemaResponse) Reset()
- func (x *GetSchemaResponse) String() string
- type HostConfigClient
- type HostConfigServer
- type Platform
- type PluginCommand
- func (*PluginCommand) Descriptor() ([]byte, []int)deprecated
- func (x *PluginCommand) GetDescription() string
- func (x *PluginCommand) GetName() string
- func (*PluginCommand) ProtoMessage()
- func (x *PluginCommand) ProtoReflect() protoreflect.Message
- func (x *PluginCommand) Reset()
- func (x *PluginCommand) String() string
- type SchemaProperty
- func (*SchemaProperty) Descriptor() ([]byte, []int)deprecated
- func (x *SchemaProperty) GetDefault() string
- func (x *SchemaProperty) GetDescription() string
- func (x *SchemaProperty) GetRequired() bool
- func (x *SchemaProperty) GetType() string
- func (*SchemaProperty) ProtoMessage()
- func (x *SchemaProperty) ProtoReflect() protoreflect.Message
- func (x *SchemaProperty) Reset()
- func (x *SchemaProperty) String() string
- type UnimplementedDSPluginServer
- func (UnimplementedDSPluginServer) Execute(context.Context, *ExecuteRequest) (*ExecuteResponse, error)
- func (UnimplementedDSPluginServer) GetManifest(context.Context, *GetManifestRequest) (*GetManifestResponse, error)
- func (UnimplementedDSPluginServer) GetSchema(context.Context, *GetSchemaRequest) (*GetSchemaResponse, error)
- func (UnimplementedDSPluginServer) ValidateConfig(context.Context, *ValidateConfigRequest) (*ValidateConfigResponse, error)
- type UnimplementedHostConfigServer
- type UnsafeDSPluginServer
- type UnsafeHostConfigServer
- type ValidateConfigRequest
- func (*ValidateConfigRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ValidateConfigRequest) GetConfig() map[string]string
- func (*ValidateConfigRequest) ProtoMessage()
- func (x *ValidateConfigRequest) ProtoReflect() protoreflect.Message
- func (x *ValidateConfigRequest) Reset()
- func (x *ValidateConfigRequest) String() string
- type ValidateConfigResponse
- func (*ValidateConfigResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ValidateConfigResponse) GetError() string
- func (x *ValidateConfigResponse) GetValid() bool
- func (*ValidateConfigResponse) ProtoMessage()
- func (x *ValidateConfigResponse) ProtoReflect() protoreflect.Message
- func (x *ValidateConfigResponse) Reset()
- func (x *ValidateConfigResponse) String() string
Constants ¶
const ( DSPlugin_GetManifest_FullMethodName = "/plugin.DSPlugin/GetManifest" DSPlugin_Execute_FullMethodName = "/plugin.DSPlugin/Execute" DSPlugin_ValidateConfig_FullMethodName = "/plugin.DSPlugin/ValidateConfig" DSPlugin_GetSchema_FullMethodName = "/plugin.DSPlugin/GetSchema" )
const (
HostConfig_GetEffectiveConfig_FullMethodName = "/plugin.HostConfig/GetEffectiveConfig"
)
Variables ¶
var DSPlugin_ServiceDesc = grpc.ServiceDesc{ ServiceName: "plugin.DSPlugin", HandlerType: (*DSPluginServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetManifest", Handler: _DSPlugin_GetManifest_Handler, }, { MethodName: "Execute", Handler: _DSPlugin_Execute_Handler, }, { MethodName: "ValidateConfig", Handler: _DSPlugin_ValidateConfig_Handler, }, { MethodName: "GetSchema", Handler: _DSPlugin_GetSchema_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "pkg/plugin/plugin.proto", }
DSPlugin_ServiceDesc is the grpc.ServiceDesc for DSPlugin service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_pkg_plugin_plugin_proto protoreflect.FileDescriptor
var Handshake = plugin.HandshakeConfig{
ProtocolVersion: 1,
MagicCookieKey: "DS_PLUGIN_MAGIC_COOKIE",
MagicCookieValue: "delivery-station-plugin",
}
Handshake is a common handshake config for all plugins
var HostConfig_ServiceDesc = grpc.ServiceDesc{ ServiceName: "plugin.HostConfig", HandlerType: (*HostConfigServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetEffectiveConfig", Handler: _HostConfig_GetEffectiveConfig_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "pkg/plugin/plugin.proto", }
HostConfig_ServiceDesc is the grpc.ServiceDesc for HostConfig service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var PluginMap = map[string]plugin.Plugin{ "ds-plugin": &DSPlugin{}, }
PluginMap is the map of plugins we can dispense.
Functions ¶
func RegisterDSPluginServer ¶
func RegisterDSPluginServer(s grpc.ServiceRegistrar, srv DSPluginServer)
func RegisterHostConfigServer ¶ added in v1.3.0
func RegisterHostConfigServer(s grpc.ServiceRegistrar, srv HostConfigServer)
Types ¶
type DSPlugin ¶
type DSPlugin struct {
plugin.Plugin
// Impl is the interface implementation
Impl types.PluginProtocol
}
DSPlugin is the implementation of plugin.Plugin so we can serve/consume this
func (*DSPlugin) GRPCClient ¶
func (p *DSPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
func (*DSPlugin) GRPCServer ¶
type DSPluginClient ¶
type DSPluginClient interface {
GetManifest(ctx context.Context, in *GetManifestRequest, opts ...grpc.CallOption) (*GetManifestResponse, error)
Execute(ctx context.Context, in *ExecuteRequest, opts ...grpc.CallOption) (*ExecuteResponse, error)
ValidateConfig(ctx context.Context, in *ValidateConfigRequest, opts ...grpc.CallOption) (*ValidateConfigResponse, error)
GetSchema(ctx context.Context, in *GetSchemaRequest, opts ...grpc.CallOption) (*GetSchemaResponse, error)
}
DSPluginClient is the client API for DSPlugin 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.
DSPlugin service definition
func NewDSPluginClient ¶
func NewDSPluginClient(cc grpc.ClientConnInterface) DSPluginClient
type DSPluginServer ¶
type DSPluginServer interface {
GetManifest(context.Context, *GetManifestRequest) (*GetManifestResponse, error)
Execute(context.Context, *ExecuteRequest) (*ExecuteResponse, error)
ValidateConfig(context.Context, *ValidateConfigRequest) (*ValidateConfigResponse, error)
GetSchema(context.Context, *GetSchemaRequest) (*GetSchemaResponse, error)
// contains filtered or unexported methods
}
DSPluginServer is the server API for DSPlugin service. All implementations must embed UnimplementedDSPluginServer for forward compatibility.
DSPlugin service definition
type ExecuteRequest ¶
type ExecuteRequest struct {
Operation string `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
Args []string `protobuf:"bytes,2,rep,name=args,proto3" json:"args,omitempty"`
Env map[string]string `` /* 133-byte string literal not displayed */
HostConfigBrokerId uint32 `protobuf:"varint,4,opt,name=host_config_broker_id,json=hostConfigBrokerId,proto3" json:"host_config_broker_id,omitempty"`
// contains filtered or unexported fields
}
func (*ExecuteRequest) Descriptor
deprecated
func (*ExecuteRequest) Descriptor() ([]byte, []int)
Deprecated: Use ExecuteRequest.ProtoReflect.Descriptor instead.
func (*ExecuteRequest) GetArgs ¶
func (x *ExecuteRequest) GetArgs() []string
func (*ExecuteRequest) GetEnv ¶
func (x *ExecuteRequest) GetEnv() map[string]string
func (*ExecuteRequest) GetHostConfigBrokerId ¶ added in v1.3.0
func (x *ExecuteRequest) GetHostConfigBrokerId() uint32
func (*ExecuteRequest) GetOperation ¶
func (x *ExecuteRequest) GetOperation() string
func (*ExecuteRequest) ProtoMessage ¶
func (*ExecuteRequest) ProtoMessage()
func (*ExecuteRequest) ProtoReflect ¶
func (x *ExecuteRequest) ProtoReflect() protoreflect.Message
func (*ExecuteRequest) Reset ¶
func (x *ExecuteRequest) Reset()
func (*ExecuteRequest) String ¶
func (x *ExecuteRequest) String() string
type ExecuteResponse ¶
type ExecuteResponse struct {
Stdout string `protobuf:"bytes,1,opt,name=stdout,proto3" json:"stdout,omitempty"`
Stderr string `protobuf:"bytes,2,opt,name=stderr,proto3" json:"stderr,omitempty"`
ExitCode int32 `protobuf:"varint,3,opt,name=exit_code,json=exitCode,proto3" json:"exit_code,omitempty"`
Error string `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`
Finalizers []*FinalizerRequest `protobuf:"bytes,5,rep,name=finalizers,proto3" json:"finalizers,omitempty"`
// contains filtered or unexported fields
}
func (*ExecuteResponse) Descriptor
deprecated
func (*ExecuteResponse) Descriptor() ([]byte, []int)
Deprecated: Use ExecuteResponse.ProtoReflect.Descriptor instead.
func (*ExecuteResponse) GetError ¶
func (x *ExecuteResponse) GetError() string
func (*ExecuteResponse) GetExitCode ¶
func (x *ExecuteResponse) GetExitCode() int32
func (*ExecuteResponse) GetFinalizers ¶ added in v1.5.0
func (x *ExecuteResponse) GetFinalizers() []*FinalizerRequest
func (*ExecuteResponse) GetStderr ¶
func (x *ExecuteResponse) GetStderr() string
func (*ExecuteResponse) GetStdout ¶
func (x *ExecuteResponse) GetStdout() string
func (*ExecuteResponse) ProtoMessage ¶
func (*ExecuteResponse) ProtoMessage()
func (*ExecuteResponse) ProtoReflect ¶
func (x *ExecuteResponse) ProtoReflect() protoreflect.Message
func (*ExecuteResponse) Reset ¶
func (x *ExecuteResponse) Reset()
func (*ExecuteResponse) String ¶
func (x *ExecuteResponse) String() string
type FinalizerRequest ¶ added in v1.5.0
type FinalizerRequest struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Operation string `protobuf:"bytes,2,opt,name=operation,proto3" json:"operation,omitempty"`
Args []string `protobuf:"bytes,3,rep,name=args,proto3" json:"args,omitempty"`
// contains filtered or unexported fields
}
func (*FinalizerRequest) Descriptor
deprecated
added in
v1.5.0
func (*FinalizerRequest) Descriptor() ([]byte, []int)
Deprecated: Use FinalizerRequest.ProtoReflect.Descriptor instead.
func (*FinalizerRequest) GetArgs ¶ added in v1.5.0
func (x *FinalizerRequest) GetArgs() []string
func (*FinalizerRequest) GetName ¶ added in v1.5.0
func (x *FinalizerRequest) GetName() string
func (*FinalizerRequest) GetOperation ¶ added in v1.5.0
func (x *FinalizerRequest) GetOperation() string
func (*FinalizerRequest) ProtoMessage ¶ added in v1.5.0
func (*FinalizerRequest) ProtoMessage()
func (*FinalizerRequest) ProtoReflect ¶ added in v1.5.0
func (x *FinalizerRequest) ProtoReflect() protoreflect.Message
func (*FinalizerRequest) Reset ¶ added in v1.5.0
func (x *FinalizerRequest) Reset()
func (*FinalizerRequest) String ¶ added in v1.5.0
func (x *FinalizerRequest) String() string
type GRPCClient ¶
type GRPCClient struct {
// contains filtered or unexported fields
}
GRPCClient is an implementation of PluginProtocol that talks over RPC
func (*GRPCClient) Execute ¶
func (m *GRPCClient) Execute(ctx context.Context, operation string, args []string) (*types.ExecutionResult, error)
func (*GRPCClient) GetManifest ¶ added in v1.6.0
func (m *GRPCClient) GetManifest(ctx context.Context) (*types.PluginInfo, error)
func (*GRPCClient) GetSchema ¶
func (m *GRPCClient) GetSchema(ctx context.Context) (*types.PluginSchema, error)
func (*GRPCClient) ValidateConfig ¶
func (m *GRPCClient) ValidateConfig(ctx context.Context, config map[string]interface{}) error
type GRPCServer ¶
type GRPCServer struct {
UnimplementedDSPluginServer
Impl types.PluginProtocol
// contains filtered or unexported fields
}
GRPCServer is the gRPC server that GRPCClient talks to
func (*GRPCServer) Execute ¶
func (m *GRPCServer) Execute(ctx context.Context, req *ExecuteRequest) (*ExecuteResponse, error)
func (*GRPCServer) GetManifest ¶ added in v1.6.0
func (m *GRPCServer) GetManifest(ctx context.Context, req *GetManifestRequest) (*GetManifestResponse, error)
func (*GRPCServer) GetSchema ¶
func (m *GRPCServer) GetSchema(ctx context.Context, req *GetSchemaRequest) (*GetSchemaResponse, error)
func (*GRPCServer) ValidateConfig ¶
func (m *GRPCServer) ValidateConfig(ctx context.Context, req *ValidateConfigRequest) (*ValidateConfigResponse, error)
type GetEffectiveConfigRequest ¶ added in v1.3.0
type GetEffectiveConfigRequest struct {
// contains filtered or unexported fields
}
func (*GetEffectiveConfigRequest) Descriptor
deprecated
added in
v1.3.0
func (*GetEffectiveConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetEffectiveConfigRequest.ProtoReflect.Descriptor instead.
func (*GetEffectiveConfigRequest) ProtoMessage ¶ added in v1.3.0
func (*GetEffectiveConfigRequest) ProtoMessage()
func (*GetEffectiveConfigRequest) ProtoReflect ¶ added in v1.3.0
func (x *GetEffectiveConfigRequest) ProtoReflect() protoreflect.Message
func (*GetEffectiveConfigRequest) Reset ¶ added in v1.3.0
func (x *GetEffectiveConfigRequest) Reset()
func (*GetEffectiveConfigRequest) String ¶ added in v1.3.0
func (x *GetEffectiveConfigRequest) String() string
type GetEffectiveConfigResponse ¶ added in v1.3.0
type GetEffectiveConfigResponse struct {
ConfigJson []byte `protobuf:"bytes,1,opt,name=config_json,json=configJson,proto3" json:"config_json,omitempty"`
// contains filtered or unexported fields
}
func (*GetEffectiveConfigResponse) Descriptor
deprecated
added in
v1.3.0
func (*GetEffectiveConfigResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetEffectiveConfigResponse.ProtoReflect.Descriptor instead.
func (*GetEffectiveConfigResponse) GetConfigJson ¶ added in v1.3.0
func (x *GetEffectiveConfigResponse) GetConfigJson() []byte
func (*GetEffectiveConfigResponse) ProtoMessage ¶ added in v1.3.0
func (*GetEffectiveConfigResponse) ProtoMessage()
func (*GetEffectiveConfigResponse) ProtoReflect ¶ added in v1.3.0
func (x *GetEffectiveConfigResponse) ProtoReflect() protoreflect.Message
func (*GetEffectiveConfigResponse) Reset ¶ added in v1.3.0
func (x *GetEffectiveConfigResponse) Reset()
func (*GetEffectiveConfigResponse) String ¶ added in v1.3.0
func (x *GetEffectiveConfigResponse) String() string
type GetManifestRequest ¶ added in v1.6.0
type GetManifestRequest struct {
// contains filtered or unexported fields
}
func (*GetManifestRequest) Descriptor
deprecated
added in
v1.6.0
func (*GetManifestRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetManifestRequest.ProtoReflect.Descriptor instead.
func (*GetManifestRequest) ProtoMessage ¶ added in v1.6.0
func (*GetManifestRequest) ProtoMessage()
func (*GetManifestRequest) ProtoReflect ¶ added in v1.6.0
func (x *GetManifestRequest) ProtoReflect() protoreflect.Message
func (*GetManifestRequest) Reset ¶ added in v1.6.0
func (x *GetManifestRequest) Reset()
func (*GetManifestRequest) String ¶ added in v1.6.0
func (x *GetManifestRequest) String() string
type GetManifestResponse ¶ added in v1.6.0
type GetManifestResponse struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
Commands []*PluginCommand `protobuf:"bytes,5,rep,name=commands,proto3" json:"commands,omitempty"`
Platform *Platform `protobuf:"bytes,6,opt,name=platform,proto3" json:"platform,omitempty"`
Annotations map[string]string `` /* 149-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*GetManifestResponse) Descriptor
deprecated
added in
v1.6.0
func (*GetManifestResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetManifestResponse.ProtoReflect.Descriptor instead.
func (*GetManifestResponse) GetAnnotations ¶ added in v1.6.0
func (x *GetManifestResponse) GetAnnotations() map[string]string
func (*GetManifestResponse) GetCommands ¶ added in v1.6.0
func (x *GetManifestResponse) GetCommands() []*PluginCommand
func (*GetManifestResponse) GetDescription ¶ added in v1.6.0
func (x *GetManifestResponse) GetDescription() string
func (*GetManifestResponse) GetName ¶ added in v1.6.0
func (x *GetManifestResponse) GetName() string
func (*GetManifestResponse) GetPlatform ¶ added in v1.6.0
func (x *GetManifestResponse) GetPlatform() *Platform
func (*GetManifestResponse) GetVersion ¶ added in v1.6.0
func (x *GetManifestResponse) GetVersion() string
func (*GetManifestResponse) ProtoMessage ¶ added in v1.6.0
func (*GetManifestResponse) ProtoMessage()
func (*GetManifestResponse) ProtoReflect ¶ added in v1.6.0
func (x *GetManifestResponse) ProtoReflect() protoreflect.Message
func (*GetManifestResponse) Reset ¶ added in v1.6.0
func (x *GetManifestResponse) Reset()
func (*GetManifestResponse) String ¶ added in v1.6.0
func (x *GetManifestResponse) String() string
type GetSchemaRequest ¶
type GetSchemaRequest struct {
// contains filtered or unexported fields
}
func (*GetSchemaRequest) Descriptor
deprecated
func (*GetSchemaRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSchemaRequest.ProtoReflect.Descriptor instead.
func (*GetSchemaRequest) ProtoMessage ¶
func (*GetSchemaRequest) ProtoMessage()
func (*GetSchemaRequest) ProtoReflect ¶
func (x *GetSchemaRequest) ProtoReflect() protoreflect.Message
func (*GetSchemaRequest) Reset ¶
func (x *GetSchemaRequest) Reset()
func (*GetSchemaRequest) String ¶
func (x *GetSchemaRequest) String() string
type GetSchemaResponse ¶
type GetSchemaResponse struct {
Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
Properties map[string]*SchemaProperty `` /* 147-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*GetSchemaResponse) Descriptor
deprecated
func (*GetSchemaResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetSchemaResponse.ProtoReflect.Descriptor instead.
func (*GetSchemaResponse) GetProperties ¶
func (x *GetSchemaResponse) GetProperties() map[string]*SchemaProperty
func (*GetSchemaResponse) GetVersion ¶
func (x *GetSchemaResponse) GetVersion() string
func (*GetSchemaResponse) ProtoMessage ¶
func (*GetSchemaResponse) ProtoMessage()
func (*GetSchemaResponse) ProtoReflect ¶
func (x *GetSchemaResponse) ProtoReflect() protoreflect.Message
func (*GetSchemaResponse) Reset ¶
func (x *GetSchemaResponse) Reset()
func (*GetSchemaResponse) String ¶
func (x *GetSchemaResponse) String() string
type HostConfigClient ¶ added in v1.3.0
type HostConfigClient interface {
GetEffectiveConfig(ctx context.Context, in *GetEffectiveConfigRequest, opts ...grpc.CallOption) (*GetEffectiveConfigResponse, error)
}
HostConfigClient is the client API for HostConfig 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.
HostConfig exposes host-provided configuration to plugins over the gRPC broker
func NewHostConfigClient ¶ added in v1.3.0
func NewHostConfigClient(cc grpc.ClientConnInterface) HostConfigClient
type HostConfigServer ¶ added in v1.3.0
type HostConfigServer interface {
GetEffectiveConfig(context.Context, *GetEffectiveConfigRequest) (*GetEffectiveConfigResponse, error)
// contains filtered or unexported methods
}
HostConfigServer is the server API for HostConfig service. All implementations must embed UnimplementedHostConfigServer for forward compatibility.
HostConfig exposes host-provided configuration to plugins over the gRPC broker
type Platform ¶
type Platform struct {
Os []string `protobuf:"bytes,1,rep,name=os,proto3" json:"os,omitempty"`
Arch []string `protobuf:"bytes,2,rep,name=arch,proto3" json:"arch,omitempty"`
// contains filtered or unexported fields
}
func (*Platform) Descriptor
deprecated
func (*Platform) ProtoMessage ¶
func (*Platform) ProtoMessage()
func (*Platform) ProtoReflect ¶
func (x *Platform) ProtoReflect() protoreflect.Message
type PluginCommand ¶ added in v1.6.0
type PluginCommand struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func (*PluginCommand) Descriptor
deprecated
added in
v1.6.0
func (*PluginCommand) Descriptor() ([]byte, []int)
Deprecated: Use PluginCommand.ProtoReflect.Descriptor instead.
func (*PluginCommand) GetDescription ¶ added in v1.6.0
func (x *PluginCommand) GetDescription() string
func (*PluginCommand) GetName ¶ added in v1.6.0
func (x *PluginCommand) GetName() string
func (*PluginCommand) ProtoMessage ¶ added in v1.6.0
func (*PluginCommand) ProtoMessage()
func (*PluginCommand) ProtoReflect ¶ added in v1.6.0
func (x *PluginCommand) ProtoReflect() protoreflect.Message
func (*PluginCommand) Reset ¶ added in v1.6.0
func (x *PluginCommand) Reset()
func (*PluginCommand) String ¶ added in v1.6.0
func (x *PluginCommand) String() string
type SchemaProperty ¶
type SchemaProperty struct {
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
Required bool `protobuf:"varint,3,opt,name=required,proto3" json:"required,omitempty"`
Default string `protobuf:"bytes,4,opt,name=default,proto3" json:"default,omitempty"`
// contains filtered or unexported fields
}
func (*SchemaProperty) Descriptor
deprecated
func (*SchemaProperty) Descriptor() ([]byte, []int)
Deprecated: Use SchemaProperty.ProtoReflect.Descriptor instead.
func (*SchemaProperty) GetDefault ¶
func (x *SchemaProperty) GetDefault() string
func (*SchemaProperty) GetDescription ¶
func (x *SchemaProperty) GetDescription() string
func (*SchemaProperty) GetRequired ¶
func (x *SchemaProperty) GetRequired() bool
func (*SchemaProperty) GetType ¶
func (x *SchemaProperty) GetType() string
func (*SchemaProperty) ProtoMessage ¶
func (*SchemaProperty) ProtoMessage()
func (*SchemaProperty) ProtoReflect ¶
func (x *SchemaProperty) ProtoReflect() protoreflect.Message
func (*SchemaProperty) Reset ¶
func (x *SchemaProperty) Reset()
func (*SchemaProperty) String ¶
func (x *SchemaProperty) String() string
type UnimplementedDSPluginServer ¶
type UnimplementedDSPluginServer struct{}
UnimplementedDSPluginServer 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 (UnimplementedDSPluginServer) Execute ¶
func (UnimplementedDSPluginServer) Execute(context.Context, *ExecuteRequest) (*ExecuteResponse, error)
func (UnimplementedDSPluginServer) GetManifest ¶ added in v1.6.0
func (UnimplementedDSPluginServer) GetManifest(context.Context, *GetManifestRequest) (*GetManifestResponse, error)
func (UnimplementedDSPluginServer) GetSchema ¶
func (UnimplementedDSPluginServer) GetSchema(context.Context, *GetSchemaRequest) (*GetSchemaResponse, error)
func (UnimplementedDSPluginServer) ValidateConfig ¶
func (UnimplementedDSPluginServer) ValidateConfig(context.Context, *ValidateConfigRequest) (*ValidateConfigResponse, error)
type UnimplementedHostConfigServer ¶ added in v1.3.0
type UnimplementedHostConfigServer struct{}
UnimplementedHostConfigServer 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 (UnimplementedHostConfigServer) GetEffectiveConfig ¶ added in v1.3.0
func (UnimplementedHostConfigServer) GetEffectiveConfig(context.Context, *GetEffectiveConfigRequest) (*GetEffectiveConfigResponse, error)
type UnsafeDSPluginServer ¶
type UnsafeDSPluginServer interface {
// contains filtered or unexported methods
}
UnsafeDSPluginServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DSPluginServer will result in compilation errors.
type UnsafeHostConfigServer ¶ added in v1.3.0
type UnsafeHostConfigServer interface {
// contains filtered or unexported methods
}
UnsafeHostConfigServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to HostConfigServer will result in compilation errors.
type ValidateConfigRequest ¶
type ValidateConfigRequest struct {
Config map[string]string `` /* 139-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*ValidateConfigRequest) Descriptor
deprecated
func (*ValidateConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use ValidateConfigRequest.ProtoReflect.Descriptor instead.
func (*ValidateConfigRequest) GetConfig ¶
func (x *ValidateConfigRequest) GetConfig() map[string]string
func (*ValidateConfigRequest) ProtoMessage ¶
func (*ValidateConfigRequest) ProtoMessage()
func (*ValidateConfigRequest) ProtoReflect ¶
func (x *ValidateConfigRequest) ProtoReflect() protoreflect.Message
func (*ValidateConfigRequest) Reset ¶
func (x *ValidateConfigRequest) Reset()
func (*ValidateConfigRequest) String ¶
func (x *ValidateConfigRequest) String() string
type ValidateConfigResponse ¶
type ValidateConfigResponse struct {
Valid bool `protobuf:"varint,1,opt,name=valid,proto3" json:"valid,omitempty"`
Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
// contains filtered or unexported fields
}
func (*ValidateConfigResponse) Descriptor
deprecated
func (*ValidateConfigResponse) Descriptor() ([]byte, []int)
Deprecated: Use ValidateConfigResponse.ProtoReflect.Descriptor instead.
func (*ValidateConfigResponse) GetError ¶
func (x *ValidateConfigResponse) GetError() string
func (*ValidateConfigResponse) GetValid ¶
func (x *ValidateConfigResponse) GetValid() bool
func (*ValidateConfigResponse) ProtoMessage ¶
func (*ValidateConfigResponse) ProtoMessage()
func (*ValidateConfigResponse) ProtoReflect ¶
func (x *ValidateConfigResponse) ProtoReflect() protoreflect.Message
func (*ValidateConfigResponse) Reset ¶
func (x *ValidateConfigResponse) Reset()
func (*ValidateConfigResponse) String ¶
func (x *ValidateConfigResponse) String() string