client

Documentation

Index

• type Client
  • func New(dagStore persistence.DAGStore, historyStore persistence.HistoryStore, ...) Client
• type DAGStatus
• type DagListPaginationSummaryResult
• type RestartOptions
• type StartOptions

Types

type Client

type Client interface {
	CreateDAG(ctx context.Context, id string) (string, error)
	GetDAGSpec(ctx context.Context, id string) (string, error)
	Grep(ctx context.Context, pattern string) ([]*persistence.GrepResult, []string, error)
	Rename(ctx context.Context, oldID, newID string) error
	Stop(ctx context.Context, dag *digraph.DAG) error
	StartAsync(ctx context.Context, dag *digraph.DAG, opts StartOptions)
	Start(ctx context.Context, dag *digraph.DAG, opts StartOptions) error
	Restart(ctx context.Context, dag *digraph.DAG, opts RestartOptions) error
	Retry(ctx context.Context, dag *digraph.DAG, requestID string) error
	GetCurrentStatus(ctx context.Context, dag *digraph.DAG) (*model.Status, error)
	GetStatusByRequestID(ctx context.Context, dag *digraph.DAG, requestID string) (*model.Status, error)
	GetLatestStatus(ctx context.Context, dag *digraph.DAG) (model.Status, error)
	GetRecentHistory(ctx context.Context, dag *digraph.DAG, n int) []model.StatusFile
	UpdateStatus(ctx context.Context, dag *digraph.DAG, status model.Status) error
	UpdateDAG(ctx context.Context, id string, spec string) error
	DeleteDAG(ctx context.Context, id, loc string) error
	GetAllStatus(ctx context.Context) (statuses []DAGStatus, errs []string, err error)
	GetAllStatusPagination(ctx context.Context, params dags.ListDAGsParams) ([]DAGStatus, *DagListPaginationSummaryResult, error)
	GetStatus(ctx context.Context, dagLocation string) (DAGStatus, error)
	IsSuspended(ctx context.Context, id string) bool
	ToggleSuspend(ctx context.Context, id string, suspend bool) error
	GetTagList(ctx context.Context) ([]string, []string, error)
}

func New

func New(
	dagStore persistence.DAGStore,
	historyStore persistence.HistoryStore,
	flagStore persistence.FlagStore,
	executable string,
	workDir string,
) Client

New creates a new Client instance. The Client is used to interact with the DAG.

type DAGStatus

type DAGStatus struct {
	File      string
	Dir       string
	DAG       *digraph.DAG
	Status    model.Status
	Suspended bool
	Error     error
	ErrorT    *string
}

type DagListPaginationSummaryResult

type DagListPaginationSummaryResult struct {
	PageCount int
	ErrorList []string
}

type RestartOptions

type RestartOptions struct {
	Quiet bool
}

type StartOptions

type StartOptions struct {
	Params string
	Quiet  bool
}