api

package
v0.1.1 Latest Latest
Warning

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

 Go to latest Published: Aug 15, 2023 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

Package api defines the gRPC interface plugins use over the wire. Non-golang plugins can implement the TaskExecutor service to work with zedpm.

Index

Constants

This section is empty.

Variables

View Source 
var File_task_interface_proto protoreflect.FileDescriptor
View Source 
var TaskExecution_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "zedpm.plugin.TaskExecution",
	HandlerType: (*TaskExecutionServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Implements",
			Handler:    _TaskExecution_Implements_Handler,
		},
		{
			MethodName: "Goal",
			Handler:    _TaskExecution_Goal_Handler,
		},
		{
			MethodName: "Prepare",
			Handler:    _TaskExecution_Prepare_Handler,
		},
		{
			MethodName: "Cancel",
			Handler:    _TaskExecution_Cancel_Handler,
		},
		{
			MethodName: "Complete",
			Handler:    _TaskExecution_Complete_Handler,
		},
		{
			MethodName: "ExecuteCheck",
			Handler:    _TaskExecution_ExecuteCheck_Handler,
		},
		{
			MethodName: "PrepareBegin",
			Handler:    _TaskExecution_PrepareBegin_Handler,
		},
		{
			MethodName: "ExecuteBegin",
			Handler:    _TaskExecution_ExecuteBegin_Handler,
		},
		{
			MethodName: "PrepareRun",
			Handler:    _TaskExecution_PrepareRun_Handler,
		},
		{
			MethodName: "ExecuteRun",
			Handler:    _TaskExecution_ExecuteRun_Handler,
		},
		{
			MethodName: "PrepareEnd",
			Handler:    _TaskExecution_PrepareEnd_Handler,
		},
		{
			MethodName: "ExecuteEnd",
			Handler:    _TaskExecution_ExecuteEnd_Handler,
		},
		{
			MethodName: "ExecuteFinish",
			Handler:    _TaskExecution_ExecuteFinish_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "task-interface.proto",
}

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

Functions

func RegisterTaskExecutionServer 

func RegisterTaskExecutionServer(s grpc.ServiceRegistrar, srv TaskExecutionServer)

Types

type Config 

type Config struct {

	// The values are string property values. Each key is a dot-separated string
	// of keys and sub-keys. The values are the best serialized value for the
	// value to set.
	Values map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Config is used to pass properties from the master process to each plugin and also for each plugin to pass changes back upstream to the master.

func (*Config) Descriptor deprecated 

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

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) GetValues 

func (x *Config) GetValues() map[string]string

func (*Config) ProtoMessage 

func (*Config) ProtoMessage()

func (*Config) ProtoReflect 

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

func (*Config) Reset 

func (x *Config) Reset()

func (*Config) String 

func (x *Config) String() string

type Descriptor 

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

Descriptor provides definitions defining the goals and tasks supported by a plugin.

func (*Descriptor) Descriptor deprecated 

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

Deprecated: Use Descriptor.ProtoReflect.Descriptor instead.

func (*Descriptor) ProtoMessage 

func (*Descriptor) ProtoMessage()

func (*Descriptor) ProtoReflect 

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

func (*Descriptor) Reset 

func (x *Descriptor) Reset()

func (*Descriptor) String 

func (x *Descriptor) String() string

type Descriptor_Goal 

type Descriptor_Goal struct {

	// This is the name of the goal.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// This is a short description of what the goal is meant to archive.
	Short string `protobuf:"bytes,2,opt,name=short,proto3" json:"short,omitempty"`
	// This is a list of zero or more aliases that can be used to perform this
	// same goal.
	Aliases []string `protobuf:"bytes,3,rep,name=aliases,proto3" json:"aliases,omitempty"`
	// contains filtered or unexported fields
}

Descriptor.Goal describes a goal.

func (*Descriptor_Goal) Descriptor deprecated 

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

Deprecated: Use Descriptor_Goal.ProtoReflect.Descriptor instead.

func (*Descriptor_Goal) GetAliases 

func (x *Descriptor_Goal) GetAliases() []string

func (*Descriptor_Goal) GetName 

func (x *Descriptor_Goal) GetName() string

func (*Descriptor_Goal) GetShort 

func (x *Descriptor_Goal) GetShort() string

func (*Descriptor_Goal) ProtoMessage 

func (*Descriptor_Goal) ProtoMessage()

func (*Descriptor_Goal) ProtoReflect 

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

func (*Descriptor_Goal) Reset 

func (x *Descriptor_Goal) Reset()

func (*Descriptor_Goal) String 

func (x *Descriptor_Goal) String() string

type Descriptor_Task 

type Descriptor_Task struct {

	// This is the full path describing the name of the task. The first element
	// of the path should be the name of the goal this task belongs to and the
	// path must start with a slash.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// This is the short description of what the task does. This should be a
	// very short phrase.
	Short string `protobuf:"bytes,3,opt,name=short,proto3" json:"short,omitempty"`
	// This is a list of zero or more task paths of tasks that must be performed
	// prior to executing this task. These other tasks must be in the same goal.
	Requires []string `protobuf:"bytes,4,rep,name=requires,proto3" json:"requires,omitempty"`
	// contains filtered or unexported fields
}

Descriptor.Task describes a task, which is part of a goal.

func (*Descriptor_Task) Descriptor deprecated 

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

Deprecated: Use Descriptor_Task.ProtoReflect.Descriptor instead.

func (*Descriptor_Task) GetName 

func (x *Descriptor_Task) GetName() string

func (*Descriptor_Task) GetRequires 

func (x *Descriptor_Task) GetRequires() []string

func (*Descriptor_Task) GetShort 

func (x *Descriptor_Task) GetShort() string

func (*Descriptor_Task) ProtoMessage 

func (*Descriptor_Task) ProtoMessage()

func (*Descriptor_Task) ProtoReflect 

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

func (*Descriptor_Task) Reset 

func (x *Descriptor_Task) Reset()

func (*Descriptor_Task) String 

func (x *Descriptor_Task) String() string

type Task 

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

Task is just a namespace container for task-related messages.

func (*Task) Descriptor deprecated 

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

Deprecated: Use Task.ProtoReflect.Descriptor instead.

func (*Task) ProtoMessage 

func (*Task) ProtoMessage()

func (*Task) ProtoReflect 

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

func (*Task) Reset 

func (x *Task) Reset()

func (*Task) String 

func (x *Task) String() string

type TaskExecutionClient 

type TaskExecutionClient interface {
	// Implements maps onto the plugin.Interface.Implements method.
	Implements(ctx context.Context, in *Task_Implements_Request, opts ...grpc.CallOption) (*Task_Implements_Response, error)
	// Goal maps onto the plugin.Interface.Goal method.
	Goal(ctx context.Context, in *Task_Goal_Request, opts ...grpc.CallOption) (*Task_Goal_Response, error)
	// Prepare maps onto the plugin.Interface.Prepare method.
	Prepare(ctx context.Context, in *Task_Prepare_Request, opts ...grpc.CallOption) (*Task_Prepare_Response, error)
	// Cancel maps onto the plugin.Interface.Cancel method.
	Cancel(ctx context.Context, in *Task_Cancel_Request, opts ...grpc.CallOption) (*Task_Cancel_Response, error)
	// Complete maps onto the plugin.Interface.Complete method.
	Complete(ctx context.Context, in *Task_Complete_Request, opts ...grpc.CallOption) (*Task_Complete_Response, error)
	// ExecuteCheck maps onto the plugin.Task.Check method.
	ExecuteCheck(ctx context.Context, in *Task_Operation_Request, opts ...grpc.CallOption) (*Task_Operation_Response, error)
	// PrepareBegin maps onto the plugin.Task.Begin method.
	PrepareBegin(ctx context.Context, in *Task_Ref, opts ...grpc.CallOption) (*Task_SubStage_Response, error)
	// ExecuteBegin executes operations related to the plugin.Task.Begin method.
	ExecuteBegin(ctx context.Context, in *Task_SubStage_Request, opts ...grpc.CallOption) (*Task_Operation_Response, error)
	// PrepareRun maps onto the plugin.Task.Run method.
	PrepareRun(ctx context.Context, in *Task_Ref, opts ...grpc.CallOption) (*Task_SubStage_Response, error)
	// ExecuteRun executes operations related to the plugin.Task.Run method.
	ExecuteRun(ctx context.Context, in *Task_SubStage_Request, opts ...grpc.CallOption) (*Task_Operation_Response, error)
	// PrepareEnd maps onto the plugin.Task.End method.
	PrepareEnd(ctx context.Context, in *Task_Ref, opts ...grpc.CallOption) (*Task_SubStage_Response, error)
	// ExecuteEnd executes operations related to the plugin.Task.End method.
	ExecuteEnd(ctx context.Context, in *Task_SubStage_Request, opts ...grpc.CallOption) (*Task_Operation_Response, error)
	// ExecuteFinish maps onto the plugin.Task.Finish method.
	ExecuteFinish(ctx context.Context, in *Task_Operation_Request, opts ...grpc.CallOption) (*Task_Operation_Response, error)
}

TaskExecutionClient is the client API for TaskExecution 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 NewTaskExecutionClient 

func NewTaskExecutionClient(cc grpc.ClientConnInterface) TaskExecutionClient

type TaskExecutionServer 

type TaskExecutionServer interface {
	// Implements maps onto the plugin.Interface.Implements method.
	Implements(context.Context, *Task_Implements_Request) (*Task_Implements_Response, error)
	// Goal maps onto the plugin.Interface.Goal method.
	Goal(context.Context, *Task_Goal_Request) (*Task_Goal_Response, error)
	// Prepare maps onto the plugin.Interface.Prepare method.
	Prepare(context.Context, *Task_Prepare_Request) (*Task_Prepare_Response, error)
	// Cancel maps onto the plugin.Interface.Cancel method.
	Cancel(context.Context, *Task_Cancel_Request) (*Task_Cancel_Response, error)
	// Complete maps onto the plugin.Interface.Complete method.
	Complete(context.Context, *Task_Complete_Request) (*Task_Complete_Response, error)
	// ExecuteCheck maps onto the plugin.Task.Check method.
	ExecuteCheck(context.Context, *Task_Operation_Request) (*Task_Operation_Response, error)
	// PrepareBegin maps onto the plugin.Task.Begin method.
	PrepareBegin(context.Context, *Task_Ref) (*Task_SubStage_Response, error)
	// ExecuteBegin executes operations related to the plugin.Task.Begin method.
	ExecuteBegin(context.Context, *Task_SubStage_Request) (*Task_Operation_Response, error)
	// PrepareRun maps onto the plugin.Task.Run method.
	PrepareRun(context.Context, *Task_Ref) (*Task_SubStage_Response, error)
	// ExecuteRun executes operations related to the plugin.Task.Run method.
	ExecuteRun(context.Context, *Task_SubStage_Request) (*Task_Operation_Response, error)
	// PrepareEnd maps onto the plugin.Task.End method.
	PrepareEnd(context.Context, *Task_Ref) (*Task_SubStage_Response, error)
	// ExecuteEnd executes operations related to the plugin.Task.End method.
	ExecuteEnd(context.Context, *Task_SubStage_Request) (*Task_Operation_Response, error)
	// ExecuteFinish maps onto the plugin.Task.Finish method.
	ExecuteFinish(context.Context, *Task_Operation_Request) (*Task_Operation_Response, error)
	// contains filtered or unexported methods
}

TaskExecutionServer is the server API for TaskExecution service. All implementations must embed UnimplementedTaskExecutionServer for forward compatibility

type Task_Cancel 

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

Task.Cancel is the namespace container for messages used with the Cancel() function.

func (*Task_Cancel) Descriptor deprecated 

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

Deprecated: Use Task_Cancel.ProtoReflect.Descriptor instead.

func (*Task_Cancel) ProtoMessage 

func (*Task_Cancel) ProtoMessage()

func (*Task_Cancel) ProtoReflect 

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

func (*Task_Cancel) Reset 

func (x *Task_Cancel) Reset()

func (*Task_Cancel) String 

func (x *Task_Cancel) String() string

type Task_Cancel_Request 

type Task_Cancel_Request struct {

	// This is the task state to cancel.
	Task *Task_Ref `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`
	// This is the latest storage provided to the plugin.
	Storage map[string]string `` /* 155-byte string literal not displayed */
	// This is the list of all files added by tass to this point.
	AddedFiles []string `protobuf:"bytes,3,rep,name=added_files,json=addedFiles,proto3" json:"added_files,omitempty"`
	// contains filtered or unexported fields
}

Task.Cancel.Request is the request object to pass to the Cancel() function.

func (*Task_Cancel_Request) Descriptor deprecated 

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

Deprecated: Use Task_Cancel_Request.ProtoReflect.Descriptor instead.

func (*Task_Cancel_Request) GetAddedFiles added in v0.1.0 

func (x *Task_Cancel_Request) GetAddedFiles() []string

func (*Task_Cancel_Request) GetStorage 

func (x *Task_Cancel_Request) GetStorage() map[string]string

func (*Task_Cancel_Request) GetTask 

func (x *Task_Cancel_Request) GetTask() *Task_Ref

func (*Task_Cancel_Request) ProtoMessage 

func (*Task_Cancel_Request) ProtoMessage()

func (*Task_Cancel_Request) ProtoReflect 

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

func (*Task_Cancel_Request) Reset 

func (x *Task_Cancel_Request) Reset()

func (*Task_Cancel_Request) String 

func (x *Task_Cancel_Request) String() string

type Task_Cancel_Response 

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

Task.Cancel.Response is the response object returned from Cancel().

func (*Task_Cancel_Response) Descriptor deprecated 

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

Deprecated: Use Task_Cancel_Response.ProtoReflect.Descriptor instead.

func (*Task_Cancel_Response) ProtoMessage 

func (*Task_Cancel_Response) ProtoMessage()

func (*Task_Cancel_Response) ProtoReflect 

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

func (*Task_Cancel_Response) Reset 

func (x *Task_Cancel_Response) Reset()

func (*Task_Cancel_Response) String 

func (x *Task_Cancel_Response) String() string

type Task_Complete 

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

Task.Complete is the namespace container for messages used with Complete().

func (*Task_Complete) Descriptor deprecated 

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

Deprecated: Use Task_Complete.ProtoReflect.Descriptor instead.

func (*Task_Complete) ProtoMessage 

func (*Task_Complete) ProtoMessage()

func (*Task_Complete) ProtoReflect 

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

func (*Task_Complete) Reset 

func (x *Task_Complete) Reset()

func (*Task_Complete) String 

func (x *Task_Complete) String() string

type Task_Complete_Request 

type Task_Complete_Request struct {

	// This is the task state to mark completed.
	Task *Task_Ref `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`
	// This is the latest storage provided to the plugin.
	Storage map[string]string `` /* 155-byte string literal not displayed */
	// This is the list of files added by all tasks to this point.
	AddedFiles []string `protobuf:"bytes,3,rep,name=added_files,json=addedFiles,proto3" json:"added_files,omitempty"`
	// contains filtered or unexported fields
}

Task.Complete.Request is the request object to pass to Complete().

func (*Task_Complete_Request) Descriptor deprecated 

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

Deprecated: Use Task_Complete_Request.ProtoReflect.Descriptor instead.

func (*Task_Complete_Request) GetAddedFiles added in v0.1.0 

func (x *Task_Complete_Request) GetAddedFiles() []string

func (*Task_Complete_Request) GetStorage 

func (x *Task_Complete_Request) GetStorage() map[string]string

func (*Task_Complete_Request) GetTask 

func (x *Task_Complete_Request) GetTask() *Task_Ref

func (*Task_Complete_Request) ProtoMessage 

func (*Task_Complete_Request) ProtoMessage()

func (*Task_Complete_Request) ProtoReflect 

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

func (*Task_Complete_Request) Reset 

func (x *Task_Complete_Request) Reset()

func (*Task_Complete_Request) String 

func (x *Task_Complete_Request) String() string

type Task_Complete_Response 

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

Task.Complete.Response is the response object returned from Complete().

func (*Task_Complete_Response) Descriptor deprecated 

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

Deprecated: Use Task_Complete_Response.ProtoReflect.Descriptor instead.

func (*Task_Complete_Response) ProtoMessage 

func (*Task_Complete_Response) ProtoMessage()

func (*Task_Complete_Response) ProtoReflect 

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

func (*Task_Complete_Response) Reset 

func (x *Task_Complete_Response) Reset()

func (*Task_Complete_Response) String 

func (x *Task_Complete_Response) String() string

type Task_Goal 

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

Task.Goal is a namespace container for goal definition mesages.

func (*Task_Goal) Descriptor deprecated 

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

Deprecated: Use Task_Goal.ProtoReflect.Descriptor instead.

func (*Task_Goal) ProtoMessage 

func (*Task_Goal) ProtoMessage()

func (*Task_Goal) ProtoReflect 

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

func (*Task_Goal) Reset 

func (x *Task_Goal) Reset()

func (*Task_Goal) String 

func (x *Task_Goal) String() string

type Task_Goal_Request 

type Task_Goal_Request struct {

	// This is the name of the goal to request information about.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Task.Goal.Request is the request for the Goal() function.

func (*Task_Goal_Request) Descriptor deprecated 

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

Deprecated: Use Task_Goal_Request.ProtoReflect.Descriptor instead.

func (*Task_Goal_Request) GetName 

func (x *Task_Goal_Request) GetName() string

func (*Task_Goal_Request) ProtoMessage 

func (*Task_Goal_Request) ProtoMessage()

func (*Task_Goal_Request) ProtoReflect 

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

func (*Task_Goal_Request) Reset 

func (x *Task_Goal_Request) Reset()

func (*Task_Goal_Request) String 

func (x *Task_Goal_Request) String() string

type Task_Goal_Response 

type Task_Goal_Response struct {

	// This is the definition for the goal.
	Definition *Descriptor_Goal `protobuf:"bytes,1,opt,name=definition,proto3" json:"definition,omitempty"`
	// contains filtered or unexported fields
}

Task.Goal.Response is the response for the Goal() function.

func (*Task_Goal_Response) Descriptor deprecated 

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

Deprecated: Use Task_Goal_Response.ProtoReflect.Descriptor instead.

func (*Task_Goal_Response) GetDefinition 

func (x *Task_Goal_Response) GetDefinition() *Descriptor_Goal

func (*Task_Goal_Response) ProtoMessage 

func (*Task_Goal_Response) ProtoMessage()

func (*Task_Goal_Response) ProtoReflect 

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

func (*Task_Goal_Response) Reset 

func (x *Task_Goal_Response) Reset()

func (*Task_Goal_Response) String 

func (x *Task_Goal_Response) String() string

type Task_Implements 

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

Task.Implements is a namespace container for task implementation messages.

func (*Task_Implements) Descriptor deprecated 

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

Deprecated: Use Task_Implements.ProtoReflect.Descriptor instead.

func (*Task_Implements) ProtoMessage 

func (*Task_Implements) ProtoMessage()

func (*Task_Implements) ProtoReflect 

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

func (*Task_Implements) Reset 

func (x *Task_Implements) Reset()

func (*Task_Implements) String 

func (x *Task_Implements) String() string

type Task_Implements_Request 

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

Task.Implements.Request is the request passed to the Implements() function.

func (*Task_Implements_Request) Descriptor deprecated 

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

Deprecated: Use Task_Implements_Request.ProtoReflect.Descriptor instead.

func (*Task_Implements_Request) ProtoMessage 

func (*Task_Implements_Request) ProtoMessage()

func (*Task_Implements_Request) ProtoReflect 

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

func (*Task_Implements_Request) Reset 

func (x *Task_Implements_Request) Reset()

func (*Task_Implements_Request) String 

func (x *Task_Implements_Request) String() string

type Task_Implements_Response 

type Task_Implements_Response struct {

	// This is the list of task descriptors for all tasks implemented by a
	// plugin.
	Tasks []*Descriptor_Task `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// contains filtered or unexported fields
}

Task.Implements.Response is the response for the Implements() function.

func (*Task_Implements_Response) Descriptor deprecated 

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

Deprecated: Use Task_Implements_Response.ProtoReflect.Descriptor instead.

func (*Task_Implements_Response) GetTasks 

func (x *Task_Implements_Response) GetTasks() []*Descriptor_Task

func (*Task_Implements_Response) ProtoMessage 

func (*Task_Implements_Response) ProtoMessage()

func (*Task_Implements_Response) ProtoReflect 

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

func (*Task_Implements_Response) Reset 

func (x *Task_Implements_Response) Reset()

func (*Task_Implements_Response) String 

func (x *Task_Implements_Response) String() string

type Task_Operation 

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

Task.Operation is the namespace container for various operation calls.

func (*Task_Operation) Descriptor deprecated 

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

Deprecated: Use Task_Operation.ProtoReflect.Descriptor instead.

func (*Task_Operation) ProtoMessage 

func (*Task_Operation) ProtoMessage()

func (*Task_Operation) ProtoReflect 

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

func (*Task_Operation) Reset 

func (x *Task_Operation) Reset()

func (*Task_Operation) String 

func (x *Task_Operation) String() string

type Task_Operation_Request 

type Task_Operation_Request struct {

	// This is the task state in which to perform the operation.
	Task *Task_Ref `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`
	// This is the storage as updated during the previous stage.
	Storage map[string]string `` /* 155-byte string literal not displayed */
	// This is the list of files that have been added to this point.
	AddedFiles []string `protobuf:"bytes,3,rep,name=added_files,json=addedFiles,proto3" json:"added_files,omitempty"`
	// contains filtered or unexported fields
}

Task.Operation.Request describes the operation state for execution.

func (*Task_Operation_Request) Descriptor deprecated 

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

Deprecated: Use Task_Operation_Request.ProtoReflect.Descriptor instead.

func (*Task_Operation_Request) GetAddedFiles added in v0.1.0 

func (x *Task_Operation_Request) GetAddedFiles() []string

func (*Task_Operation_Request) GetStorage 

func (x *Task_Operation_Request) GetStorage() map[string]string

func (*Task_Operation_Request) GetTask 

func (x *Task_Operation_Request) GetTask() *Task_Ref

func (*Task_Operation_Request) ProtoMessage 

func (*Task_Operation_Request) ProtoMessage()

func (*Task_Operation_Request) ProtoReflect 

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

func (*Task_Operation_Request) Reset 

func (x *Task_Operation_Request) Reset()

func (*Task_Operation_Request) String 

func (x *Task_Operation_Request) String() string

type Task_Operation_Response 

type Task_Operation_Response struct {

	// This is the properties to apply to storage for use with the next
	// stage.
	StorageUpdate map[string]string `` /* 188-byte string literal not displayed */
	// This returns a list of files that have been modified that will need
	// their changes added to version control.
	AddedFiles []string `protobuf:"bytes,3,rep,name=added_files,json=addedFiles,proto3" json:"added_files,omitempty"`
	// contains filtered or unexported fields
}

Task.Operation.Response describes the result for an execution.

func (*Task_Operation_Response) Descriptor deprecated 

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

Deprecated: Use Task_Operation_Response.ProtoReflect.Descriptor instead.

func (*Task_Operation_Response) GetAddedFiles added in v0.1.0 

func (x *Task_Operation_Response) GetAddedFiles() []string

func (*Task_Operation_Response) GetStorageUpdate 

func (x *Task_Operation_Response) GetStorageUpdate() map[string]string

func (*Task_Operation_Response) ProtoMessage 

func (*Task_Operation_Response) ProtoMessage()

func (*Task_Operation_Response) ProtoReflect 

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

func (*Task_Operation_Response) Reset 

func (x *Task_Operation_Response) Reset()

func (*Task_Operation_Response) String 

func (x *Task_Operation_Response) String() string

type Task_Prepare 

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

Task.Prepare is the namespace container for messages used with the Prepare() function.

func (*Task_Prepare) Descriptor deprecated 

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

Deprecated: Use Task_Prepare.ProtoReflect.Descriptor instead.

func (*Task_Prepare) ProtoMessage 

func (*Task_Prepare) ProtoMessage()

func (*Task_Prepare) ProtoReflect 

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

func (*Task_Prepare) Reset 

func (x *Task_Prepare) Reset()

func (*Task_Prepare) String 

func (x *Task_Prepare) String() string

type Task_Prepare_Request 

type Task_Prepare_Request struct {

	// This is the name of the task to execute.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// This is the global configuration to use with this task.
	GlobalConfig *Config `protobuf:"bytes,2,opt,name=global_config,json=globalConfig,proto3" json:"global_config,omitempty"`
	// contains filtered or unexported fields
}

Task.Prepare.Request is the request passed to the Prepare() function.

func (*Task_Prepare_Request) Descriptor deprecated 

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

Deprecated: Use Task_Prepare_Request.ProtoReflect.Descriptor instead.

func (*Task_Prepare_Request) GetGlobalConfig 

func (x *Task_Prepare_Request) GetGlobalConfig() *Config

func (*Task_Prepare_Request) GetName 

func (x *Task_Prepare_Request) GetName() string

func (*Task_Prepare_Request) ProtoMessage 

func (*Task_Prepare_Request) ProtoMessage()

func (*Task_Prepare_Request) ProtoReflect 

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

func (*Task_Prepare_Request) Reset 

func (x *Task_Prepare_Request) Reset()

func (*Task_Prepare_Request) String 

func (x *Task_Prepare_Request) String() string

type Task_Prepare_Response 

type Task_Prepare_Response struct {

	// This is the task reference that will need to be passed when executing
	// each operation of the task.
	Task *Task_Ref `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`
	// This contains any initial storage updates that the plugin wishes to add
	// to the properties used while executing this task.
	Storage map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

Task.Prepare.Response is the response returned from the Prepare() function.

func (*Task_Prepare_Response) Descriptor deprecated 

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

Deprecated: Use Task_Prepare_Response.ProtoReflect.Descriptor instead.

func (*Task_Prepare_Response) GetStorage 

func (x *Task_Prepare_Response) GetStorage() map[string]string

func (*Task_Prepare_Response) GetTask 

func (x *Task_Prepare_Response) GetTask() *Task_Ref

func (*Task_Prepare_Response) ProtoMessage 

func (*Task_Prepare_Response) ProtoMessage()

func (*Task_Prepare_Response) ProtoReflect 

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

func (*Task_Prepare_Response) Reset 

func (x *Task_Prepare_Response) Reset()

func (*Task_Prepare_Response) String 

func (x *Task_Prepare_Response) String() string

type Task_Ref 

type Task_Ref struct {

	// This is the name of the task being executed.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// This is an arbitrary identifier used to identify which plugin state is
	// being executed.
	StateId string `protobuf:"bytes,2,opt,name=state_id,json=stateId,proto3" json:"state_id,omitempty"`
	// contains filtered or unexported fields
}

Task.Ref is used to refer to a task state while executing an task.

func (*Task_Ref) Descriptor deprecated 

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

Deprecated: Use Task_Ref.ProtoReflect.Descriptor instead.

func (*Task_Ref) GetName 

func (x *Task_Ref) GetName() string

func (*Task_Ref) GetStateId 

func (x *Task_Ref) GetStateId() string

func (*Task_Ref) ProtoMessage 

func (*Task_Ref) ProtoMessage()

func (*Task_Ref) ProtoReflect 

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

func (*Task_Ref) Reset 

func (x *Task_Ref) Reset()

func (*Task_Ref) String 

func (x *Task_Ref) String() string

type Task_SubStage 

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

Task.SubStage is the namespace container for sub-stage operations.

func (*Task_SubStage) Descriptor deprecated 

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

Deprecated: Use Task_SubStage.ProtoReflect.Descriptor instead.

func (*Task_SubStage) ProtoMessage 

func (*Task_SubStage) ProtoMessage()

func (*Task_SubStage) ProtoReflect 

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

func (*Task_SubStage) Reset 

func (x *Task_SubStage) Reset()

func (*Task_SubStage) String 

func (x *Task_SubStage) String() string

type Task_SubStage_Request 

type Task_SubStage_Request struct {

	// This is the operation to request.
	Request *Task_Operation_Request `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
	// This is the sub-stage of tha toperation to execute.
	SubStage int32 `protobuf:"varint,2,opt,name=sub_stage,json=subStage,proto3" json:"sub_stage,omitempty"`
	// contains filtered or unexported fields
}

Task.SubStage>Request is the request to initiate a sub-stage operation.

func (*Task_SubStage_Request) Descriptor deprecated 

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

Deprecated: Use Task_SubStage_Request.ProtoReflect.Descriptor instead.

func (*Task_SubStage_Request) GetRequest 

func (x *Task_SubStage_Request) GetRequest() *Task_Operation_Request

func (*Task_SubStage_Request) GetSubStage 

func (x *Task_SubStage_Request) GetSubStage() int32

func (*Task_SubStage_Request) ProtoMessage 

func (*Task_SubStage_Request) ProtoMessage()

func (*Task_SubStage_Request) ProtoReflect 

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

func (*Task_SubStage_Request) Reset 

func (x *Task_SubStage_Request) Reset()

func (*Task_SubStage_Request) String 

func (x *Task_SubStage_Request) String() string

type Task_SubStage_Response 

type Task_SubStage_Response struct {

	// These are the priority stages that this plugin implements for this
	// task.
	ProvidedOrders []int32 `protobuf:"varint,1,rep,packed,name=provided_orders,json=providedOrders,proto3" json:"provided_orders,omitempty"`
	// contains filtered or unexported fields
}

Task.SubStage.Response is the response from preparing a prioritized-operation stage.

func (*Task_SubStage_Response) Descriptor deprecated 

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

Deprecated: Use Task_SubStage_Response.ProtoReflect.Descriptor instead.

func (*Task_SubStage_Response) GetProvidedOrders 

func (x *Task_SubStage_Response) GetProvidedOrders() []int32

func (*Task_SubStage_Response) ProtoMessage 

func (*Task_SubStage_Response) ProtoMessage()

func (*Task_SubStage_Response) ProtoReflect 

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

func (*Task_SubStage_Response) Reset 

func (x *Task_SubStage_Response) Reset()

func (*Task_SubStage_Response) String 

func (x *Task_SubStage_Response) String() string

type UnimplementedTaskExecutionServer 

type UnimplementedTaskExecutionServer struct {
}

UnimplementedTaskExecutionServer must be embedded to have forward compatible implementations.

func (UnimplementedTaskExecutionServer) Cancel 

func (UnimplementedTaskExecutionServer) Cancel(context.Context, *Task_Cancel_Request) (*Task_Cancel_Response, error)

func (UnimplementedTaskExecutionServer) Complete 

func (UnimplementedTaskExecutionServer) Complete(context.Context, *Task_Complete_Request) (*Task_Complete_Response, error)

func (UnimplementedTaskExecutionServer) ExecuteBegin 

func (UnimplementedTaskExecutionServer) ExecuteBegin(context.Context, *Task_SubStage_Request) (*Task_Operation_Response, error)

func (UnimplementedTaskExecutionServer) ExecuteCheck 

func (UnimplementedTaskExecutionServer) ExecuteCheck(context.Context, *Task_Operation_Request) (*Task_Operation_Response, error)

func (UnimplementedTaskExecutionServer) ExecuteEnd 

func (UnimplementedTaskExecutionServer) ExecuteEnd(context.Context, *Task_SubStage_Request) (*Task_Operation_Response, error)

func (UnimplementedTaskExecutionServer) ExecuteFinish 

func (UnimplementedTaskExecutionServer) ExecuteFinish(context.Context, *Task_Operation_Request) (*Task_Operation_Response, error)

func (UnimplementedTaskExecutionServer) ExecuteRun 

func (UnimplementedTaskExecutionServer) ExecuteRun(context.Context, *Task_SubStage_Request) (*Task_Operation_Response, error)

func (UnimplementedTaskExecutionServer) Goal 

func (UnimplementedTaskExecutionServer) Goal(context.Context, *Task_Goal_Request) (*Task_Goal_Response, error)

func (UnimplementedTaskExecutionServer) Implements 

func (UnimplementedTaskExecutionServer) Implements(context.Context, *Task_Implements_Request) (*Task_Implements_Response, error)

func (UnimplementedTaskExecutionServer) Prepare 

func (UnimplementedTaskExecutionServer) Prepare(context.Context, *Task_Prepare_Request) (*Task_Prepare_Response, error)

func (UnimplementedTaskExecutionServer) PrepareBegin 

func (UnimplementedTaskExecutionServer) PrepareBegin(context.Context, *Task_Ref) (*Task_SubStage_Response, error)

func (UnimplementedTaskExecutionServer) PrepareEnd 

func (UnimplementedTaskExecutionServer) PrepareEnd(context.Context, *Task_Ref) (*Task_SubStage_Response, error)

func (UnimplementedTaskExecutionServer) PrepareRun 

func (UnimplementedTaskExecutionServer) PrepareRun(context.Context, *Task_Ref) (*Task_SubStage_Response, error)

type UnsafeTaskExecutionServer 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.