-
Notifications
You must be signed in to change notification settings - Fork 4
/
task.go
35 lines (27 loc) · 1.4 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
24
25
26
27
28
29
30
31
32
33
34
35
/*
Copyright 2017 Google Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package automation
import (
automationpb "gopkg.in/src-d/go-vitess.v1/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
}