client

Documentation

Overview

Package client implements Task Execution Service API for requesting servers.

Index

• func CancelTask(host, id string) error
• func DisableNode(host, id string, cancel bool) error
• func EnableNode(host string, n *models.Node) (id string, err error)
• func GetTask(host, id string, view models.View) (*models.Task, error)
• func ListNodes(host string, onlyActive bool) ([]*models.Node, error)
• func ListTasks(host string, pageSize int, pageToken string, view models.View, nodes []string, ...) (*models.ListTasksResponse, error)

Functions

func CancelTask

func CancelTask(host, id string) error

CancelTask cancels task by its ID.

func DisableNode

func DisableNode(host, id string, cancel bool) error

DisableNode disables worker node. cancel tells server to cancel running tasks in the worker node and enqueue those tasks.

func EnableNode

func EnableNode(host string, n *models.Node) (id string, err error)

EnableNode enables worker node at main server returning its ID.

func GetTask

func GetTask(host, id string, view models.View) (*models.Task, error)

GetTask retrieves task information given its ID.

func ListNodes

func ListNodes(host string, onlyActive bool) ([]*models.Node, error)

ListNodes retrieves all worker nodes.

func ListTasks

func ListTasks(host string, pageSize int, pageToken string, view models.View, nodes []string, states []models.State) (*models.ListTasksResponse, error)

ListTasks retrieves tasks from server that matches worker nodes and task states. Pagination is done via pageSize and pageToken parameters. view defines task fields to be returned.

Minimal returns only task ID and state.

Basic returns all fields except Logs.ExecutorLogs.Stdout, Logs.ExecutorLogs.Stderr, Inputs.Content and Logs.SystemLogs.

Full returns all fields.