Documentation
¶
Index ¶
- Variables
- func RegisterExecutorPluginServer(s grpc.ServiceRegistrar, srv ExecutorPluginServer)
- type ExecuteRequest
- func (*ExecuteRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ExecuteRequest) GetExecCtx() *ExecutionContext
- func (x *ExecuteRequest) GetExecutorId() 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) GetLog() *LogLine
- func (m *ExecuteResponse) GetPayload() isExecuteResponse_Payload
- func (x *ExecuteResponse) GetResult() *Result
- func (*ExecuteResponse) ProtoMessage()
- func (x *ExecuteResponse) ProtoReflect() protoreflect.Message
- func (x *ExecuteResponse) Reset()
- func (x *ExecuteResponse) String() string
- type ExecuteResponse_Log
- type ExecuteResponse_Result
- type ExecutionContext
- func (*ExecutionContext) Descriptor() ([]byte, []int)deprecated
- func (x *ExecutionContext) GetApiBaseUrl() string
- func (x *ExecutionContext) GetApiKey() string
- func (x *ExecutionContext) GetInputs() map[string]string
- func (x *ExecutionContext) GetNamespaceName() string
- func (x *ExecutionContext) GetNodes() []*Node
- func (x *ExecutionContext) GetUserUuid() string
- func (x *ExecutionContext) GetWithConfig() []byte
- func (*ExecutionContext) ProtoMessage()
- func (x *ExecutionContext) ProtoReflect() protoreflect.Message
- func (x *ExecutionContext) Reset()
- func (x *ExecutionContext) String() string
- type ExecutorPluginClient
- type ExecutorPluginServer
- type ExecutorPlugin_ExecuteClient
- type ExecutorPlugin_ExecuteServer
- type GetCapabilitiesResponse
- func (*GetCapabilitiesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetCapabilitiesResponse) GetCapabilities() uint64
- func (*GetCapabilitiesResponse) ProtoMessage()
- func (x *GetCapabilitiesResponse) ProtoReflect() protoreflect.Message
- func (x *GetCapabilitiesResponse) Reset()
- func (x *GetCapabilitiesResponse) String() string
- type GetNameResponse
- type GetSchemaResponse
- func (*GetSchemaResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetSchemaResponse) GetSchemaJson() []byte
- func (*GetSchemaResponse) ProtoMessage()
- func (x *GetSchemaResponse) ProtoReflect() protoreflect.Message
- func (x *GetSchemaResponse) Reset()
- func (x *GetSchemaResponse) String() string
- type LogLine
- type LogLine_Stream
- func (LogLine_Stream) Descriptor() protoreflect.EnumDescriptor
- func (x LogLine_Stream) Enum() *LogLine_Stream
- func (LogLine_Stream) EnumDescriptor() ([]byte, []int)deprecated
- func (x LogLine_Stream) Number() protoreflect.EnumNumber
- func (x LogLine_Stream) String() string
- func (LogLine_Stream) Type() protoreflect.EnumType
- type NewRequest
- func (*NewRequest) Descriptor() ([]byte, []int)deprecated
- func (x *NewRequest) GetExecId() string
- func (x *NewRequest) GetName() string
- func (x *NewRequest) GetNode() *Node
- func (*NewRequest) ProtoMessage()
- func (x *NewRequest) ProtoReflect() protoreflect.Message
- func (x *NewRequest) Reset()
- func (x *NewRequest) String() string
- type NewResponse
- func (*NewResponse) Descriptor() ([]byte, []int)deprecated
- func (x *NewResponse) GetArtifactsDir() string
- func (x *NewResponse) GetError() string
- func (x *NewResponse) GetExecutorId() string
- func (*NewResponse) ProtoMessage()
- func (x *NewResponse) ProtoReflect() protoreflect.Message
- func (x *NewResponse) Reset()
- func (x *NewResponse) String() string
- type Node
- func (*Node) Descriptor() ([]byte, []int)deprecated
- func (x *Node) GetAuthKey() string
- func (x *Node) GetAuthMethod() string
- func (x *Node) GetConnectionType() string
- func (x *Node) GetHostname() string
- func (x *Node) GetOsFamily() string
- func (x *Node) GetPort() int32
- func (x *Node) GetUsername() string
- func (*Node) ProtoMessage()
- func (x *Node) ProtoReflect() protoreflect.Message
- func (x *Node) Reset()
- func (x *Node) String() string
- type Result
- type UnimplementedExecutorPluginServer
- func (UnimplementedExecutorPluginServer) Execute(*ExecuteRequest, ExecutorPlugin_ExecuteServer) error
- func (UnimplementedExecutorPluginServer) GetCapabilities(context.Context, *emptypb.Empty) (*GetCapabilitiesResponse, error)
- func (UnimplementedExecutorPluginServer) GetName(context.Context, *emptypb.Empty) (*GetNameResponse, error)
- func (UnimplementedExecutorPluginServer) GetSchema(context.Context, *emptypb.Empty) (*GetSchemaResponse, error)
- func (UnimplementedExecutorPluginServer) New(context.Context, *NewRequest) (*NewResponse, error)
- type UnsafeExecutorPluginServer
Constants ¶
This section is empty.
Variables ¶
var ( LogLine_Stream_name = map[int32]string{ 0: "STDOUT", 1: "STDERR", } LogLine_Stream_value = map[string]int32{ "STDOUT": 0, "STDERR": 1, } )
Enum value maps for LogLine_Stream.
var ExecutorPlugin_ServiceDesc = grpc.ServiceDesc{ ServiceName: "proto.ExecutorPlugin", HandlerType: (*ExecutorPluginServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetName", Handler: _ExecutorPlugin_GetName_Handler, }, { MethodName: "GetSchema", Handler: _ExecutorPlugin_GetSchema_Handler, }, { MethodName: "GetCapabilities", Handler: _ExecutorPlugin_GetCapabilities_Handler, }, { MethodName: "New", Handler: _ExecutorPlugin_New_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "Execute", Handler: _ExecutorPlugin_Execute_Handler, ServerStreams: true, }, }, Metadata: "sdk/plugin/proto/executor.proto", }
ExecutorPlugin_ServiceDesc is the grpc.ServiceDesc for ExecutorPlugin service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_sdk_plugin_proto_executor_proto protoreflect.FileDescriptor
Functions ¶
func RegisterExecutorPluginServer ¶
func RegisterExecutorPluginServer(s grpc.ServiceRegistrar, srv ExecutorPluginServer)
Types ¶
type ExecuteRequest ¶
type ExecuteRequest struct {
ExecutorId string `protobuf:"bytes,1,opt,name=executor_id,json=executorId,proto3" json:"executor_id,omitempty"`
ExecCtx *ExecutionContext `protobuf:"bytes,2,opt,name=exec_ctx,json=execCtx,proto3" json:"exec_ctx,omitempty"`
// contains filtered or unexported fields
}
func (*ExecuteRequest) Descriptor
deprecated
func (*ExecuteRequest) Descriptor() ([]byte, []int)
Deprecated: Use ExecuteRequest.ProtoReflect.Descriptor instead.
func (*ExecuteRequest) GetExecCtx ¶
func (x *ExecuteRequest) GetExecCtx() *ExecutionContext
func (*ExecuteRequest) GetExecutorId ¶
func (x *ExecuteRequest) GetExecutorId() 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 {
// Types that are assignable to Payload:
// *ExecuteResponse_Log
// *ExecuteResponse_Result
Payload isExecuteResponse_Payload `protobuf_oneof:"payload"`
// contains filtered or unexported fields
}
func (*ExecuteResponse) Descriptor
deprecated
func (*ExecuteResponse) Descriptor() ([]byte, []int)
Deprecated: Use ExecuteResponse.ProtoReflect.Descriptor instead.
func (*ExecuteResponse) GetLog ¶
func (x *ExecuteResponse) GetLog() *LogLine
func (*ExecuteResponse) GetPayload ¶
func (m *ExecuteResponse) GetPayload() isExecuteResponse_Payload
func (*ExecuteResponse) GetResult ¶
func (x *ExecuteResponse) GetResult() *Result
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 ExecuteResponse_Log ¶
type ExecuteResponse_Log struct {
Log *LogLine `protobuf:"bytes,1,opt,name=log,proto3,oneof"`
}
type ExecuteResponse_Result ¶
type ExecuteResponse_Result struct {
Result *Result `protobuf:"bytes,2,opt,name=result,proto3,oneof"`
}
type ExecutionContext ¶
type ExecutionContext struct {
WithConfig []byte `protobuf:"bytes,1,opt,name=with_config,json=withConfig,proto3" json:"with_config,omitempty"`
Inputs map[string]string `` /* 153-byte string literal not displayed */
UserUuid string `protobuf:"bytes,3,opt,name=user_uuid,json=userUuid,proto3" json:"user_uuid,omitempty"`
NamespaceName string `protobuf:"bytes,4,opt,name=namespace_name,json=namespaceName,proto3" json:"namespace_name,omitempty"`
ApiKey string `protobuf:"bytes,5,opt,name=api_key,json=apiKey,proto3" json:"api_key,omitempty"`
ApiBaseUrl string `protobuf:"bytes,6,opt,name=api_base_url,json=apiBaseUrl,proto3" json:"api_base_url,omitempty"`
Nodes []*Node `protobuf:"bytes,7,rep,name=nodes,proto3" json:"nodes,omitempty"`
// contains filtered or unexported fields
}
func (*ExecutionContext) Descriptor
deprecated
func (*ExecutionContext) Descriptor() ([]byte, []int)
Deprecated: Use ExecutionContext.ProtoReflect.Descriptor instead.
func (*ExecutionContext) GetApiBaseUrl ¶
func (x *ExecutionContext) GetApiBaseUrl() string
func (*ExecutionContext) GetApiKey ¶
func (x *ExecutionContext) GetApiKey() string
func (*ExecutionContext) GetInputs ¶
func (x *ExecutionContext) GetInputs() map[string]string
func (*ExecutionContext) GetNamespaceName ¶
func (x *ExecutionContext) GetNamespaceName() string
func (*ExecutionContext) GetNodes ¶
func (x *ExecutionContext) GetNodes() []*Node
func (*ExecutionContext) GetUserUuid ¶
func (x *ExecutionContext) GetUserUuid() string
func (*ExecutionContext) GetWithConfig ¶
func (x *ExecutionContext) GetWithConfig() []byte
func (*ExecutionContext) ProtoMessage ¶
func (*ExecutionContext) ProtoMessage()
func (*ExecutionContext) ProtoReflect ¶
func (x *ExecutionContext) ProtoReflect() protoreflect.Message
func (*ExecutionContext) Reset ¶
func (x *ExecutionContext) Reset()
func (*ExecutionContext) String ¶
func (x *ExecutionContext) String() string
type ExecutorPluginClient ¶
type ExecutorPluginClient interface {
GetName(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*GetNameResponse, error)
GetSchema(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*GetSchemaResponse, error)
GetCapabilities(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*GetCapabilitiesResponse, error)
New(ctx context.Context, in *NewRequest, opts ...grpc.CallOption) (*NewResponse, error)
Execute(ctx context.Context, in *ExecuteRequest, opts ...grpc.CallOption) (ExecutorPlugin_ExecuteClient, error)
}
ExecutorPluginClient is the client API for ExecutorPlugin 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.
func NewExecutorPluginClient ¶
func NewExecutorPluginClient(cc grpc.ClientConnInterface) ExecutorPluginClient
type ExecutorPluginServer ¶
type ExecutorPluginServer interface {
GetName(context.Context, *emptypb.Empty) (*GetNameResponse, error)
GetSchema(context.Context, *emptypb.Empty) (*GetSchemaResponse, error)
GetCapabilities(context.Context, *emptypb.Empty) (*GetCapabilitiesResponse, error)
New(context.Context, *NewRequest) (*NewResponse, error)
Execute(*ExecuteRequest, ExecutorPlugin_ExecuteServer) error
// contains filtered or unexported methods
}
ExecutorPluginServer is the server API for ExecutorPlugin service. All implementations must embed UnimplementedExecutorPluginServer for forward compatibility
type ExecutorPlugin_ExecuteClient ¶
type ExecutorPlugin_ExecuteClient interface {
Recv() (*ExecuteResponse, error)
grpc.ClientStream
}
type ExecutorPlugin_ExecuteServer ¶
type ExecutorPlugin_ExecuteServer interface {
Send(*ExecuteResponse) error
grpc.ServerStream
}
type GetCapabilitiesResponse ¶
type GetCapabilitiesResponse struct {
Capabilities uint64 `protobuf:"varint,1,opt,name=capabilities,proto3" json:"capabilities,omitempty"`
// contains filtered or unexported fields
}
func (*GetCapabilitiesResponse) Descriptor
deprecated
func (*GetCapabilitiesResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetCapabilitiesResponse.ProtoReflect.Descriptor instead.
func (*GetCapabilitiesResponse) GetCapabilities ¶
func (x *GetCapabilitiesResponse) GetCapabilities() uint64
func (*GetCapabilitiesResponse) ProtoMessage ¶
func (*GetCapabilitiesResponse) ProtoMessage()
func (*GetCapabilitiesResponse) ProtoReflect ¶
func (x *GetCapabilitiesResponse) ProtoReflect() protoreflect.Message
func (*GetCapabilitiesResponse) Reset ¶
func (x *GetCapabilitiesResponse) Reset()
func (*GetCapabilitiesResponse) String ¶
func (x *GetCapabilitiesResponse) String() string
type GetNameResponse ¶
type GetNameResponse struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetNameResponse) Descriptor
deprecated
func (*GetNameResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetNameResponse.ProtoReflect.Descriptor instead.
func (*GetNameResponse) GetName ¶
func (x *GetNameResponse) GetName() string
func (*GetNameResponse) ProtoMessage ¶
func (*GetNameResponse) ProtoMessage()
func (*GetNameResponse) ProtoReflect ¶
func (x *GetNameResponse) ProtoReflect() protoreflect.Message
func (*GetNameResponse) Reset ¶
func (x *GetNameResponse) Reset()
func (*GetNameResponse) String ¶
func (x *GetNameResponse) String() string
type GetSchemaResponse ¶
type GetSchemaResponse struct {
SchemaJson []byte `protobuf:"bytes,1,opt,name=schema_json,json=schemaJson,proto3" json:"schema_json,omitempty"`
// contains filtered or unexported fields
}
func (*GetSchemaResponse) Descriptor
deprecated
func (*GetSchemaResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetSchemaResponse.ProtoReflect.Descriptor instead.
func (*GetSchemaResponse) GetSchemaJson ¶
func (x *GetSchemaResponse) GetSchemaJson() []byte
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 LogLine ¶
type LogLine struct {
Stream LogLine_Stream `protobuf:"varint,1,opt,name=stream,proto3,enum=proto.LogLine_Stream" json:"stream,omitempty"`
Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
func (*LogLine) Descriptor
deprecated
func (*LogLine) GetStream ¶
func (x *LogLine) GetStream() LogLine_Stream
func (*LogLine) ProtoMessage ¶
func (*LogLine) ProtoMessage()
func (*LogLine) ProtoReflect ¶
func (x *LogLine) ProtoReflect() protoreflect.Message
type LogLine_Stream ¶
type LogLine_Stream int32
const ( LogLine_STDOUT LogLine_Stream = 0 LogLine_STDERR LogLine_Stream = 1 )
func (LogLine_Stream) Descriptor ¶
func (LogLine_Stream) Descriptor() protoreflect.EnumDescriptor
func (LogLine_Stream) Enum ¶
func (x LogLine_Stream) Enum() *LogLine_Stream
func (LogLine_Stream) EnumDescriptor
deprecated
func (LogLine_Stream) EnumDescriptor() ([]byte, []int)
Deprecated: Use LogLine_Stream.Descriptor instead.
func (LogLine_Stream) Number ¶
func (x LogLine_Stream) Number() protoreflect.EnumNumber
func (LogLine_Stream) String ¶
func (x LogLine_Stream) String() string
func (LogLine_Stream) Type ¶
func (LogLine_Stream) Type() protoreflect.EnumType
type NewRequest ¶
type NewRequest struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Node *Node `protobuf:"bytes,2,opt,name=node,proto3" json:"node,omitempty"`
ExecId string `protobuf:"bytes,3,opt,name=exec_id,json=execId,proto3" json:"exec_id,omitempty"`
// contains filtered or unexported fields
}
func (*NewRequest) Descriptor
deprecated
func (*NewRequest) Descriptor() ([]byte, []int)
Deprecated: Use NewRequest.ProtoReflect.Descriptor instead.
func (*NewRequest) GetExecId ¶
func (x *NewRequest) GetExecId() string
func (*NewRequest) GetName ¶
func (x *NewRequest) GetName() string
func (*NewRequest) GetNode ¶
func (x *NewRequest) GetNode() *Node
func (*NewRequest) ProtoMessage ¶
func (*NewRequest) ProtoMessage()
func (*NewRequest) ProtoReflect ¶
func (x *NewRequest) ProtoReflect() protoreflect.Message
func (*NewRequest) Reset ¶
func (x *NewRequest) Reset()
func (*NewRequest) String ¶
func (x *NewRequest) String() string
type NewResponse ¶
type NewResponse struct {
ExecutorId string `protobuf:"bytes,1,opt,name=executor_id,json=executorId,proto3" json:"executor_id,omitempty"`
ArtifactsDir string `protobuf:"bytes,2,opt,name=artifacts_dir,json=artifactsDir,proto3" json:"artifacts_dir,omitempty"`
Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
// contains filtered or unexported fields
}
func (*NewResponse) Descriptor
deprecated
func (*NewResponse) Descriptor() ([]byte, []int)
Deprecated: Use NewResponse.ProtoReflect.Descriptor instead.
func (*NewResponse) GetArtifactsDir ¶
func (x *NewResponse) GetArtifactsDir() string
func (*NewResponse) GetError ¶
func (x *NewResponse) GetError() string
func (*NewResponse) GetExecutorId ¶
func (x *NewResponse) GetExecutorId() string
func (*NewResponse) ProtoMessage ¶
func (*NewResponse) ProtoMessage()
func (*NewResponse) ProtoReflect ¶
func (x *NewResponse) ProtoReflect() protoreflect.Message
func (*NewResponse) Reset ¶
func (x *NewResponse) Reset()
func (*NewResponse) String ¶
func (x *NewResponse) String() string
type Node ¶
type Node struct {
Hostname string `protobuf:"bytes,1,opt,name=hostname,proto3" json:"hostname,omitempty"`
Port int32 `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"`
Username string `protobuf:"bytes,3,opt,name=username,proto3" json:"username,omitempty"`
AuthMethod string `protobuf:"bytes,4,opt,name=auth_method,json=authMethod,proto3" json:"auth_method,omitempty"`
AuthKey string `protobuf:"bytes,5,opt,name=auth_key,json=authKey,proto3" json:"auth_key,omitempty"`
ConnectionType string `protobuf:"bytes,6,opt,name=connection_type,json=connectionType,proto3" json:"connection_type,omitempty"`
OsFamily string `protobuf:"bytes,7,opt,name=os_family,json=osFamily,proto3" json:"os_family,omitempty"`
// contains filtered or unexported fields
}
func (*Node) Descriptor
deprecated
func (*Node) GetAuthKey ¶
func (*Node) GetAuthMethod ¶
func (*Node) GetConnectionType ¶
func (*Node) GetHostname ¶
func (*Node) GetOsFamily ¶
func (*Node) GetUsername ¶
func (*Node) ProtoMessage ¶
func (*Node) ProtoMessage()
func (*Node) ProtoReflect ¶
func (x *Node) ProtoReflect() protoreflect.Message
type Result ¶
type Result struct {
Outputs map[string]string `` /* 155-byte string literal not displayed */
Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
// contains filtered or unexported fields
}
func (*Result) Descriptor
deprecated
func (*Result) GetOutputs ¶
func (*Result) ProtoMessage ¶
func (*Result) ProtoMessage()
func (*Result) ProtoReflect ¶
func (x *Result) ProtoReflect() protoreflect.Message
type UnimplementedExecutorPluginServer ¶
type UnimplementedExecutorPluginServer struct {
}
UnimplementedExecutorPluginServer must be embedded to have forward compatible implementations.
func (UnimplementedExecutorPluginServer) Execute ¶
func (UnimplementedExecutorPluginServer) Execute(*ExecuteRequest, ExecutorPlugin_ExecuteServer) error
func (UnimplementedExecutorPluginServer) GetCapabilities ¶
func (UnimplementedExecutorPluginServer) GetCapabilities(context.Context, *emptypb.Empty) (*GetCapabilitiesResponse, error)
func (UnimplementedExecutorPluginServer) GetName ¶
func (UnimplementedExecutorPluginServer) GetName(context.Context, *emptypb.Empty) (*GetNameResponse, error)
func (UnimplementedExecutorPluginServer) GetSchema ¶
func (UnimplementedExecutorPluginServer) GetSchema(context.Context, *emptypb.Empty) (*GetSchemaResponse, error)
func (UnimplementedExecutorPluginServer) New ¶
func (UnimplementedExecutorPluginServer) New(context.Context, *NewRequest) (*NewResponse, error)
type UnsafeExecutorPluginServer ¶
type UnsafeExecutorPluginServer interface {
// contains filtered or unexported methods
}
UnsafeExecutorPluginServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ExecutorPluginServer will result in compilation errors.