execution

package

v6.0.0 Latest Latest Go to latest Published: Sep 28, 2026 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/steadybit/cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package execution implements the `execution` commands on experiment runs.

Index ¶

func AddProperty(ctx context.Context, c *platform.Client, o PropertyOptions) error
func Cancel(ctx context.Context, c *platform.Client, id int64) error
func Download(ctx context.Context, c *platform.Client, o DownloadOptions) error
func Fetch(ctx context.Context, c *platform.Client, id int64) (*output.Document, error)
func Get(ctx context.Context, c *platform.Client, o GetOptions) error
func Latest(ctx context.Context, c *platform.Client, key string) (int64, error)
func ListArtifacts(ctx context.Context, c *platform.Client, id int64, explicitType string) error
func SetProperty(ctx context.Context, c *platform.Client, o PropertyOptions) error
func Watch(ctx context.Context, c *platform.Client, o WatchOptions) error
type Artifact
- func Collect(run *jsyaml.Map) []Artifact
type DownloadOptions
type GetOptions
type PropertyOptions
type WatchOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddProperty ¶

func AddProperty(ctx context.Context, c *platform.Client, o PropertyOptions) error

func Cancel ¶

func Cancel(ctx context.Context, c *platform.Client, id int64) error

Cancel asks the platform to stop a run. A 202 means it is being stopped, a 200 that there was nothing left to cancel.

func Download ¶

func Download(ctx context.Context, c *platform.Client, o DownloadOptions) error

Download writes every selected artifact to <directory>/<target execution>/<artifact>: two targets of one step usually produce files of the same name.

func Fetch ¶

func Fetch(ctx context.Context, c *platform.Client, id int64) (*output.Document, error)

Fetch gets a run with its steps. The platform leaves the steps out unless asked, and with them every target execution and artifact.

func Get ¶

func Get(ctx context.Context, c *platform.Client, o GetOptions) error

func Latest ¶

func Latest(ctx context.Context, c *platform.Client, key string) (int64, error)

Latest is the most recent run of an experiment.

func ListArtifacts ¶

func ListArtifacts(ctx context.Context, c *platform.Client, id int64, explicitType string) error

func SetProperty ¶

func SetProperty(ctx context.Context, c *platform.Client, o PropertyOptions) error

func Watch ¶

func Watch(ctx context.Context, c *platform.Client, o WatchOptions) error

Watch shows a run as it progresses, until it ends: redrawn in place on a terminal, as a line per change otherwise. It only watches; stopping it leaves the run alone.

Types ¶

type Artifact ¶

type Artifact struct {
	Step              string `json:"step"`
	Target            string `json:"target"`
	TargetExecutionID string `json:"targetExecutionId"`
	ArtifactID        string `json:"artifactId"`
}

func Collect ¶

func Collect(run *jsyaml.Map) []Artifact

Collect gathers artifacts from the target executions of action steps, and of the actions a service validation step runs; the platform offers no listing of its own.

type DownloadOptions ¶

type DownloadOptions struct {
	ID                                   int64
	Artifact, TargetExecution, Directory string
	Output                               string
}

type GetOptions ¶

type GetOptions struct {
	ID         int64
	File, Type string
}

type PropertyOptions ¶

type PropertyOptions struct {
	ID     int64
	Key    string
	Values []string
	JSON   bool
}

type WatchOptions ¶

type WatchOptions struct {
	ID       int64
	Key      string
	Interval time.Duration
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL