Documentation ¶
Overview ¶
Package workflow is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterWorkflowServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterWorkflowServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client WorkflowServiceClient) error
- func RegisterWorkflowServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterWorkflowServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server WorkflowServiceServer) error
- func RegisterWorkflowServiceServer(s *grpc.Server, srv WorkflowServiceServer)
- type CreateRequest
- func (*CreateRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateRequest) GetHardware() string
- func (x *CreateRequest) GetTemplate() string
- func (*CreateRequest) ProtoMessage()
- func (x *CreateRequest) ProtoReflect() protoreflect.Message
- func (x *CreateRequest) Reset()
- func (x *CreateRequest) String() string
- type CreateResponse
- type Empty
- type GetRequest
- type GetWorkflowDataRequest
- func (*GetWorkflowDataRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetWorkflowDataRequest) GetVersion() int32
- func (x *GetWorkflowDataRequest) GetWorkflowId() string
- func (*GetWorkflowDataRequest) ProtoMessage()
- func (x *GetWorkflowDataRequest) ProtoReflect() protoreflect.Message
- func (x *GetWorkflowDataRequest) Reset()
- func (x *GetWorkflowDataRequest) String() string
- type GetWorkflowDataResponse
- func (*GetWorkflowDataResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetWorkflowDataResponse) GetData() []byte
- func (x *GetWorkflowDataResponse) GetVersion() int32
- func (*GetWorkflowDataResponse) ProtoMessage()
- func (x *GetWorkflowDataResponse) ProtoReflect() protoreflect.Message
- func (x *GetWorkflowDataResponse) Reset()
- func (x *GetWorkflowDataResponse) String() string
- type State
- type UnimplementedWorkflowServiceServer
- func (*UnimplementedWorkflowServiceServer) CreateWorkflow(context.Context, *CreateRequest) (*CreateResponse, error)
- func (*UnimplementedWorkflowServiceServer) DeleteWorkflow(context.Context, *GetRequest) (*Empty, error)
- func (*UnimplementedWorkflowServiceServer) GetWorkflow(context.Context, *GetRequest) (*Workflow, error)
- func (*UnimplementedWorkflowServiceServer) GetWorkflowActions(context.Context, *WorkflowActionsRequest) (*WorkflowActionList, error)
- func (*UnimplementedWorkflowServiceServer) GetWorkflowContext(context.Context, *GetRequest) (*WorkflowContext, error)
- func (*UnimplementedWorkflowServiceServer) GetWorkflowContextList(context.Context, *WorkflowContextRequest) (*WorkflowContextList, error)
- func (*UnimplementedWorkflowServiceServer) GetWorkflowContexts(*WorkflowContextRequest, WorkflowService_GetWorkflowContextsServer) error
- func (*UnimplementedWorkflowServiceServer) GetWorkflowData(context.Context, *GetWorkflowDataRequest) (*GetWorkflowDataResponse, error)
- func (*UnimplementedWorkflowServiceServer) GetWorkflowDataVersion(context.Context, *GetWorkflowDataRequest) (*GetWorkflowDataResponse, error)
- func (*UnimplementedWorkflowServiceServer) GetWorkflowMetadata(context.Context, *GetWorkflowDataRequest) (*GetWorkflowDataResponse, error)
- func (*UnimplementedWorkflowServiceServer) ListWorkflows(*Empty, WorkflowService_ListWorkflowsServer) error
- func (*UnimplementedWorkflowServiceServer) ReportActionStatus(context.Context, *WorkflowActionStatus) (*Empty, error)
- func (*UnimplementedWorkflowServiceServer) ShowWorkflowEvents(*GetRequest, WorkflowService_ShowWorkflowEventsServer) error
- func (*UnimplementedWorkflowServiceServer) UpdateWorkflowData(context.Context, *UpdateWorkflowDataRequest) (*Empty, error)
- type UpdateWorkflowDataRequest
- func (*UpdateWorkflowDataRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateWorkflowDataRequest) GetData() []byte
- func (x *UpdateWorkflowDataRequest) GetMetadata() []byte
- func (x *UpdateWorkflowDataRequest) GetWorkflowId() string
- func (*UpdateWorkflowDataRequest) ProtoMessage()
- func (x *UpdateWorkflowDataRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateWorkflowDataRequest) Reset()
- func (x *UpdateWorkflowDataRequest) String() string
- type Workflow
- func (*Workflow) Descriptor() ([]byte, []int)deprecated
- func (x *Workflow) GetCreatedAt() *timestamppb.Timestamp
- func (x *Workflow) GetData() string
- func (x *Workflow) GetDeletedAt() *timestamppb.Timestamp
- func (x *Workflow) GetHardware() string
- func (x *Workflow) GetId() string
- func (x *Workflow) GetState() State
- func (x *Workflow) GetTemplate() string
- func (x *Workflow) GetUpdatedAt() *timestamppb.Timestamp
- func (*Workflow) ProtoMessage()
- func (x *Workflow) ProtoReflect() protoreflect.Message
- func (x *Workflow) Reset()
- func (x *Workflow) String() string
- type WorkflowAction
- func (*WorkflowAction) Descriptor() ([]byte, []int)deprecated
- func (x *WorkflowAction) GetCommand() []string
- func (x *WorkflowAction) GetEnvironment() []string
- func (x *WorkflowAction) GetImage() string
- func (x *WorkflowAction) GetName() string
- func (x *WorkflowAction) GetOnFailure() []string
- func (x *WorkflowAction) GetOnTimeout() []string
- func (x *WorkflowAction) GetPid() string
- func (x *WorkflowAction) GetTaskName() string
- func (x *WorkflowAction) GetTimeout() int64
- func (x *WorkflowAction) GetVolumes() []string
- func (x *WorkflowAction) GetWorkerId() string
- func (*WorkflowAction) ProtoMessage()
- func (x *WorkflowAction) ProtoReflect() protoreflect.Message
- func (x *WorkflowAction) Reset()
- func (x *WorkflowAction) String() string
- type WorkflowActionList
- func (*WorkflowActionList) Descriptor() ([]byte, []int)deprecated
- func (x *WorkflowActionList) GetActionList() []*WorkflowAction
- func (*WorkflowActionList) ProtoMessage()
- func (x *WorkflowActionList) ProtoReflect() protoreflect.Message
- func (x *WorkflowActionList) Reset()
- func (x *WorkflowActionList) String() string
- type WorkflowActionStatus
- func (*WorkflowActionStatus) Descriptor() ([]byte, []int)deprecated
- func (x *WorkflowActionStatus) GetActionName() string
- func (x *WorkflowActionStatus) GetActionStatus() State
- func (x *WorkflowActionStatus) GetCreatedAt() *timestamppb.Timestamp
- func (x *WorkflowActionStatus) GetMessage() string
- func (x *WorkflowActionStatus) GetSeconds() int64
- func (x *WorkflowActionStatus) GetTaskName() string
- func (x *WorkflowActionStatus) GetWorkerId() string
- func (x *WorkflowActionStatus) GetWorkflowId() string
- func (*WorkflowActionStatus) ProtoMessage()
- func (x *WorkflowActionStatus) ProtoReflect() protoreflect.Message
- func (x *WorkflowActionStatus) Reset()
- func (x *WorkflowActionStatus) String() string
- type WorkflowActionsRequest
- func (*WorkflowActionsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *WorkflowActionsRequest) GetWorkflowId() string
- func (*WorkflowActionsRequest) ProtoMessage()
- func (x *WorkflowActionsRequest) ProtoReflect() protoreflect.Message
- func (x *WorkflowActionsRequest) Reset()
- func (x *WorkflowActionsRequest) String() string
- type WorkflowContext
- func (*WorkflowContext) Descriptor() ([]byte, []int)deprecated
- func (x *WorkflowContext) GetCurrentAction() string
- func (x *WorkflowContext) GetCurrentActionIndex() int64
- func (x *WorkflowContext) GetCurrentActionState() State
- func (x *WorkflowContext) GetCurrentTask() string
- func (x *WorkflowContext) GetCurrentWorker() string
- func (x *WorkflowContext) GetTotalNumberOfActions() int64
- func (x *WorkflowContext) GetWorkflowId() string
- func (*WorkflowContext) ProtoMessage()
- func (x *WorkflowContext) ProtoReflect() protoreflect.Message
- func (x *WorkflowContext) Reset()
- func (x *WorkflowContext) String() string
- type WorkflowContextList
- func (*WorkflowContextList) Descriptor() ([]byte, []int)deprecated
- func (x *WorkflowContextList) GetWorkflowContexts() []*WorkflowContext
- func (*WorkflowContextList) ProtoMessage()
- func (x *WorkflowContextList) ProtoReflect() protoreflect.Message
- func (x *WorkflowContextList) Reset()
- func (x *WorkflowContextList) String() string
- type WorkflowContextRequest
- func (*WorkflowContextRequest) Descriptor() ([]byte, []int)deprecated
- func (x *WorkflowContextRequest) GetWorkerId() string
- func (*WorkflowContextRequest) ProtoMessage()
- func (x *WorkflowContextRequest) ProtoReflect() protoreflect.Message
- func (x *WorkflowContextRequest) Reset()
- func (x *WorkflowContextRequest) String() string
- type WorkflowServiceClient
- type WorkflowServiceClientMock
- func (mock *WorkflowServiceClientMock) CreateWorkflow(ctx context.Context, in *CreateRequest, opts ...grpc.CallOption) (*CreateResponse, error)
- func (mock *WorkflowServiceClientMock) CreateWorkflowCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) DeleteWorkflow(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*Empty, error)
- func (mock *WorkflowServiceClientMock) DeleteWorkflowCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) GetWorkflow(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*Workflow, error)
- func (mock *WorkflowServiceClientMock) GetWorkflowActions(ctx context.Context, in *WorkflowActionsRequest, opts ...grpc.CallOption) (*WorkflowActionList, error)
- func (mock *WorkflowServiceClientMock) GetWorkflowActionsCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) GetWorkflowCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) GetWorkflowContext(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*WorkflowContext, error)
- func (mock *WorkflowServiceClientMock) GetWorkflowContextCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) GetWorkflowContextList(ctx context.Context, in *WorkflowContextRequest, opts ...grpc.CallOption) (*WorkflowContextList, error)
- func (mock *WorkflowServiceClientMock) GetWorkflowContextListCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) GetWorkflowContexts(ctx context.Context, in *WorkflowContextRequest, opts ...grpc.CallOption) (WorkflowService_GetWorkflowContextsClient, error)
- func (mock *WorkflowServiceClientMock) GetWorkflowContextsCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) GetWorkflowData(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error)
- func (mock *WorkflowServiceClientMock) GetWorkflowDataCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) GetWorkflowDataVersion(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error)
- func (mock *WorkflowServiceClientMock) GetWorkflowDataVersionCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) GetWorkflowMetadata(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error)
- func (mock *WorkflowServiceClientMock) GetWorkflowMetadataCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) ListWorkflows(ctx context.Context, in *Empty, opts ...grpc.CallOption) (WorkflowService_ListWorkflowsClient, error)
- func (mock *WorkflowServiceClientMock) ListWorkflowsCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) ReportActionStatus(ctx context.Context, in *WorkflowActionStatus, opts ...grpc.CallOption) (*Empty, error)
- func (mock *WorkflowServiceClientMock) ReportActionStatusCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) ShowWorkflowEvents(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (WorkflowService_ShowWorkflowEventsClient, error)
- func (mock *WorkflowServiceClientMock) ShowWorkflowEventsCalls() []struct{ ... }
- func (mock *WorkflowServiceClientMock) UpdateWorkflowData(ctx context.Context, in *UpdateWorkflowDataRequest, opts ...grpc.CallOption) (*Empty, error)
- func (mock *WorkflowServiceClientMock) UpdateWorkflowDataCalls() []struct{ ... }
- type WorkflowServiceServer
- type WorkflowService_GetWorkflowContextsClient
- type WorkflowService_GetWorkflowContextsServer
- type WorkflowService_ListWorkflowsClient
- type WorkflowService_ListWorkflowsClientMock
- func (mock *WorkflowService_ListWorkflowsClientMock) CloseSend() error
- func (mock *WorkflowService_ListWorkflowsClientMock) CloseSendCalls() []struct{}
- func (mock *WorkflowService_ListWorkflowsClientMock) Context() context.Context
- func (mock *WorkflowService_ListWorkflowsClientMock) ContextCalls() []struct{}
- func (mock *WorkflowService_ListWorkflowsClientMock) Header() (metadata.MD, error)
- func (mock *WorkflowService_ListWorkflowsClientMock) HeaderCalls() []struct{}
- func (mock *WorkflowService_ListWorkflowsClientMock) Recv() (*Workflow, error)
- func (mock *WorkflowService_ListWorkflowsClientMock) RecvCalls() []struct{}
- func (mock *WorkflowService_ListWorkflowsClientMock) RecvMsg(m interface{}) error
- func (mock *WorkflowService_ListWorkflowsClientMock) RecvMsgCalls() []struct{ ... }
- func (mock *WorkflowService_ListWorkflowsClientMock) SendMsg(m interface{}) error
- func (mock *WorkflowService_ListWorkflowsClientMock) SendMsgCalls() []struct{ ... }
- func (mock *WorkflowService_ListWorkflowsClientMock) Trailer() metadata.MD
- func (mock *WorkflowService_ListWorkflowsClientMock) TrailerCalls() []struct{}
- type WorkflowService_ListWorkflowsServer
- type WorkflowService_ShowWorkflowEventsClient
- type WorkflowService_ShowWorkflowEventsServer
Constants ¶
This section is empty.
Variables ¶
var ( State_name = map[int32]string{ 0: "STATE_PENDING", 1: "STATE_RUNNING", 2: "STATE_FAILED", 3: "STATE_TIMEOUT", 4: "STATE_SUCCESS", } State_value = map[string]int32{ "STATE_PENDING": 0, "STATE_RUNNING": 1, "STATE_FAILED": 2, "STATE_TIMEOUT": 3, "STATE_SUCCESS": 4, } )
Enum value maps for State.
var File_workflow_workflow_proto protoreflect.FileDescriptor
Functions ¶
func RegisterWorkflowServiceHandler ¶
func RegisterWorkflowServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterWorkflowServiceHandler registers the http handlers for service WorkflowService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterWorkflowServiceHandlerClient ¶
func RegisterWorkflowServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client WorkflowServiceClient) error
RegisterWorkflowServiceHandlerClient registers the http handlers for service WorkflowService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "WorkflowServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "WorkflowServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "WorkflowServiceClient" to call the correct interceptors.
func RegisterWorkflowServiceHandlerFromEndpoint ¶
func RegisterWorkflowServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterWorkflowServiceHandlerFromEndpoint is same as RegisterWorkflowServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterWorkflowServiceHandlerServer ¶
func RegisterWorkflowServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server WorkflowServiceServer) error
RegisterWorkflowServiceHandlerServer registers the http handlers for service WorkflowService to "mux". UnaryRPC :call WorkflowServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterWorkflowServiceHandlerFromEndpoint instead.
func RegisterWorkflowServiceServer ¶
func RegisterWorkflowServiceServer(s *grpc.Server, srv WorkflowServiceServer)
Types ¶
type CreateRequest ¶
type CreateRequest struct { // // The idenfier of the template the workflow starts from. Template string `protobuf:"bytes,1,opt,name=template,proto3" json:"template,omitempty"` // // The target hardware for this workflow. Hardware string `protobuf:"bytes,2,opt,name=hardware,proto3" json:"hardware,omitempty"` // contains filtered or unexported fields }
CreateRequest registers a workflow in the Tinkerbell server. From this point in time it is in pending state, waiting to be executed from the tink-worker inside the selected hardware
func (*CreateRequest) Descriptor
deprecated
func (*CreateRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateRequest.ProtoReflect.Descriptor instead.
func (*CreateRequest) GetHardware ¶
func (x *CreateRequest) GetHardware() string
func (*CreateRequest) GetTemplate ¶
func (x *CreateRequest) GetTemplate() string
func (*CreateRequest) ProtoMessage ¶
func (*CreateRequest) ProtoMessage()
func (*CreateRequest) ProtoReflect ¶
func (x *CreateRequest) ProtoReflect() protoreflect.Message
func (*CreateRequest) Reset ¶
func (x *CreateRequest) Reset()
func (*CreateRequest) String ¶
func (x *CreateRequest) String() string
type CreateResponse ¶
type CreateResponse struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
This is the response returned after a successful workflow creation. It contains the workflow id.
func (*CreateResponse) Descriptor
deprecated
func (*CreateResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateResponse.ProtoReflect.Descriptor instead.
func (*CreateResponse) GetId ¶
func (x *CreateResponse) GetId() string
func (*CreateResponse) ProtoMessage ¶
func (*CreateResponse) ProtoMessage()
func (*CreateResponse) ProtoReflect ¶
func (x *CreateResponse) ProtoReflect() protoreflect.Message
func (*CreateResponse) Reset ¶
func (x *CreateResponse) Reset()
func (*CreateResponse) String ¶
func (x *CreateResponse) String() string
type Empty ¶
type Empty struct {
// contains filtered or unexported fields
}
Empty represents an empty response
func (*Empty) Descriptor
deprecated
func (*Empty) ProtoMessage ¶
func (*Empty) ProtoMessage()
func (*Empty) ProtoReflect ¶
func (x *Empty) ProtoReflect() protoreflect.Message
type GetRequest ¶
type GetRequest struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
GetRequest contains the workflow idenfier you want to get back from the Tinkerbell server.
func (*GetRequest) Descriptor
deprecated
func (*GetRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetRequest.ProtoReflect.Descriptor instead.
func (*GetRequest) GetId ¶
func (x *GetRequest) GetId() string
func (*GetRequest) ProtoMessage ¶
func (*GetRequest) ProtoMessage()
func (*GetRequest) ProtoReflect ¶
func (x *GetRequest) ProtoReflect() protoreflect.Message
func (*GetRequest) Reset ¶
func (x *GetRequest) Reset()
func (*GetRequest) String ¶
func (x *GetRequest) String() string
type GetWorkflowDataRequest ¶
type GetWorkflowDataRequest struct { WorkflowId string `protobuf:"bytes,1,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"` Version int32 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"` // contains filtered or unexported fields }
When a workflow gets created we have the ability to replace variables declared in the template with concrete variables. This is the request you can use to visualize those data.
func (*GetWorkflowDataRequest) Descriptor
deprecated
func (*GetWorkflowDataRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetWorkflowDataRequest.ProtoReflect.Descriptor instead.
func (*GetWorkflowDataRequest) GetVersion ¶
func (x *GetWorkflowDataRequest) GetVersion() int32
func (*GetWorkflowDataRequest) GetWorkflowId ¶
func (x *GetWorkflowDataRequest) GetWorkflowId() string
func (*GetWorkflowDataRequest) ProtoMessage ¶
func (*GetWorkflowDataRequest) ProtoMessage()
func (*GetWorkflowDataRequest) ProtoReflect ¶
func (x *GetWorkflowDataRequest) ProtoReflect() protoreflect.Message
func (*GetWorkflowDataRequest) Reset ¶
func (x *GetWorkflowDataRequest) Reset()
func (*GetWorkflowDataRequest) String ¶
func (x *GetWorkflowDataRequest) String() string
type GetWorkflowDataResponse ¶
type GetWorkflowDataResponse struct { Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"` Version int32 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"` // contains filtered or unexported fields }
List of data passed during workflow creation.
func (*GetWorkflowDataResponse) Descriptor
deprecated
func (*GetWorkflowDataResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetWorkflowDataResponse.ProtoReflect.Descriptor instead.
func (*GetWorkflowDataResponse) GetData ¶
func (x *GetWorkflowDataResponse) GetData() []byte
func (*GetWorkflowDataResponse) GetVersion ¶
func (x *GetWorkflowDataResponse) GetVersion() int32
func (*GetWorkflowDataResponse) ProtoMessage ¶
func (*GetWorkflowDataResponse) ProtoMessage()
func (*GetWorkflowDataResponse) ProtoReflect ¶
func (x *GetWorkflowDataResponse) ProtoReflect() protoreflect.Message
func (*GetWorkflowDataResponse) Reset ¶
func (x *GetWorkflowDataResponse) Reset()
func (*GetWorkflowDataResponse) String ¶
func (x *GetWorkflowDataResponse) String() string
type State ¶
type State int32
The various state a workflow can be
const ( // // A workflow is in pending state when it is waiting for the hardware to pick // it up and start the execution. State_STATE_PENDING State = 0 // // A workflow is in a running state when the tink-worker started the // exeuction of it, and it is currently in execution inside the device // itself. State_STATE_RUNNING State = 1 // // Failed is a final state. Something wrong happened during the execution of // the workflow inside the target. Have a look at the logs to see if you can // spot what is going on. State_STATE_FAILED State = 2 // // Timeout is final state, almost like FAILED but it communicate to you that // an action or the overall workflow reached the specified timeout. State_STATE_TIMEOUT State = 3 // // This is the state we all deserve. The execution of the workflow is over // and everything is just fine. Sit down, and enjoy your great work. State_STATE_SUCCESS State = 4 )
func (State) Descriptor ¶
func (State) Descriptor() protoreflect.EnumDescriptor
func (State) EnumDescriptor
deprecated
func (State) Number ¶
func (x State) Number() protoreflect.EnumNumber
func (State) Type ¶
func (State) Type() protoreflect.EnumType
type UnimplementedWorkflowServiceServer ¶
type UnimplementedWorkflowServiceServer struct { }
UnimplementedWorkflowServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedWorkflowServiceServer) CreateWorkflow ¶
func (*UnimplementedWorkflowServiceServer) CreateWorkflow(context.Context, *CreateRequest) (*CreateResponse, error)
func (*UnimplementedWorkflowServiceServer) DeleteWorkflow ¶
func (*UnimplementedWorkflowServiceServer) DeleteWorkflow(context.Context, *GetRequest) (*Empty, error)
func (*UnimplementedWorkflowServiceServer) GetWorkflow ¶
func (*UnimplementedWorkflowServiceServer) GetWorkflow(context.Context, *GetRequest) (*Workflow, error)
func (*UnimplementedWorkflowServiceServer) GetWorkflowActions ¶
func (*UnimplementedWorkflowServiceServer) GetWorkflowActions(context.Context, *WorkflowActionsRequest) (*WorkflowActionList, error)
func (*UnimplementedWorkflowServiceServer) GetWorkflowContext ¶
func (*UnimplementedWorkflowServiceServer) GetWorkflowContext(context.Context, *GetRequest) (*WorkflowContext, error)
func (*UnimplementedWorkflowServiceServer) GetWorkflowContextList ¶
func (*UnimplementedWorkflowServiceServer) GetWorkflowContextList(context.Context, *WorkflowContextRequest) (*WorkflowContextList, error)
func (*UnimplementedWorkflowServiceServer) GetWorkflowContexts ¶
func (*UnimplementedWorkflowServiceServer) GetWorkflowContexts(*WorkflowContextRequest, WorkflowService_GetWorkflowContextsServer) error
func (*UnimplementedWorkflowServiceServer) GetWorkflowData ¶
func (*UnimplementedWorkflowServiceServer) GetWorkflowData(context.Context, *GetWorkflowDataRequest) (*GetWorkflowDataResponse, error)
func (*UnimplementedWorkflowServiceServer) GetWorkflowDataVersion ¶
func (*UnimplementedWorkflowServiceServer) GetWorkflowDataVersion(context.Context, *GetWorkflowDataRequest) (*GetWorkflowDataResponse, error)
func (*UnimplementedWorkflowServiceServer) GetWorkflowMetadata ¶
func (*UnimplementedWorkflowServiceServer) GetWorkflowMetadata(context.Context, *GetWorkflowDataRequest) (*GetWorkflowDataResponse, error)
func (*UnimplementedWorkflowServiceServer) ListWorkflows ¶
func (*UnimplementedWorkflowServiceServer) ListWorkflows(*Empty, WorkflowService_ListWorkflowsServer) error
func (*UnimplementedWorkflowServiceServer) ReportActionStatus ¶
func (*UnimplementedWorkflowServiceServer) ReportActionStatus(context.Context, *WorkflowActionStatus) (*Empty, error)
func (*UnimplementedWorkflowServiceServer) ShowWorkflowEvents ¶
func (*UnimplementedWorkflowServiceServer) ShowWorkflowEvents(*GetRequest, WorkflowService_ShowWorkflowEventsServer) error
func (*UnimplementedWorkflowServiceServer) UpdateWorkflowData ¶
func (*UnimplementedWorkflowServiceServer) UpdateWorkflowData(context.Context, *UpdateWorkflowDataRequest) (*Empty, error)
type UpdateWorkflowDataRequest ¶
type UpdateWorkflowDataRequest struct { WorkflowId string `protobuf:"bytes,1,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"` Metadata []byte `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"` Data []byte `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"` // contains filtered or unexported fields }
You can change data passed to a workflow
func (*UpdateWorkflowDataRequest) Descriptor
deprecated
func (*UpdateWorkflowDataRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateWorkflowDataRequest.ProtoReflect.Descriptor instead.
func (*UpdateWorkflowDataRequest) GetData ¶
func (x *UpdateWorkflowDataRequest) GetData() []byte
func (*UpdateWorkflowDataRequest) GetMetadata ¶
func (x *UpdateWorkflowDataRequest) GetMetadata() []byte
func (*UpdateWorkflowDataRequest) GetWorkflowId ¶
func (x *UpdateWorkflowDataRequest) GetWorkflowId() string
func (*UpdateWorkflowDataRequest) ProtoMessage ¶
func (*UpdateWorkflowDataRequest) ProtoMessage()
func (*UpdateWorkflowDataRequest) ProtoReflect ¶
func (x *UpdateWorkflowDataRequest) ProtoReflect() protoreflect.Message
func (*UpdateWorkflowDataRequest) Reset ¶
func (x *UpdateWorkflowDataRequest) Reset()
func (*UpdateWorkflowDataRequest) String ¶
func (x *UpdateWorkflowDataRequest) String() string
type Workflow ¶
type Workflow struct { // // The unique identifier for a workflow Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // // The template this workflows starts from Template string `protobuf:"bytes,2,opt,name=template,proto3" json:"template,omitempty"` // // The hardware assigned to a workflow Hardware string `protobuf:"bytes,3,opt,name=hardware,proto3" json:"hardware,omitempty"` // // Current state of the workflow. Pending, success, failed, running. State State `protobuf:"varint,4,opt,name=state,proto3,enum=github.com.tinkerbell.tink.protos.workflow.State" json:"state,omitempty"` // // When the workflow was created CreatedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` // // The last time the workflow was modified UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"` // // When the workflow was deleted DeletedAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=deleted_at,json=deletedAt,proto3" json:"deleted_at,omitempty"` Data string `protobuf:"bytes,8,opt,name=data,proto3" json:"data,omitempty"` // contains filtered or unexported fields }
Workflow represent a single workflow
func (*Workflow) Descriptor
deprecated
func (*Workflow) GetCreatedAt ¶
func (x *Workflow) GetCreatedAt() *timestamppb.Timestamp
func (*Workflow) GetDeletedAt ¶
func (x *Workflow) GetDeletedAt() *timestamppb.Timestamp
func (*Workflow) GetHardware ¶
func (*Workflow) GetTemplate ¶
func (*Workflow) GetUpdatedAt ¶
func (x *Workflow) GetUpdatedAt() *timestamppb.Timestamp
func (*Workflow) ProtoMessage ¶
func (*Workflow) ProtoMessage()
func (*Workflow) ProtoReflect ¶
func (x *Workflow) ProtoReflect() protoreflect.Message
type WorkflowAction ¶
type WorkflowAction struct { // // The name of the task the action belong to. TaskName string `protobuf:"bytes,1,opt,name=task_name,json=taskName,proto3" json:"task_name,omitempty"` // // The name of the action Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // // The docker/oci image the action starts from Image string `protobuf:"bytes,3,opt,name=image,proto3" json:"image,omitempty"` // // Every action has a timeout, after that the execution stops and the action // gets in a timeout state. Timeout int64 `protobuf:"varint,4,opt,name=timeout,proto3" json:"timeout,omitempty"` // // You can override the command executed for the container Command []string `protobuf:"bytes,5,rep,name=command,proto3" json:"command,omitempty"` // // On timeout used to be a way to execute an action if the current one times out // but with the event system in place this is not needed anymore OnTimeout []string `protobuf:"bytes,6,rep,name=on_timeout,json=onTimeout,proto3" json:"on_timeout,omitempty"` // // On failure used to be a way to execute an action if the current one fails // but with the event system in place this is not needed anymore OnFailure []string `protobuf:"bytes,7,rep,name=on_failure,json=onFailure,proto3" json:"on_failure,omitempty"` WorkerId string `protobuf:"bytes,8,opt,name=worker_id,json=workerId,proto3" json:"worker_id,omitempty"` // // You can mount directory from your host to the running action, mainly to // share files, or state Volumes []string `protobuf:"bytes,9,rep,name=volumes,proto3" json:"volumes,omitempty"` // // Set environment variables usable from the action itself. Environment []string `protobuf:"bytes,10,rep,name=environment,proto3" json:"environment,omitempty"` // // Set the namespace that the process IDs will be in. Pid string `protobuf:"bytes,11,opt,name=pid,proto3" json:"pid,omitempty"` // contains filtered or unexported fields }
WorkflowAction represents a single aciton part of a workflow
func (*WorkflowAction) Descriptor
deprecated
func (*WorkflowAction) Descriptor() ([]byte, []int)
Deprecated: Use WorkflowAction.ProtoReflect.Descriptor instead.
func (*WorkflowAction) GetCommand ¶
func (x *WorkflowAction) GetCommand() []string
func (*WorkflowAction) GetEnvironment ¶
func (x *WorkflowAction) GetEnvironment() []string
func (*WorkflowAction) GetImage ¶
func (x *WorkflowAction) GetImage() string
func (*WorkflowAction) GetName ¶
func (x *WorkflowAction) GetName() string
func (*WorkflowAction) GetOnFailure ¶
func (x *WorkflowAction) GetOnFailure() []string
func (*WorkflowAction) GetOnTimeout ¶
func (x *WorkflowAction) GetOnTimeout() []string
func (*WorkflowAction) GetPid ¶
func (x *WorkflowAction) GetPid() string
func (*WorkflowAction) GetTaskName ¶
func (x *WorkflowAction) GetTaskName() string
func (*WorkflowAction) GetTimeout ¶
func (x *WorkflowAction) GetTimeout() int64
func (*WorkflowAction) GetVolumes ¶
func (x *WorkflowAction) GetVolumes() []string
func (*WorkflowAction) GetWorkerId ¶
func (x *WorkflowAction) GetWorkerId() string
func (*WorkflowAction) ProtoMessage ¶
func (*WorkflowAction) ProtoMessage()
func (*WorkflowAction) ProtoReflect ¶
func (x *WorkflowAction) ProtoReflect() protoreflect.Message
func (*WorkflowAction) Reset ¶
func (x *WorkflowAction) Reset()
func (*WorkflowAction) String ¶
func (x *WorkflowAction) String() string
type WorkflowActionList ¶
type WorkflowActionList struct { ActionList []*WorkflowAction `protobuf:"bytes,1,rep,name=action_list,json=actionList,proto3" json:"action_list,omitempty"` // contains filtered or unexported fields }
A list of actions
func (*WorkflowActionList) Descriptor
deprecated
func (*WorkflowActionList) Descriptor() ([]byte, []int)
Deprecated: Use WorkflowActionList.ProtoReflect.Descriptor instead.
func (*WorkflowActionList) GetActionList ¶
func (x *WorkflowActionList) GetActionList() []*WorkflowAction
func (*WorkflowActionList) ProtoMessage ¶
func (*WorkflowActionList) ProtoMessage()
func (*WorkflowActionList) ProtoReflect ¶
func (x *WorkflowActionList) ProtoReflect() protoreflect.Message
func (*WorkflowActionList) Reset ¶
func (x *WorkflowActionList) Reset()
func (*WorkflowActionList) String ¶
func (x *WorkflowActionList) String() string
type WorkflowActionStatus ¶
type WorkflowActionStatus struct { // // The workflow id WorkflowId string `protobuf:"bytes,1,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"` // // The name of the task this action is part of TaskName string `protobuf:"bytes,2,opt,name=task_name,json=taskName,proto3" json:"task_name,omitempty"` // // The name of the action ActionName string `protobuf:"bytes,3,opt,name=action_name,json=actionName,proto3" json:"action_name,omitempty"` // // The state of the action. Those are the same described for workflow as // well. pending, running, successful and so on. ActionStatus State `` /* 152-byte string literal not displayed */ // // The execution time for the action Seconds int64 `protobuf:"varint,5,opt,name=seconds,proto3" json:"seconds,omitempty"` // // The message returned from the action. Message string `protobuf:"bytes,6,opt,name=message,proto3" json:"message,omitempty"` // // When the status got created for this aciton. You can see it as the time // when the action started its execution inside the hardware itself. CreatedAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` // WorkerId string `protobuf:"bytes,8,opt,name=worker_id,json=workerId,proto3" json:"worker_id,omitempty"` // contains filtered or unexported fields }
WorkflowActionStatus represents the state of all the action part of a workflow
func (*WorkflowActionStatus) Descriptor
deprecated
func (*WorkflowActionStatus) Descriptor() ([]byte, []int)
Deprecated: Use WorkflowActionStatus.ProtoReflect.Descriptor instead.
func (*WorkflowActionStatus) GetActionName ¶
func (x *WorkflowActionStatus) GetActionName() string
func (*WorkflowActionStatus) GetActionStatus ¶
func (x *WorkflowActionStatus) GetActionStatus() State
func (*WorkflowActionStatus) GetCreatedAt ¶
func (x *WorkflowActionStatus) GetCreatedAt() *timestamppb.Timestamp
func (*WorkflowActionStatus) GetMessage ¶
func (x *WorkflowActionStatus) GetMessage() string
func (*WorkflowActionStatus) GetSeconds ¶
func (x *WorkflowActionStatus) GetSeconds() int64
func (*WorkflowActionStatus) GetTaskName ¶
func (x *WorkflowActionStatus) GetTaskName() string
func (*WorkflowActionStatus) GetWorkerId ¶
func (x *WorkflowActionStatus) GetWorkerId() string
func (*WorkflowActionStatus) GetWorkflowId ¶
func (x *WorkflowActionStatus) GetWorkflowId() string
func (*WorkflowActionStatus) ProtoMessage ¶
func (*WorkflowActionStatus) ProtoMessage()
func (*WorkflowActionStatus) ProtoReflect ¶
func (x *WorkflowActionStatus) ProtoReflect() protoreflect.Message
func (*WorkflowActionStatus) Reset ¶
func (x *WorkflowActionStatus) Reset()
func (*WorkflowActionStatus) String ¶
func (x *WorkflowActionStatus) String() string
type WorkflowActionsRequest ¶
type WorkflowActionsRequest struct { WorkflowId string `protobuf:"bytes,1,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"` // contains filtered or unexported fields }
WorkflowActionsRequest is used to get actions for a particular workflow
func (*WorkflowActionsRequest) Descriptor
deprecated
func (*WorkflowActionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use WorkflowActionsRequest.ProtoReflect.Descriptor instead.
func (*WorkflowActionsRequest) GetWorkflowId ¶
func (x *WorkflowActionsRequest) GetWorkflowId() string
func (*WorkflowActionsRequest) ProtoMessage ¶
func (*WorkflowActionsRequest) ProtoMessage()
func (*WorkflowActionsRequest) ProtoReflect ¶
func (x *WorkflowActionsRequest) ProtoReflect() protoreflect.Message
func (*WorkflowActionsRequest) Reset ¶
func (x *WorkflowActionsRequest) Reset()
func (*WorkflowActionsRequest) String ¶
func (x *WorkflowActionsRequest) String() string
type WorkflowContext ¶
type WorkflowContext struct { // // The workflow ID WorkflowId string `protobuf:"bytes,1,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"` // CurrentWorker string `protobuf:"bytes,2,opt,name=current_worker,json=currentWorker,proto3" json:"current_worker,omitempty"` // CurrentTask string `protobuf:"bytes,3,opt,name=current_task,json=currentTask,proto3" json:"current_task,omitempty"` // // the name of the current action CurrentAction string `protobuf:"bytes,4,opt,name=current_action,json=currentAction,proto3" json:"current_action,omitempty"` // // The index of the current action CurrentActionIndex int64 `protobuf:"varint,5,opt,name=current_action_index,json=currentActionIndex,proto3" json:"current_action_index,omitempty"` // // The state of the current action CurrentActionState State `` /* 172-byte string literal not displayed */ // TotalNumberOfActions int64 `` /* 126-byte string literal not displayed */ // contains filtered or unexported fields }
WorkflowContext represents the state of the execution of this workflow in detail. How many tasks are currently executed, the number of actions and their state.
func (*WorkflowContext) Descriptor
deprecated
func (*WorkflowContext) Descriptor() ([]byte, []int)
Deprecated: Use WorkflowContext.ProtoReflect.Descriptor instead.
func (*WorkflowContext) GetCurrentAction ¶
func (x *WorkflowContext) GetCurrentAction() string
func (*WorkflowContext) GetCurrentActionIndex ¶
func (x *WorkflowContext) GetCurrentActionIndex() int64
func (*WorkflowContext) GetCurrentActionState ¶
func (x *WorkflowContext) GetCurrentActionState() State
func (*WorkflowContext) GetCurrentTask ¶
func (x *WorkflowContext) GetCurrentTask() string
func (*WorkflowContext) GetCurrentWorker ¶
func (x *WorkflowContext) GetCurrentWorker() string
func (*WorkflowContext) GetTotalNumberOfActions ¶
func (x *WorkflowContext) GetTotalNumberOfActions() int64
func (*WorkflowContext) GetWorkflowId ¶
func (x *WorkflowContext) GetWorkflowId() string
func (*WorkflowContext) ProtoMessage ¶
func (*WorkflowContext) ProtoMessage()
func (*WorkflowContext) ProtoReflect ¶
func (x *WorkflowContext) ProtoReflect() protoreflect.Message
func (*WorkflowContext) Reset ¶
func (x *WorkflowContext) Reset()
func (*WorkflowContext) String ¶
func (x *WorkflowContext) String() string
type WorkflowContextList ¶
type WorkflowContextList struct { WorkflowContexts []*WorkflowContext `protobuf:"bytes,1,rep,name=workflow_contexts,json=workflowContexts,proto3" json:"workflow_contexts,omitempty"` // contains filtered or unexported fields }
func (*WorkflowContextList) Descriptor
deprecated
func (*WorkflowContextList) Descriptor() ([]byte, []int)
Deprecated: Use WorkflowContextList.ProtoReflect.Descriptor instead.
func (*WorkflowContextList) GetWorkflowContexts ¶
func (x *WorkflowContextList) GetWorkflowContexts() []*WorkflowContext
func (*WorkflowContextList) ProtoMessage ¶
func (*WorkflowContextList) ProtoMessage()
func (*WorkflowContextList) ProtoReflect ¶
func (x *WorkflowContextList) ProtoReflect() protoreflect.Message
func (*WorkflowContextList) Reset ¶
func (x *WorkflowContextList) Reset()
func (*WorkflowContextList) String ¶
func (x *WorkflowContextList) String() string
type WorkflowContextRequest ¶
type WorkflowContextRequest struct { // WorkerId string `protobuf:"bytes,1,opt,name=worker_id,json=workerId,proto3" json:"worker_id,omitempty"` // contains filtered or unexported fields }
func (*WorkflowContextRequest) Descriptor
deprecated
func (*WorkflowContextRequest) Descriptor() ([]byte, []int)
Deprecated: Use WorkflowContextRequest.ProtoReflect.Descriptor instead.
func (*WorkflowContextRequest) GetWorkerId ¶
func (x *WorkflowContextRequest) GetWorkerId() string
func (*WorkflowContextRequest) ProtoMessage ¶
func (*WorkflowContextRequest) ProtoMessage()
func (*WorkflowContextRequest) ProtoReflect ¶
func (x *WorkflowContextRequest) ProtoReflect() protoreflect.Message
func (*WorkflowContextRequest) Reset ¶
func (x *WorkflowContextRequest) Reset()
func (*WorkflowContextRequest) String ¶
func (x *WorkflowContextRequest) String() string
type WorkflowServiceClient ¶
type WorkflowServiceClient interface { // // CreateWorkflow targets a specific hardware and it starts from a particular // template. The selected hardware is capable of picking the // workflow up for execution. CreateWorkflow(ctx context.Context, in *CreateRequest, opts ...grpc.CallOption) (*CreateResponse, error) // // GetWorkflow returns a specific workflow by its identifier. GetWorkflow(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*Workflow, error) // // DeleteWorkflow deletes a workflow. This is a logical deletion. Workflow // will stay available for inspection DeleteWorkflow(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*Empty, error) // // ListWorkflows returns a list of workflows ListWorkflows(ctx context.Context, in *Empty, opts ...grpc.CallOption) (WorkflowService_ListWorkflowsClient, error) // // GetWorkflowContext returns specific information about where it is running, // its state and so on. Useful to debug a workflow and to understand its // current state. GetWorkflowContext(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*WorkflowContext, error) // // ShowWorkflowEvents returns a list of events for a specific workflows ShowWorkflowEvents(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (WorkflowService_ShowWorkflowEventsClient, error) GetWorkflowContextList(ctx context.Context, in *WorkflowContextRequest, opts ...grpc.CallOption) (*WorkflowContextList, error) GetWorkflowContexts(ctx context.Context, in *WorkflowContextRequest, opts ...grpc.CallOption) (WorkflowService_GetWorkflowContextsClient, error) GetWorkflowActions(ctx context.Context, in *WorkflowActionsRequest, opts ...grpc.CallOption) (*WorkflowActionList, error) ReportActionStatus(ctx context.Context, in *WorkflowActionStatus, opts ...grpc.CallOption) (*Empty, error) GetWorkflowData(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error) GetWorkflowMetadata(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error) GetWorkflowDataVersion(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error) UpdateWorkflowData(ctx context.Context, in *UpdateWorkflowDataRequest, opts ...grpc.CallOption) (*Empty, error) }
WorkflowServiceClient is the client API for WorkflowService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewWorkflowServiceClient ¶
func NewWorkflowServiceClient(cc grpc.ClientConnInterface) WorkflowServiceClient
type WorkflowServiceClientMock ¶
type WorkflowServiceClientMock struct { // CreateWorkflowFunc mocks the CreateWorkflow method. CreateWorkflowFunc func(ctx context.Context, in *CreateRequest, opts ...grpc.CallOption) (*CreateResponse, error) // DeleteWorkflowFunc mocks the DeleteWorkflow method. DeleteWorkflowFunc func(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*Empty, error) // GetWorkflowFunc mocks the GetWorkflow method. GetWorkflowFunc func(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*Workflow, error) // GetWorkflowActionsFunc mocks the GetWorkflowActions method. GetWorkflowActionsFunc func(ctx context.Context, in *WorkflowActionsRequest, opts ...grpc.CallOption) (*WorkflowActionList, error) // GetWorkflowContextFunc mocks the GetWorkflowContext method. GetWorkflowContextFunc func(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*WorkflowContext, error) // GetWorkflowContextListFunc mocks the GetWorkflowContextList method. GetWorkflowContextListFunc func(ctx context.Context, in *WorkflowContextRequest, opts ...grpc.CallOption) (*WorkflowContextList, error) // GetWorkflowContextsFunc mocks the GetWorkflowContexts method. GetWorkflowContextsFunc func(ctx context.Context, in *WorkflowContextRequest, opts ...grpc.CallOption) (WorkflowService_GetWorkflowContextsClient, error) // GetWorkflowDataFunc mocks the GetWorkflowData method. GetWorkflowDataFunc func(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error) // GetWorkflowDataVersionFunc mocks the GetWorkflowDataVersion method. GetWorkflowDataVersionFunc func(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error) // GetWorkflowMetadataFunc mocks the GetWorkflowMetadata method. GetWorkflowMetadataFunc func(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error) // ListWorkflowsFunc mocks the ListWorkflows method. ListWorkflowsFunc func(ctx context.Context, in *Empty, opts ...grpc.CallOption) (WorkflowService_ListWorkflowsClient, error) // ReportActionStatusFunc mocks the ReportActionStatus method. ReportActionStatusFunc func(ctx context.Context, in *WorkflowActionStatus, opts ...grpc.CallOption) (*Empty, error) // ShowWorkflowEventsFunc mocks the ShowWorkflowEvents method. ShowWorkflowEventsFunc func(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (WorkflowService_ShowWorkflowEventsClient, error) // UpdateWorkflowDataFunc mocks the UpdateWorkflowData method. UpdateWorkflowDataFunc func(ctx context.Context, in *UpdateWorkflowDataRequest, opts ...grpc.CallOption) (*Empty, error) // contains filtered or unexported fields }
WorkflowServiceClientMock is a mock implementation of WorkflowServiceClient.
func TestSomethingThatUsesWorkflowServiceClient(t *testing.T) { // make and configure a mocked WorkflowServiceClient mockedWorkflowServiceClient := &WorkflowServiceClientMock{ CreateWorkflowFunc: func(ctx context.Context, in *CreateRequest, opts ...grpc.CallOption) (*CreateResponse, error) { panic("mock out the CreateWorkflow method") }, DeleteWorkflowFunc: func(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*Empty, error) { panic("mock out the DeleteWorkflow method") }, GetWorkflowFunc: func(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*Workflow, error) { panic("mock out the GetWorkflow method") }, GetWorkflowActionsFunc: func(ctx context.Context, in *WorkflowActionsRequest, opts ...grpc.CallOption) (*WorkflowActionList, error) { panic("mock out the GetWorkflowActions method") }, GetWorkflowContextFunc: func(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*WorkflowContext, error) { panic("mock out the GetWorkflowContext method") }, GetWorkflowContextListFunc: func(ctx context.Context, in *WorkflowContextRequest, opts ...grpc.CallOption) (*WorkflowContextList, error) { panic("mock out the GetWorkflowContextList method") }, GetWorkflowContextsFunc: func(ctx context.Context, in *WorkflowContextRequest, opts ...grpc.CallOption) (WorkflowService_GetWorkflowContextsClient, error) { panic("mock out the GetWorkflowContexts method") }, GetWorkflowDataFunc: func(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error) { panic("mock out the GetWorkflowData method") }, GetWorkflowDataVersionFunc: func(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error) { panic("mock out the GetWorkflowDataVersion method") }, GetWorkflowMetadataFunc: func(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error) { panic("mock out the GetWorkflowMetadata method") }, ListWorkflowsFunc: func(ctx context.Context, in *Empty, opts ...grpc.CallOption) (WorkflowService_ListWorkflowsClient, error) { panic("mock out the ListWorkflows method") }, ReportActionStatusFunc: func(ctx context.Context, in *WorkflowActionStatus, opts ...grpc.CallOption) (*Empty, error) { panic("mock out the ReportActionStatus method") }, ShowWorkflowEventsFunc: func(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (WorkflowService_ShowWorkflowEventsClient, error) { panic("mock out the ShowWorkflowEvents method") }, UpdateWorkflowDataFunc: func(ctx context.Context, in *UpdateWorkflowDataRequest, opts ...grpc.CallOption) (*Empty, error) { panic("mock out the UpdateWorkflowData method") }, } // use mockedWorkflowServiceClient in code that requires WorkflowServiceClient // and then make assertions. }
func (*WorkflowServiceClientMock) CreateWorkflow ¶
func (mock *WorkflowServiceClientMock) CreateWorkflow(ctx context.Context, in *CreateRequest, opts ...grpc.CallOption) (*CreateResponse, error)
CreateWorkflow calls CreateWorkflowFunc.
func (*WorkflowServiceClientMock) CreateWorkflowCalls ¶
func (mock *WorkflowServiceClientMock) CreateWorkflowCalls() []struct { Ctx context.Context In *CreateRequest Opts []grpc.CallOption }
CreateWorkflowCalls gets all the calls that were made to CreateWorkflow. Check the length with:
len(mockedWorkflowServiceClient.CreateWorkflowCalls())
func (*WorkflowServiceClientMock) DeleteWorkflow ¶
func (mock *WorkflowServiceClientMock) DeleteWorkflow(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*Empty, error)
DeleteWorkflow calls DeleteWorkflowFunc.
func (*WorkflowServiceClientMock) DeleteWorkflowCalls ¶
func (mock *WorkflowServiceClientMock) DeleteWorkflowCalls() []struct { Ctx context.Context In *GetRequest Opts []grpc.CallOption }
DeleteWorkflowCalls gets all the calls that were made to DeleteWorkflow. Check the length with:
len(mockedWorkflowServiceClient.DeleteWorkflowCalls())
func (*WorkflowServiceClientMock) GetWorkflow ¶
func (mock *WorkflowServiceClientMock) GetWorkflow(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*Workflow, error)
GetWorkflow calls GetWorkflowFunc.
func (*WorkflowServiceClientMock) GetWorkflowActions ¶
func (mock *WorkflowServiceClientMock) GetWorkflowActions(ctx context.Context, in *WorkflowActionsRequest, opts ...grpc.CallOption) (*WorkflowActionList, error)
GetWorkflowActions calls GetWorkflowActionsFunc.
func (*WorkflowServiceClientMock) GetWorkflowActionsCalls ¶
func (mock *WorkflowServiceClientMock) GetWorkflowActionsCalls() []struct { Ctx context.Context In *WorkflowActionsRequest Opts []grpc.CallOption }
GetWorkflowActionsCalls gets all the calls that were made to GetWorkflowActions. Check the length with:
len(mockedWorkflowServiceClient.GetWorkflowActionsCalls())
func (*WorkflowServiceClientMock) GetWorkflowCalls ¶
func (mock *WorkflowServiceClientMock) GetWorkflowCalls() []struct { Ctx context.Context In *GetRequest Opts []grpc.CallOption }
GetWorkflowCalls gets all the calls that were made to GetWorkflow. Check the length with:
len(mockedWorkflowServiceClient.GetWorkflowCalls())
func (*WorkflowServiceClientMock) GetWorkflowContext ¶
func (mock *WorkflowServiceClientMock) GetWorkflowContext(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*WorkflowContext, error)
GetWorkflowContext calls GetWorkflowContextFunc.
func (*WorkflowServiceClientMock) GetWorkflowContextCalls ¶
func (mock *WorkflowServiceClientMock) GetWorkflowContextCalls() []struct { Ctx context.Context In *GetRequest Opts []grpc.CallOption }
GetWorkflowContextCalls gets all the calls that were made to GetWorkflowContext. Check the length with:
len(mockedWorkflowServiceClient.GetWorkflowContextCalls())
func (*WorkflowServiceClientMock) GetWorkflowContextList ¶
func (mock *WorkflowServiceClientMock) GetWorkflowContextList(ctx context.Context, in *WorkflowContextRequest, opts ...grpc.CallOption) (*WorkflowContextList, error)
GetWorkflowContextList calls GetWorkflowContextListFunc.
func (*WorkflowServiceClientMock) GetWorkflowContextListCalls ¶
func (mock *WorkflowServiceClientMock) GetWorkflowContextListCalls() []struct { Ctx context.Context In *WorkflowContextRequest Opts []grpc.CallOption }
GetWorkflowContextListCalls gets all the calls that were made to GetWorkflowContextList. Check the length with:
len(mockedWorkflowServiceClient.GetWorkflowContextListCalls())
func (*WorkflowServiceClientMock) GetWorkflowContexts ¶
func (mock *WorkflowServiceClientMock) GetWorkflowContexts(ctx context.Context, in *WorkflowContextRequest, opts ...grpc.CallOption) (WorkflowService_GetWorkflowContextsClient, error)
GetWorkflowContexts calls GetWorkflowContextsFunc.
func (*WorkflowServiceClientMock) GetWorkflowContextsCalls ¶
func (mock *WorkflowServiceClientMock) GetWorkflowContextsCalls() []struct { Ctx context.Context In *WorkflowContextRequest Opts []grpc.CallOption }
GetWorkflowContextsCalls gets all the calls that were made to GetWorkflowContexts. Check the length with:
len(mockedWorkflowServiceClient.GetWorkflowContextsCalls())
func (*WorkflowServiceClientMock) GetWorkflowData ¶
func (mock *WorkflowServiceClientMock) GetWorkflowData(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error)
GetWorkflowData calls GetWorkflowDataFunc.
func (*WorkflowServiceClientMock) GetWorkflowDataCalls ¶
func (mock *WorkflowServiceClientMock) GetWorkflowDataCalls() []struct { Ctx context.Context In *GetWorkflowDataRequest Opts []grpc.CallOption }
GetWorkflowDataCalls gets all the calls that were made to GetWorkflowData. Check the length with:
len(mockedWorkflowServiceClient.GetWorkflowDataCalls())
func (*WorkflowServiceClientMock) GetWorkflowDataVersion ¶
func (mock *WorkflowServiceClientMock) GetWorkflowDataVersion(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error)
GetWorkflowDataVersion calls GetWorkflowDataVersionFunc.
func (*WorkflowServiceClientMock) GetWorkflowDataVersionCalls ¶
func (mock *WorkflowServiceClientMock) GetWorkflowDataVersionCalls() []struct { Ctx context.Context In *GetWorkflowDataRequest Opts []grpc.CallOption }
GetWorkflowDataVersionCalls gets all the calls that were made to GetWorkflowDataVersion. Check the length with:
len(mockedWorkflowServiceClient.GetWorkflowDataVersionCalls())
func (*WorkflowServiceClientMock) GetWorkflowMetadata ¶
func (mock *WorkflowServiceClientMock) GetWorkflowMetadata(ctx context.Context, in *GetWorkflowDataRequest, opts ...grpc.CallOption) (*GetWorkflowDataResponse, error)
GetWorkflowMetadata calls GetWorkflowMetadataFunc.
func (*WorkflowServiceClientMock) GetWorkflowMetadataCalls ¶
func (mock *WorkflowServiceClientMock) GetWorkflowMetadataCalls() []struct { Ctx context.Context In *GetWorkflowDataRequest Opts []grpc.CallOption }
GetWorkflowMetadataCalls gets all the calls that were made to GetWorkflowMetadata. Check the length with:
len(mockedWorkflowServiceClient.GetWorkflowMetadataCalls())
func (*WorkflowServiceClientMock) ListWorkflows ¶
func (mock *WorkflowServiceClientMock) ListWorkflows(ctx context.Context, in *Empty, opts ...grpc.CallOption) (WorkflowService_ListWorkflowsClient, error)
ListWorkflows calls ListWorkflowsFunc.
func (*WorkflowServiceClientMock) ListWorkflowsCalls ¶
func (mock *WorkflowServiceClientMock) ListWorkflowsCalls() []struct { Ctx context.Context In *Empty Opts []grpc.CallOption }
ListWorkflowsCalls gets all the calls that were made to ListWorkflows. Check the length with:
len(mockedWorkflowServiceClient.ListWorkflowsCalls())
func (*WorkflowServiceClientMock) ReportActionStatus ¶
func (mock *WorkflowServiceClientMock) ReportActionStatus(ctx context.Context, in *WorkflowActionStatus, opts ...grpc.CallOption) (*Empty, error)
ReportActionStatus calls ReportActionStatusFunc.
func (*WorkflowServiceClientMock) ReportActionStatusCalls ¶
func (mock *WorkflowServiceClientMock) ReportActionStatusCalls() []struct { Ctx context.Context In *WorkflowActionStatus Opts []grpc.CallOption }
ReportActionStatusCalls gets all the calls that were made to ReportActionStatus. Check the length with:
len(mockedWorkflowServiceClient.ReportActionStatusCalls())
func (*WorkflowServiceClientMock) ShowWorkflowEvents ¶
func (mock *WorkflowServiceClientMock) ShowWorkflowEvents(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (WorkflowService_ShowWorkflowEventsClient, error)
ShowWorkflowEvents calls ShowWorkflowEventsFunc.
func (*WorkflowServiceClientMock) ShowWorkflowEventsCalls ¶
func (mock *WorkflowServiceClientMock) ShowWorkflowEventsCalls() []struct { Ctx context.Context In *GetRequest Opts []grpc.CallOption }
ShowWorkflowEventsCalls gets all the calls that were made to ShowWorkflowEvents. Check the length with:
len(mockedWorkflowServiceClient.ShowWorkflowEventsCalls())
func (*WorkflowServiceClientMock) UpdateWorkflowData ¶
func (mock *WorkflowServiceClientMock) UpdateWorkflowData(ctx context.Context, in *UpdateWorkflowDataRequest, opts ...grpc.CallOption) (*Empty, error)
UpdateWorkflowData calls UpdateWorkflowDataFunc.
func (*WorkflowServiceClientMock) UpdateWorkflowDataCalls ¶
func (mock *WorkflowServiceClientMock) UpdateWorkflowDataCalls() []struct { Ctx context.Context In *UpdateWorkflowDataRequest Opts []grpc.CallOption }
UpdateWorkflowDataCalls gets all the calls that were made to UpdateWorkflowData. Check the length with:
len(mockedWorkflowServiceClient.UpdateWorkflowDataCalls())
type WorkflowServiceServer ¶
type WorkflowServiceServer interface { // // CreateWorkflow targets a specific hardware and it starts from a particular // template. The selected hardware is capable of picking the // workflow up for execution. CreateWorkflow(context.Context, *CreateRequest) (*CreateResponse, error) // // GetWorkflow returns a specific workflow by its identifier. GetWorkflow(context.Context, *GetRequest) (*Workflow, error) // // DeleteWorkflow deletes a workflow. This is a logical deletion. Workflow // will stay available for inspection DeleteWorkflow(context.Context, *GetRequest) (*Empty, error) // // ListWorkflows returns a list of workflows ListWorkflows(*Empty, WorkflowService_ListWorkflowsServer) error // // GetWorkflowContext returns specific information about where it is running, // its state and so on. Useful to debug a workflow and to understand its // current state. GetWorkflowContext(context.Context, *GetRequest) (*WorkflowContext, error) // // ShowWorkflowEvents returns a list of events for a specific workflows ShowWorkflowEvents(*GetRequest, WorkflowService_ShowWorkflowEventsServer) error GetWorkflowContextList(context.Context, *WorkflowContextRequest) (*WorkflowContextList, error) GetWorkflowContexts(*WorkflowContextRequest, WorkflowService_GetWorkflowContextsServer) error GetWorkflowActions(context.Context, *WorkflowActionsRequest) (*WorkflowActionList, error) ReportActionStatus(context.Context, *WorkflowActionStatus) (*Empty, error) GetWorkflowData(context.Context, *GetWorkflowDataRequest) (*GetWorkflowDataResponse, error) GetWorkflowMetadata(context.Context, *GetWorkflowDataRequest) (*GetWorkflowDataResponse, error) GetWorkflowDataVersion(context.Context, *GetWorkflowDataRequest) (*GetWorkflowDataResponse, error) UpdateWorkflowData(context.Context, *UpdateWorkflowDataRequest) (*Empty, error) }
WorkflowServiceServer is the server API for WorkflowService service.
type WorkflowService_GetWorkflowContextsClient ¶
type WorkflowService_GetWorkflowContextsClient interface { Recv() (*WorkflowContext, error) grpc.ClientStream }
type WorkflowService_GetWorkflowContextsServer ¶
type WorkflowService_GetWorkflowContextsServer interface { Send(*WorkflowContext) error grpc.ServerStream }
type WorkflowService_ListWorkflowsClient ¶
type WorkflowService_ListWorkflowsClient interface { Recv() (*Workflow, error) grpc.ClientStream }
type WorkflowService_ListWorkflowsClientMock ¶
type WorkflowService_ListWorkflowsClientMock struct { // CloseSendFunc mocks the CloseSend method. CloseSendFunc func() error // ContextFunc mocks the Context method. ContextFunc func() context.Context // HeaderFunc mocks the Header method. HeaderFunc func() (metadata.MD, error) // RecvFunc mocks the Recv method. RecvFunc func() (*Workflow, error) // RecvMsgFunc mocks the RecvMsg method. RecvMsgFunc func(m interface{}) error // SendMsgFunc mocks the SendMsg method. SendMsgFunc func(m interface{}) error // TrailerFunc mocks the Trailer method. TrailerFunc func() metadata.MD // contains filtered or unexported fields }
WorkflowService_ListWorkflowsClientMock is a mock implementation of WorkflowService_ListWorkflowsClient.
func TestSomethingThatUsesWorkflowService_ListWorkflowsClient(t *testing.T) { // make and configure a mocked WorkflowService_ListWorkflowsClient mockedWorkflowService_ListWorkflowsClient := &WorkflowService_ListWorkflowsClientMock{ CloseSendFunc: func() error { panic("mock out the CloseSend method") }, ContextFunc: func() context.Context { panic("mock out the Context method") }, HeaderFunc: func() (metadata.MD, error) { panic("mock out the Header method") }, RecvFunc: func() (*Workflow, error) { panic("mock out the Recv method") }, RecvMsgFunc: func(m interface{}) error { panic("mock out the RecvMsg method") }, SendMsgFunc: func(m interface{}) error { panic("mock out the SendMsg method") }, TrailerFunc: func() metadata.MD { panic("mock out the Trailer method") }, } // use mockedWorkflowService_ListWorkflowsClient in code that requires WorkflowService_ListWorkflowsClient // and then make assertions. }
func (*WorkflowService_ListWorkflowsClientMock) CloseSend ¶
func (mock *WorkflowService_ListWorkflowsClientMock) CloseSend() error
CloseSend calls CloseSendFunc.
func (*WorkflowService_ListWorkflowsClientMock) CloseSendCalls ¶
func (mock *WorkflowService_ListWorkflowsClientMock) CloseSendCalls() []struct { }
CloseSendCalls gets all the calls that were made to CloseSend. Check the length with:
len(mockedWorkflowService_ListWorkflowsClient.CloseSendCalls())
func (*WorkflowService_ListWorkflowsClientMock) Context ¶
func (mock *WorkflowService_ListWorkflowsClientMock) Context() context.Context
Context calls ContextFunc.
func (*WorkflowService_ListWorkflowsClientMock) ContextCalls ¶
func (mock *WorkflowService_ListWorkflowsClientMock) ContextCalls() []struct { }
ContextCalls gets all the calls that were made to Context. Check the length with:
len(mockedWorkflowService_ListWorkflowsClient.ContextCalls())
func (*WorkflowService_ListWorkflowsClientMock) Header ¶
func (mock *WorkflowService_ListWorkflowsClientMock) Header() (metadata.MD, error)
Header calls HeaderFunc.
func (*WorkflowService_ListWorkflowsClientMock) HeaderCalls ¶
func (mock *WorkflowService_ListWorkflowsClientMock) HeaderCalls() []struct { }
HeaderCalls gets all the calls that were made to Header. Check the length with:
len(mockedWorkflowService_ListWorkflowsClient.HeaderCalls())
func (*WorkflowService_ListWorkflowsClientMock) Recv ¶
func (mock *WorkflowService_ListWorkflowsClientMock) Recv() (*Workflow, error)
Recv calls RecvFunc.
func (*WorkflowService_ListWorkflowsClientMock) RecvCalls ¶
func (mock *WorkflowService_ListWorkflowsClientMock) RecvCalls() []struct { }
RecvCalls gets all the calls that were made to Recv. Check the length with:
len(mockedWorkflowService_ListWorkflowsClient.RecvCalls())
func (*WorkflowService_ListWorkflowsClientMock) RecvMsg ¶
func (mock *WorkflowService_ListWorkflowsClientMock) RecvMsg(m interface{}) error
RecvMsg calls RecvMsgFunc.
func (*WorkflowService_ListWorkflowsClientMock) RecvMsgCalls ¶
func (mock *WorkflowService_ListWorkflowsClientMock) RecvMsgCalls() []struct { M interface{} }
RecvMsgCalls gets all the calls that were made to RecvMsg. Check the length with:
len(mockedWorkflowService_ListWorkflowsClient.RecvMsgCalls())
func (*WorkflowService_ListWorkflowsClientMock) SendMsg ¶
func (mock *WorkflowService_ListWorkflowsClientMock) SendMsg(m interface{}) error
SendMsg calls SendMsgFunc.
func (*WorkflowService_ListWorkflowsClientMock) SendMsgCalls ¶
func (mock *WorkflowService_ListWorkflowsClientMock) SendMsgCalls() []struct { M interface{} }
SendMsgCalls gets all the calls that were made to SendMsg. Check the length with:
len(mockedWorkflowService_ListWorkflowsClient.SendMsgCalls())
func (*WorkflowService_ListWorkflowsClientMock) Trailer ¶
func (mock *WorkflowService_ListWorkflowsClientMock) Trailer() metadata.MD
Trailer calls TrailerFunc.
func (*WorkflowService_ListWorkflowsClientMock) TrailerCalls ¶
func (mock *WorkflowService_ListWorkflowsClientMock) TrailerCalls() []struct { }
TrailerCalls gets all the calls that were made to Trailer. Check the length with:
len(mockedWorkflowService_ListWorkflowsClient.TrailerCalls())
type WorkflowService_ListWorkflowsServer ¶
type WorkflowService_ListWorkflowsServer interface { Send(*Workflow) error grpc.ServerStream }
type WorkflowService_ShowWorkflowEventsClient ¶
type WorkflowService_ShowWorkflowEventsClient interface { Recv() (*WorkflowActionStatus, error) grpc.ClientStream }
type WorkflowService_ShowWorkflowEventsServer ¶
type WorkflowService_ShowWorkflowEventsServer interface { Send(*WorkflowActionStatus) error grpc.ServerStream }