Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tilebox.com/llms.txt

Use this file to discover all available pages before exploring further.

type Task interface{}
Base interface for Tilebox workflows tasks. It doesn’t need to be identifiable or executable, but it can be both (see below).

​
Methods

Task.Execute(ctx context.Context) error
The entry point for the execution of the task. If not defined, the task can’t be registered with a task runner but can still be submitted. 
Task.Identifier() TaskIdentifier
Provides a user-defined task identifier. The identifier is used to uniquely identify the task and specify its version. If not defined, the task runner will generate an identifier for it using reflection.

​
JSON-serializable task

type SampleTask struct {
	Message      string
	Depth        int
	BranchFactor int
}
Optional task input parameters, defined as struct fields. Supported types are all types supported by json.Marshal.

​
Protobuf-serializable task

type SampleTask struct {
	examplesv1.SpawnWorkflowTreeTask
}
Task can also be defined as a protobuf message. An example using task protobuf messages can be found here. 
package helloworld

import (
	"context"
	"fmt"
	"github.com/tilebox/tilebox-go/workflows/v1"
)

type MyFirstTask struct{}

func (t *MyFirstTask) Execute(ctx context.Context) error {
	fmt.Println("Hello World!")
	return nil
}

func (t *MyFirstTask) Identifier() workflows.TaskIdentifier {
	return workflows.NewTaskIdentifier("tilebox.workflows.MyTask", "v3.2")
}

type MyFirstParameterizedTask struct {
	Name    string
	Greet   bool
	Data    map[string]string
}

func (t *MyFirstParameterizedTask) Execute(ctx context.Context) error {
	if t.Greet {
		fmt.Printf("Hello %s!\n", t.Name)
	}
	return nil
}