marmot

package
v0.0.0-...-c5dc566 Latest Latest
Warning

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

 Go to latest Published: Sep 6, 2017 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package marmot is a generated protocol buffer package.

It is generated from these files: 

marmot.proto

It has these top-level messages: 

State
Timing
HashedData
Labor
Task
Sequence
Job
SubmitReq
SubmitResp
MonitorReq
MonitorResp
StartReq
StartResp
PauseReq
PauseResp
ResumeReq
ResumeResp
StopReq
StopResp
LaborFilter
LaborSearchReq
FetchLaborReq

Index

Constants

This section is empty.

Variables

View Source 
var Reasons_name = map[int32]string{
	0: "NO_FAILURE",
	1: "PRE_CHECK_FAILURE",
	2: "CONT_CHECK_FAILURE",
	3: "MAX_FAILURES",
}
View Source 
var Reasons_value = map[string]int32{
	"NO_FAILURE":         0,
	"PRE_CHECK_FAILURE":  1,
	"CONT_CHECK_FAILURE": 2,
	"MAX_FAILURES":       3,
}
View Source 
var States_name = map[int32]string{
	0:  "UNKNOWN",
	1:  "NOT_STARTED",
	2:  "ADMIN_NOT_STARTED",
	3:  "RUNNING",
	4:  "PAUSING",
	5:  "PAUSED",
	6:  "ADMIN_PAUSED",
	7:  "CRISIS_PAUSED",
	8:  "COMPLETED",
	9:  "FAILED",
	10: "STOPPING",
	11: "STOPPED",
}
View Source 
var States_value = map[string]int32{
	"UNKNOWN":           0,
	"NOT_STARTED":       1,
	"ADMIN_NOT_STARTED": 2,
	"RUNNING":           3,
	"PAUSING":           4,
	"PAUSED":            5,
	"ADMIN_PAUSED":      6,
	"CRISIS_PAUSED":     7,
	"COMPLETED":         8,
	"FAILED":            9,
	"STOPPING":          10,
	"STOPPED":           11,
}

Functions

func RegisterMarmotServiceServer 

func RegisterMarmotServiceServer(s *grpc.Server, srv MarmotServiceServer)

Types

type FetchLaborReq 

type FetchLaborReq struct {
	// The id of the Labor.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// Indicates if the data for the Labor should be included.
	Full bool `protobuf:"varint,2,opt,name=full" json:"full,omitempty"`
}

FetchLaborReq is used to retrieve a single Labor from the service.

func (*FetchLaborReq) Descriptor 

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

func (*FetchLaborReq) ProtoMessage 

func (*FetchLaborReq) ProtoMessage()

func (*FetchLaborReq) Reset 

func (m *FetchLaborReq) Reset()

func (*FetchLaborReq) String 

func (m *FetchLaborReq) String() string

type HashedData 

type HashedData struct {
}

HashedData holds

func (*HashedData) Descriptor 

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

func (*HashedData) ProtoMessage 

func (*HashedData) ProtoMessage()

func (*HashedData) Reset 

func (m *HashedData) Reset()

func (*HashedData) String 

func (m *HashedData) String() string

type Job 

type Job struct {
	// Private holds fields that are used by the client/server, not users
	// directly.
	Private *Job_Private `protobuf:"bytes,1,opt,name=private" json:"private,omitempty"`
	// A UUIDv4 identifier.  Cannot be set by the client.
	Id string `protobuf:"bytes,2,opt,name=id" json:"id,omitempty"`
	// The path to the plugin.
	Plugin string `protobuf:"bytes,3,opt,name=plugin" json:"plugin,omitempty"`
	// Description of what your attempting to do.
	Desc string `protobuf:"bytes,4,opt,name=desc" json:"desc,omitempty"`
	// Timeout is how long, in seconds, to wait for the Job to complete.  If not
	// set this defaults to 5 minutes.
	Timeout int64 `protobuf:"varint,5,opt,name=timeout" json:"timeout,omitempty"`
	// Timing includes information on various timing of operations.
	Timing *Timing `protobuf:"bytes,6,opt,name=timing" json:"timing,omitempty"`
	// State holds the current state of the Job.  This cannot be set by the
	// sender.
	State *State `protobuf:"bytes,7,opt,name=state" json:"state,omitempty"`
	// The arguments to send to the plugin.  Args are protocol buffer
	// version 3 in JSON format.
	Args string `protobuf:"bytes,8,opt,name=args" json:"args,omitempty"`
	// The result from the plugin.  Output is a protocol buffer version 3 in
	// JSON format.
	Output string `protobuf:"bytes,9,opt,name=Output" json:"Output,omitempty"`
	// This is how many times to retry if the initial attempt fails.
	Retries int64 `protobuf:"varint,10,opt,name=retries" json:"retries,omitempty"`
	// This is how long to wait, in seconds, before doing a retry.
	RetryDelay int64 `protobuf:"varint,11,opt,name=retry_delay,json=retryDelay" json:"retry_delay,omitempty"`
}

Job represents a plugin that will be executed.

func (*Job) Descriptor 

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

func (*Job) GetPrivate 

func (m *Job) GetPrivate() *Job_Private

func (*Job) GetState 

func (m *Job) GetState() *State

func (*Job) GetTiming 

func (m *Job) GetTiming() *Timing

func (*Job) ProtoMessage 

func (*Job) ProtoMessage()

func (*Job) Reset 

func (m *Job) Reset()

func (*Job) String 

func (m *Job) String() string

type Job_Private 

type Job_Private struct {
	// args_hash holds the hash to lookup the data for args in Labor.hashed_data.
	// This is used internally, where users can normally just look at .args.
	ArgsHash string `protobuf:"bytes,9,opt,name=args_hash,json=argsHash" json:"args_hash,omitempty"`
	// output_hash holds the hash to lookup the data for output in
	// Labor.hashed_data.  This is used internally, where users can normally
	// just look at .output.
	OutputHash string `protobuf:"bytes,10,opt,name=output_hash,json=outputHash" json:"output_hash,omitempty"`
}

func (*Job_Private) Descriptor 

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

func (*Job_Private) ProtoMessage 

func (*Job_Private) ProtoMessage()

func (*Job_Private) Reset 

func (m *Job_Private) Reset()

func (*Job_Private) String 

func (m *Job_Private) String() string

type Labor 

type Labor struct {
	// Private holds fields that are used by the client/server, not users
	// directly.
	Private *Labor_Private `protobuf:"bytes,1,opt,name=private" json:"private,omitempty"`
	// A UUIDv4 identifier.  Cannot be set by the client.
	Id string `protobuf:"bytes,2,opt,name=id" json:"id,omitempty"`
	// A UUIDv4 identifier.  This must be set by the client.  Prevents multiple
	// duplicate submissions in a multi-master environment.
	ClientId string `protobuf:"bytes,3,opt,name=client_id,json=clientId" json:"client_id,omitempty"`
	// Name is a descriptive name for the Labor.
	Name string `protobuf:"bytes,4,opt,name=name" json:"name,omitempty"`
	// Desc is a longer description of what the Labor is trying to accomplish.
	Desc string `protobuf:"bytes,5,opt,name=desc" json:"desc,omitempty"`
	// Tags provides a list of labels attached to the Labor.
	Tags []string `protobuf:"bytes,6,rep,name=tags" json:"tags,omitempty"`
	// Timing includes information on various timing of operations.
	Timing *Timing `protobuf:"bytes,7,opt,name=timing" json:"timing,omitempty"`
	// State holds the current state of the Labor.  This cannot be set by the
	// sender.
	State *State `protobuf:"bytes,8,opt,name=state" json:"state,omitempty"`
	// Tasks are sub-containers of a Labor.
	Tasks []*Task `protobuf:"bytes,9,rep,name=tasks" json:"tasks,omitempty"`
}

Labor is the top level container representing all the work to be done.

func (*Labor) Descriptor 

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

func (*Labor) GetPrivate 

func (m *Labor) GetPrivate() *Labor_Private

func (*Labor) GetState 

func (m *Labor) GetState() *State

func (*Labor) GetTasks 

func (m *Labor) GetTasks() []*Task

func (*Labor) GetTiming 

func (m *Labor) GetTiming() *Timing

func (*Labor) ProtoMessage 

func (*Labor) ProtoMessage()

func (*Labor) Reset 

func (m *Labor) Reset()

func (*Labor) String 

func (m *Labor) String() string

type LaborFilter 

type LaborFilter struct {
	// Statees returns objects that are currently at one the "states".
	// If empty, all states are included.
	States []States `protobuf:"varint,1,rep,packed,name=states,enum=marmot.States" json:"states,omitempty"`
	// Locates Labors starting with the string.
	NamePrefix string `protobuf:"bytes,2,opt,name=name_prefix,json=namePrefix" json:"name_prefix,omitempty"`
	// name_suffix locates Labors ending with the string.
	NameSuffix string `protobuf:"bytes,3,opt,name=name_suffix,json=nameSuffix" json:"name_suffix,omitempty"`
	// Matches any Labor that has any tag listed.
	Tags []string `protobuf:"bytes,4,rep,name=tags" json:"tags,omitempty"`
	// Includes only Labors that were submitted at or after submit_begin.
	// This is recorded in unix epoch seconds.
	SubmitBegin int64 `protobuf:"varint,5,opt,name=submit_begin,json=submitBegin" json:"submit_begin,omitempty"`
	// Only include an object which was submitted before submit_end.
	// This is recorded in unix epoch seconds.
	SubmitEnd int64 `protobuf:"varint,6,opt,name=submit_end,json=submitEnd" json:"submit_end,omitempty"`
}

LaborFilter is a search filter used for searching for Labors.

func (*LaborFilter) Descriptor 

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

func (*LaborFilter) ProtoMessage 

func (*LaborFilter) ProtoMessage()

func (*LaborFilter) Reset 

func (m *LaborFilter) Reset()

func (*LaborFilter) String 

func (m *LaborFilter) String() string

type LaborSearchReq 

type LaborSearchReq struct {
	// A filter for locating Labors.
	Filter *LaborFilter `protobuf:"bytes,1,opt,name=filter" json:"filter,omitempty"`
}

A request for searching out Labors meeting certain conditions.

func (*LaborSearchReq) Descriptor 

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

func (*LaborSearchReq) GetFilter 

func (m *LaborSearchReq) GetFilter() *LaborFilter

func (*LaborSearchReq) ProtoMessage 

func (*LaborSearchReq) ProtoMessage()

func (*LaborSearchReq) Reset 

func (m *LaborSearchReq) Reset()

func (*LaborSearchReq) String 

func (m *LaborSearchReq) String() string

type Labor_Private 

type Labor_Private struct {
}

func (*Labor_Private) Descriptor 

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

func (*Labor_Private) ProtoMessage 

func (*Labor_Private) ProtoMessage()

func (*Labor_Private) Reset 

func (m *Labor_Private) Reset()

func (*Labor_Private) String 

func (m *Labor_Private) String() string

type MarmotServiceClient 

type MarmotServiceClient interface {
	Submit(ctx context.Context, in *SubmitReq, opts ...grpc.CallOption) (*SubmitResp, error)
	Monitor(ctx context.Context, in *MonitorReq, opts ...grpc.CallOption) (MarmotService_MonitorClient, error)
	Start(ctx context.Context, in *StartReq, opts ...grpc.CallOption) (*StartResp, error)
	Pause(ctx context.Context, in *PauseReq, opts ...grpc.CallOption) (*PauseResp, error)
	Resume(ctx context.Context, in *ResumeReq, opts ...grpc.CallOption) (*ResumeResp, error)
	Stop(ctx context.Context, in *StopReq, opts ...grpc.CallOption) (*StopResp, error)
	SearchLabor(ctx context.Context, in *LaborSearchReq, opts ...grpc.CallOption) (MarmotService_SearchLaborClient, error)
	FetchLabor(ctx context.Context, in *FetchLaborReq, opts ...grpc.CallOption) (*Labor, error)
}

func NewMarmotServiceClient 

func NewMarmotServiceClient(cc *grpc.ClientConn) MarmotServiceClient

type MarmotServiceServer 

type MarmotServiceServer interface {
	Submit(context.Context, *SubmitReq) (*SubmitResp, error)
	Monitor(*MonitorReq, MarmotService_MonitorServer) error
	Start(context.Context, *StartReq) (*StartResp, error)
	Pause(context.Context, *PauseReq) (*PauseResp, error)
	Resume(context.Context, *ResumeReq) (*ResumeResp, error)
	Stop(context.Context, *StopReq) (*StopResp, error)
	SearchLabor(*LaborSearchReq, MarmotService_SearchLaborServer) error
	FetchLabor(context.Context, *FetchLaborReq) (*Labor, error)
}

type MarmotService_MonitorClient 

type MarmotService_MonitorClient interface {
	Recv() (*MonitorResp, error)
	grpc.ClientStream
}

type MarmotService_MonitorServer 

type MarmotService_MonitorServer interface {
	Send(*MonitorResp) error
	grpc.ServerStream
}

type MarmotService_SearchLaborClient 

type MarmotService_SearchLaborClient interface {
	Recv() (*Labor, error)
	grpc.ClientStream
}

type MarmotService_SearchLaborServer 

type MarmotService_SearchLaborServer interface {
	Send(*Labor) error
	grpc.ServerStream
}

type MonitorReq 

type MonitorReq struct {
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}

A request to monitor a Labor until it completes.

func (*MonitorReq) Descriptor 

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

func (*MonitorReq) ProtoMessage 

func (*MonitorReq) ProtoMessage()

func (*MonitorReq) Reset 

func (m *MonitorReq) Reset()

func (*MonitorReq) String 

func (m *MonitorReq) String() string

type MonitorResp 

type MonitorResp struct {
	// The Labor with only the state data (no Args or Output for Jobs).
	Labor *Labor `protobuf:"bytes,2,opt,name=labor" json:"labor,omitempty"`
}

A streaming response containing the Labor with only state data.

func (*MonitorResp) Descriptor 

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

func (*MonitorResp) GetLabor 

func (m *MonitorResp) GetLabor() *Labor

func (*MonitorResp) ProtoMessage 

func (*MonitorResp) ProtoMessage()

func (*MonitorResp) Reset 

func (m *MonitorResp) Reset()

func (*MonitorResp) String 

func (m *MonitorResp) String() string

type PauseReq 

type PauseReq struct {
	// The ID of the Labor to pause.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}

Request that a Labor is paused.

func (*PauseReq) Descriptor 

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

func (*PauseReq) ProtoMessage 

func (*PauseReq) ProtoMessage()

func (*PauseReq) Reset 

func (m *PauseReq) Reset()

func (*PauseReq) String 

func (m *PauseReq) String() string

type PauseResp 

type PauseResp struct {
}

The response to the request for Pause().

func (*PauseResp) Descriptor 

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

func (*PauseResp) ProtoMessage 

func (*PauseResp) ProtoMessage()

func (*PauseResp) Reset 

func (m *PauseResp) Reset()

func (*PauseResp) String 

func (m *PauseResp) String() string

type Reasons 

type Reasons int32

Reasons are reasons why a container failed. 

const (
	// Indicates that no failure occurred.
	Reasons_NO_FAILURE Reasons = 0
	// Indicates that a pre-check failed.
	Reasons_PRE_CHECK_FAILURE Reasons = 1
	// Indicates that a post-check failed.
	Reasons_CONT_CHECK_FAILURE Reasons = 2
	// Inidcates that a max failure occurred.
	Reasons_MAX_FAILURES Reasons = 3
)

func (Reasons) EnumDescriptor 

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

func (Reasons) String 

func (x Reasons) String() string

type ResumeReq 

type ResumeReq struct {
	// The ID of the Labor to unpause.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}

Request to unpause a Labor.

func (*ResumeReq) Descriptor 

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

func (*ResumeReq) ProtoMessage 

func (*ResumeReq) ProtoMessage()

func (*ResumeReq) Reset 

func (m *ResumeReq) Reset()

func (*ResumeReq) String 

func (m *ResumeReq) String() string

type ResumeResp 

type ResumeResp struct {
}

The response to the request for Resume().

func (*ResumeResp) Descriptor 

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

func (*ResumeResp) ProtoMessage 

func (*ResumeResp) ProtoMessage()

func (*ResumeResp) Reset 

func (m *ResumeResp) Reset()

func (*ResumeResp) String 

func (m *ResumeResp) String() string

type Sequence 

type Sequence struct {
	// Private holds fields that are used by the client/server, not users
	// directly.
	Private *Sequence_Private `protobuf:"bytes,1,opt,name=private" json:"private,omitempty"`
	// A UUIDv4 identifier.  Cannot be set by the client.
	Id string `protobuf:"bytes,2,opt,name=id" json:"id,omitempty"`
	// target is the name of what this sequence targets. This could be a device,
	// a service, a directory... whatever makes sense for whatever is being done.
	Target string `protobuf:"bytes,3,opt,name=target" json:"target,omitempty"`
	Desc   string `protobuf:"bytes,4,opt,name=desc" json:"desc,omitempty"`
	// Timing includes information on various timing of operations.
	Timing *Timing `protobuf:"bytes,5,opt,name=timing" json:"timing,omitempty"`
	// State holds the current state of the Sequence.  This cannot be set by the
	// sender.
	State *State `protobuf:"bytes,6,opt,name=state" json:"state,omitempty"`
	// Jobs is a set of Jobs to execute.
	Jobs []*Job `protobuf:"bytes,10,rep,name=jobs" json:"jobs,omitempty"`
}

A series of Jobs, usually targeted at a particular entity (device, cluster,...) A Sequence executes sequentially in the order the Jobs were added until either a Job fails or all Jobs complete.

func (*Sequence) Descriptor 

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

func (*Sequence) GetJobs 

func (m *Sequence) GetJobs() []*Job

func (*Sequence) GetPrivate 

func (m *Sequence) GetPrivate() *Sequence_Private

func (*Sequence) GetState 

func (m *Sequence) GetState() *State

func (*Sequence) GetTiming 

func (m *Sequence) GetTiming() *Timing

func (*Sequence) ProtoMessage 

func (*Sequence) ProtoMessage()

func (*Sequence) Reset 

func (m *Sequence) Reset()

func (*Sequence) String 

func (m *Sequence) String() string

type Sequence_Private 

type Sequence_Private struct {
}

func (*Sequence_Private) Descriptor 

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

func (*Sequence_Private) ProtoMessage 

func (*Sequence_Private) ProtoMessage()

func (*Sequence_Private) Reset 

func (m *Sequence_Private) Reset()

func (*Sequence_Private) String 

func (m *Sequence_Private) String() string

type StartReq 

type StartReq struct {
	// The ID of the Labor.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}

Used to start a Labor that was submitted without StartOnSubmit set.

func (*StartReq) Descriptor 

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

func (*StartReq) ProtoMessage 

func (*StartReq) ProtoMessage()

func (*StartReq) Reset 

func (m *StartReq) Reset()

func (*StartReq) String 

func (m *StartReq) String() string

type StartResp 

type StartResp struct {
}

The response to the request for Start().

func (*StartResp) Descriptor 

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

func (*StartResp) ProtoMessage 

func (*StartResp) ProtoMessage()

func (*StartResp) Reset 

func (m *StartResp) Reset()

func (*StartResp) String 

func (m *StartResp) String() string

type State 

type State struct {
	// State is the current state of a container.
	State States `protobuf:"varint,1,opt,name=state,enum=marmot.States" json:"state,omitempty"`
	// Reason is the reason for a failure.
	Reason Reasons `protobuf:"varint,2,opt,name=reason,enum=marmot.Reasons" json:"reason,omitempty"`
}

State represents the state of a container.

func (*State) Descriptor 

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

func (*State) ProtoMessage 

func (*State) ProtoMessage()

func (*State) Reset 

func (m *State) Reset()

func (*State) String 

func (m *State) String() string

type States 

type States int32

States represents the various states a container object can be in. 

const (
	States_UNKNOWN States = 0
	// NotStarted indicates that the object hasn't started execution.
	States_NOT_STARTED States = 1
	// AdminNotStarted indicates the Labor object was sent to the server, but
	// was not intended to run until started by an RPC or human.
	States_ADMIN_NOT_STARTED States = 2
	// Running indicates the object is currently executing.
	States_RUNNING States = 3
	// Pausing indicates the object is intending to pause execution.
	States_PAUSING States = 4
	// Paused indicates the object has paused execution.
	States_PAUSED States = 5
	// AdminPaused indicates that a human has paused execution.
	States_ADMIN_PAUSED States = 6
	// CrisisPaused indicates that the crisis service for emergency control has
	// paused execution.
	States_CRISIS_PAUSED States = 7
	// Completed indicates the object has completed execution successfully.
	States_COMPLETED States = 8
	// Failed indicates the object failed its execution.
	States_FAILED States = 9
	// Stopping indicates the object is attempting to stop.
	States_STOPPING States = 10
	// Stopped indicates the object's execution was stopped.
	States_STOPPED States = 11
)

func (States) EnumDescriptor 

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

func (States) String 

func (x States) String() string

type StopReq 

type StopReq struct {
	// The ID of the Labor to stop.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}

Request to stop a Labor.

func (*StopReq) Descriptor 

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

func (*StopReq) ProtoMessage 

func (*StopReq) ProtoMessage()

func (*StopReq) Reset 

func (m *StopReq) Reset()

func (*StopReq) String 

func (m *StopReq) String() string

type StopResp 

type StopResp struct {
}

The response to the request for Stop().

func (*StopResp) Descriptor 

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

func (*StopResp) ProtoMessage 

func (*StopResp) ProtoMessage()

func (*StopResp) Reset 

func (m *StopResp) Reset()

func (*StopResp) String 

func (m *StopResp) String() string

type SubmitReq 

type SubmitReq struct {
	// The Labor to process.
	Labor *Labor `protobuf:"bytes,1,opt,name=labor" json:"labor,omitempty"`
	// If set, will begin execution immediately.
	StartOnSubmit bool `protobuf:"varint,2,opt,name=StartOnSubmit" json:"StartOnSubmit,omitempty"`
}

A request to submit a Labor for processing.

func (*SubmitReq) Descriptor 

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

func (*SubmitReq) GetLabor 

func (m *SubmitReq) GetLabor() *Labor

func (*SubmitReq) ProtoMessage 

func (*SubmitReq) ProtoMessage()

func (*SubmitReq) Reset 

func (m *SubmitReq) Reset()

func (*SubmitReq) String 

func (m *SubmitReq) String() string

type SubmitResp 

type SubmitResp struct {
	// The UUIDv4 representing the Labor.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}

The response to a Submit().

func (*SubmitResp) Descriptor 

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

func (*SubmitResp) ProtoMessage 

func (*SubmitResp) ProtoMessage()

func (*SubmitResp) Reset 

func (m *SubmitResp) Reset()

func (*SubmitResp) String 

func (m *SubmitResp) String() string

type Task 

type Task struct {
	// Private holds fields that are used by the client/server, not users
	// directly.
	Private *Task_Private `protobuf:"bytes,1,opt,name=private" json:"private,omitempty"`
	// A UUIDv4 identifier.  Cannot be set by the client.
	Id string `protobuf:"bytes,2,opt,name=id" json:"id,omitempty"`
	// Name is a descriptive name for a Task.
	Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
	// Desc is a longer description of what the Task is trying to accomplish.
	Desc string `protobuf:"bytes,4,opt,name=desc" json:"desc,omitempty"`
	// Timing includes information on various timing of operations.
	Timing *Timing `protobuf:"bytes,5,opt,name=timing" json:"timing,omitempty"`
	// State holds the current state of the Task.  This cannot be set by the
	// sender.
	State *State `protobuf:"bytes,6,opt,name=state" json:"state,omitempty"`
	// The amount of failures, if exceeded, will cause
	// the Task to Fail.
	ToleratedFailures int64 `protobuf:"varint,7,opt,name=tolerated_failures,json=toleratedFailures" json:"tolerated_failures,omitempty"`
	// The amount of Sequences to execute in Tandem.
	Concurrency int64 `protobuf:"varint,8,opt,name=concurrency" json:"concurrency,omitempty"`
	//  How long to wait between the contChecks completing
	// and the next time to run the checks, in seconds.
	ContCheckInterval int64 `protobuf:"varint,9,opt,name=cont_check_interval,json=contCheckInterval" json:"cont_check_interval,omitempty"`
	// Indicates to pass the amount of failures that occurred in
	// this Task onto the next Task.  The next Task will start with that number
	// of failures instead of 0.
	PassFailures bool `protobuf:"varint,10,opt,name=pass_failures,json=passFailures" json:"pass_failures,omitempty"`
	// Jobs to run that act as pre-checks.  These Jobs run concurrently before
	// the sequences run and if any fail, the Task automatically fails.
	PreChecks []*Job `protobuf:"bytes,11,rep,name=pre_checks,json=preChecks" json:"pre_checks,omitempty"`
	// Jobs to run that act as both pre-checks and are run at cont_check_intervals
	// for the life of the Task.  If any Jobs fail, the Task fails.
	ContChecks []*Job `protobuf:"bytes,12,rep,name=cont_checks,json=contChecks" json:"cont_checks,omitempty"`
	// Sequences to run at the concurrency level set.
	Sequences []*Sequence `protobuf:"bytes,13,rep,name=sequences" json:"sequences,omitempty"`
}

Tasks represent a set of work that will be done as a group at a certain concurrency level with a certain failure tolerance. Tasks can be used divide sections of work from each other, such as canarying a change and the main block of changes. Or it could be used to divide up tasks with breaks of 30 minutes between each set, etc....

func (*Task) Descriptor 

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

func (*Task) GetContChecks 

func (m *Task) GetContChecks() []*Job

func (*Task) GetPreChecks 

func (m *Task) GetPreChecks() []*Job

func (*Task) GetPrivate 

func (m *Task) GetPrivate() *Task_Private

func (*Task) GetSequences 

func (m *Task) GetSequences() []*Sequence

func (*Task) GetState 

func (m *Task) GetState() *State

func (*Task) GetTiming 

func (m *Task) GetTiming() *Timing

func (*Task) ProtoMessage 

func (*Task) ProtoMessage()

func (*Task) Reset 

func (m *Task) Reset()

func (*Task) String 

func (m *Task) String() string

type Task_Private 

type Task_Private struct {
}

func (*Task_Private) Descriptor 

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

func (*Task_Private) ProtoMessage 

func (*Task_Private) ProtoMessage()

func (*Task_Private) Reset 

func (m *Task_Private) Reset()

func (*Task_Private) String 

func (m *Task_Private) String() string

type Timing 

type Timing struct {
	// Started is when the object started execution.
	Started int64 `protobuf:"varint,1,opt,name=Started" json:"Started,omitempty"`
	// Ended is when the object ended execution.
	Ended int64 `protobuf:"varint,2,opt,name=Ended" json:"Ended,omitempty"`
	// Submitted is when the object was added to the system.
	// Only valid for Labor objects.
	Submitted int64 `protobuf:"varint,3,opt,name=Submitted" json:"Submitted,omitempty"`
}

Timing describes when objects start and stop.

func (*Timing) Descriptor 

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

func (*Timing) ProtoMessage 

func (*Timing) ProtoMessage()

func (*Timing) Reset 

func (m *Timing) Reset()

func (*Timing) String 

func (m *Timing) String() string

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.