-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
task.go
23 lines (18 loc) · 1.01 KB
/
task.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Copyright 2015, Google Inc. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package automation
import (
automationpb "github.com/youtube/vitess/go/vt/proto/automation"
)
// Task implementations can be executed by the scheduler.
type Task interface {
// Run executes the task using the key/values from parameters.
// "newTaskContainers" contains new tasks which the task can emit. They'll be inserted in the cluster operation directly after this task. It may be "nil".
// "output" may be empty. It contains any text which maybe must e.g. to debug the task or show it in the UI.
Run(parameters map[string]string) (newTaskContainers []*automationpb.TaskContainer, output string, err error)
// RequiredParameters() returns a list of parameter keys which must be provided as input for Run().
RequiredParameters() []string
// OptionalParameters() returns a list of parameter keys which are optional input for Run().
OptionalParameters() []string
}