workflow

package
Version: v2.1.1+incompatible Latest Latest
Warning

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

Go to latest
Published: May 22, 2017 License: BSD-3-Clause Imports: 3 Imported by: 0

Documentation

Overview

Package workflow is a generated protocol buffer package.

It is generated from these files:

workflow.proto

It has these top-level messages:

Workflow
WorkflowCheckpoint
Task

Index

Constants

This section is empty.

Variables

View Source
var TaskState_name = map[int32]string{
	0: "TaskNotStarted",
	1: "TaskRunning",
	2: "TaskDone",
}
View Source
var TaskState_value = map[string]int32{
	"TaskNotStarted": 0,
	"TaskRunning":    1,
	"TaskDone":       2,
}
View Source
var WorkflowState_name = map[int32]string{
	0: "NotStarted",
	1: "Running",
	2: "Done",
}
View Source
var WorkflowState_value = map[string]int32{
	"NotStarted": 0,
	"Running":    1,
	"Done":       2,
}

Functions

This section is empty.

Types

type Task

type Task struct {
	Id    string    `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	State TaskState `protobuf:"varint,2,opt,name=state,enum=workflow.TaskState" json:"state,omitempty"`
	// attributes includes the parameters the task needs.
	Attributes map[string]string `` /* 140-byte string literal not displayed */
	Error      string            `protobuf:"bytes,4,opt,name=error" json:"error,omitempty"`
}

func (*Task) Descriptor

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

func (*Task) GetAttributes

func (m *Task) GetAttributes() map[string]string

func (*Task) GetError

func (m *Task) GetError() string

func (*Task) GetId

func (m *Task) GetId() string

func (*Task) GetState

func (m *Task) GetState() TaskState

func (*Task) ProtoMessage

func (*Task) ProtoMessage()

func (*Task) Reset

func (m *Task) Reset()

func (*Task) String

func (m *Task) String() string

type TaskState

type TaskState int32
const (
	TaskState_TaskNotStarted TaskState = 0
	TaskState_TaskRunning    TaskState = 1
	TaskState_TaskDone       TaskState = 2
)

func (TaskState) EnumDescriptor

func (TaskState) EnumDescriptor() ([]byte, []int)

func (TaskState) String

func (x TaskState) String() string

type Workflow

type Workflow struct {
	// uuid is set when the workflow is created, and immutable after
	// that.
	Uuid string `protobuf:"bytes,1,opt,name=uuid" json:"uuid,omitempty"`
	// factory_name is set with the name of the factory that created the
	// job (and can also restart it). It is set at creation time, and
	// immutable after that.
	FactoryName string `protobuf:"bytes,2,opt,name=factory_name,json=factoryName" json:"factory_name,omitempty"`
	// name is the display name of the workflow.
	Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
	// state describes the state of the job. A job is created as
	// NotStarted, then the Workflow Manager picks it up and starts it,
	// switching it to Running (and populating 'start_time').  The
	// workflow can then fail over to a new Workflow Manager is
	// necessary, and still be in Running state.  When done, it goes to
	// Done, 'end_time' is populated, and 'error' is set if there was an
	// error.
	State WorkflowState `protobuf:"varint,4,opt,name=state,enum=workflow.WorkflowState" json:"state,omitempty"`
	// data is workflow-specific stored data. It is usually a binary
	// proto-encoded data structure. It can vary throughout the
	// execution of the workflow.  It will not change after the workflow
	// is Done.
	Data []byte `protobuf:"bytes,5,opt,name=data,proto3" json:"data,omitempty"`
	// error is set if the job finished with an error. This field only
	// makes sense if 'state' is Done.
	Error string `protobuf:"bytes,6,opt,name=error" json:"error,omitempty"`
	// start_time is set when the workflow manager starts a workflow for
	// the first time. This field only makes sense if 'state' is Running
	// or Done.
	StartTime int64 `protobuf:"varint,7,opt,name=start_time,json=startTime" json:"start_time,omitempty"`
	// end_time is set when the workflow is finished.
	// This field only makes sense if 'state' is Done.
	EndTime int64 `protobuf:"varint,8,opt,name=end_time,json=endTime" json:"end_time,omitempty"`
}

Workflow is the persisted state of a long-running workflow.

func (*Workflow) Descriptor

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

func (*Workflow) GetData

func (m *Workflow) GetData() []byte

func (*Workflow) GetEndTime

func (m *Workflow) GetEndTime() int64

func (*Workflow) GetError

func (m *Workflow) GetError() string

func (*Workflow) GetFactoryName

func (m *Workflow) GetFactoryName() string

func (*Workflow) GetName

func (m *Workflow) GetName() string

func (*Workflow) GetStartTime

func (m *Workflow) GetStartTime() int64

func (*Workflow) GetState

func (m *Workflow) GetState() WorkflowState

func (*Workflow) GetUuid

func (m *Workflow) GetUuid() string

func (*Workflow) ProtoMessage

func (*Workflow) ProtoMessage()

func (*Workflow) Reset

func (m *Workflow) Reset()

func (*Workflow) String

func (m *Workflow) String() string

type WorkflowCheckpoint

type WorkflowCheckpoint struct {
	// code_version is used to detect incompabilities between the version of the
	// running workflow and the one which wrote the checkpoint. If they don't
	// match, the workflow must not continue. The author of workflow must update
	// this variable in their implementation when incompabilities are introduced.
	CodeVersion int32 `protobuf:"varint,1,opt,name=code_version,json=codeVersion" json:"code_version,omitempty"`
	// Task is the data structure that stores the execution status and the
	// attributes of a task.
	Tasks map[string]*Task `` /* 130-byte string literal not displayed */
	// settings includes workflow specific data, e.g. the resharding workflow
	// would store the source shards and destination shards.
	Settings map[string]string `` /* 136-byte string literal not displayed */
}

func (*WorkflowCheckpoint) Descriptor

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

func (*WorkflowCheckpoint) GetCodeVersion

func (m *WorkflowCheckpoint) GetCodeVersion() int32

func (*WorkflowCheckpoint) GetSettings

func (m *WorkflowCheckpoint) GetSettings() map[string]string

func (*WorkflowCheckpoint) GetTasks

func (m *WorkflowCheckpoint) GetTasks() map[string]*Task

func (*WorkflowCheckpoint) ProtoMessage

func (*WorkflowCheckpoint) ProtoMessage()

func (*WorkflowCheckpoint) Reset

func (m *WorkflowCheckpoint) Reset()

func (*WorkflowCheckpoint) String

func (m *WorkflowCheckpoint) String() string

type WorkflowState

type WorkflowState int32

WorkflowState describes the state of a workflow. This constant should match the Node object described in web/vtctld2/src/app/workflows/node.ts as it is exposed as JSON to the Angular 2 web app.

const (
	WorkflowState_NotStarted WorkflowState = 0
	WorkflowState_Running    WorkflowState = 1
	WorkflowState_Done       WorkflowState = 2
)

func (WorkflowState) EnumDescriptor

func (WorkflowState) EnumDescriptor() ([]byte, []int)

func (WorkflowState) String

func (x WorkflowState) String() string

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL