workflow

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

Index

• Variables
• type Workflow
  • func (*Workflow) Descriptor() ([]byte, []int)
  • func (*Workflow) ProtoMessage()
  • func (m *Workflow) Reset()
  • func (m *Workflow) String() string
• type WorkflowState
  • func (WorkflowState) EnumDescriptor() ([]byte, []int)
  • func (x WorkflowState) String() string

Variables

var WorkflowState_name = map[int32]string{
	0: "NotStarted",
	1: "Running",
	2: "Done",
}

var WorkflowState_value = map[string]int32{
	"NotStarted": 0,
	"Running":    1,
	"Done":       2,
}

Types

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) ProtoMessage

func (*Workflow) ProtoMessage()

func (*Workflow) Reset

func (m *Workflow) Reset()

func (*Workflow) String

func (m *Workflow) 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