describe

Documentation

Overview

Package describe implements the `iter8ctl describe` subcommand.

Index

• type Result
  • func Builder() *Result
  • func (d *Result) Error() error
  • func (d *Result) FromFile(path string) *Result
  • func (d *Result) PrintAnalysis() *Result
  • func (d *Result) WithExperiment(exp *expr.Experiment) *Result

Types

type Result

type Result struct {
	// contains filtered or unexported fields
}

Result struct contains fields that store intermediate results associated with an invocation of 'iter8ctl describe' subcommand.

func Builder

func Builder() *Result

Builder returns an initialized Cmd struct pointer. Builder enables the builder design pattern along with method chaining.

func (*Result) Error

func (d *Result) Error() error

Error returns any error generated during the invocation of Cmd methods, or nil if there are no errors.

func (*Result) FromFile

func (d *Result) FromFile(path string) *Result

FromFile populates the Result struct with an experiment from file.

func (*Result) PrintAnalysis

func (d *Result) PrintAnalysis() *Result

PrintAnalysis prints the progress of the iter8 experiment, winner assessment, version assessment, and metrics.

func (*Result) WithExperiment

func (d *Result) WithExperiment(exp *expr.Experiment) *Result

WithExperiment populates the Result struct with an experiment.