dashboardtypes

Documentation

Index

• Variables
• func StripSnapshot(snapshot *steampipecloud.WorkspaceSnapshotData) error
• type DashboardParent
• type DashboardTreeRun
• type LeafData
  • func NewLeafData(result *queryresult.SyncQueryResult) *LeafData
• type ResolvedRuntimeDependency
  • func NewResolvedRuntimeDependency(dep *modconfig.RuntimeDependency, ...) *ResolvedRuntimeDependency
  • func (d *ResolvedRuntimeDependency) IsResolved() bool
  • func (d *ResolvedRuntimeDependency) Resolve() error
  • func (d *ResolvedRuntimeDependency) ScopedName() string
• type ResolvedRuntimeDependencyValue
• type RunStatus
  • func (s RunStatus) IsError() bool
  • func (s RunStatus) IsFinished() bool
• type SnapshotPanel
• type SnapshotTreeNode
• type SteampipeSnapshot
  • func (s *SteampipeSnapshot) AsCloudSnapshot() (*steampipecloud.WorkspaceSnapshotData, error)
  • func (s *SteampipeSnapshot) AsStrippedJson(indent bool) ([]byte, error)
  • func (*SteampipeSnapshot) IsExportSourceData()

Variables

var SteampipeSnapshotSchemaVersion int64 = 20221222

Functions

func StripSnapshot

func StripSnapshot(snapshot *steampipecloud.WorkspaceSnapshotData) error

Types

type DashboardParent

type DashboardParent interface {
	DashboardTreeRun
	GetName() string
	ChildCompleteChan() chan DashboardTreeRun
	GetChildren() []DashboardTreeRun
	ChildrenComplete() bool
	ChildStatusChanged(context.Context)
}

DashboardParent is an interface implemented by all dashboard run nodes which have children

type DashboardTreeRun

type DashboardTreeRun interface {
	Initialise(ctx context.Context)
	Execute(ctx context.Context)
	GetName() string
	GetTitle() string
	GetRunStatus() RunStatus
	SetError(context.Context, error)
	GetError() error
	GetParent() DashboardParent
	SetComplete(context.Context)
	RunComplete() bool
	GetInputsDependingOn(string) []string
	GetNodeType() string
	AsTreeNode() *SnapshotTreeNode
	GetResource() modconfig.DashboardLeafNode
}

DashboardTreeRun is an interface implemented by all dashboard run nodes

type LeafData

type LeafData struct {
	Columns []*queryresult.ColumnDef `json:"columns"`
	Rows    []map[string]interface{} `json:"rows"`
}

func NewLeafData

func NewLeafData(result *queryresult.SyncQueryResult) *LeafData

type ResolvedRuntimeDependency

type ResolvedRuntimeDependency struct {
	Dependency *modconfig.RuntimeDependency

	Value any
	// contains filtered or unexported fields
}

ResolvedRuntimeDependency is a wrapper for RuntimeDependency which contains the resolved value we must wrap it so that we do not mutate the underlying workspace data when resolving dependency values

func NewResolvedRuntimeDependency

func NewResolvedRuntimeDependency(dep *modconfig.RuntimeDependency, valueChannel chan *ResolvedRuntimeDependencyValue, publisherName string) *ResolvedRuntimeDependency

func (*ResolvedRuntimeDependency) IsResolved

func (d *ResolvedRuntimeDependency) IsResolved() bool

func (*ResolvedRuntimeDependency) Resolve

func (d *ResolvedRuntimeDependency) Resolve() error

func (*ResolvedRuntimeDependency) ScopedName

func (d *ResolvedRuntimeDependency) ScopedName() string

ScopedName returns is a unique name for the dependency by prepending the publisher name this is used to uniquely identify which `with` is used - for the snapshot data

type ResolvedRuntimeDependencyValue

type ResolvedRuntimeDependencyValue struct {
	Value any
	Error error
}

type RunStatus

type RunStatus string

const (
	RunInitialized RunStatus = "initialized"
	RunBlocked     RunStatus = "blocked"
	RunRunning     RunStatus = "running"
	RunComplete    RunStatus = "complete"
	RunError       RunStatus = "error"
	RunCanceled    RunStatus = "canceled"
)

func (RunStatus) IsError

func (s RunStatus) IsError() bool

func (RunStatus) IsFinished

func (s RunStatus) IsFinished() bool

type SnapshotPanel

type SnapshotPanel interface {
	IsSnapshotPanel()
}

SnapshotPanel is an interface implemented by all nodes which are to be included in the Snapshot Panels map this consists of all 'Run' types - LeafRun, DashboardRun, etc.

type SnapshotTreeNode

type SnapshotTreeNode struct {
	Name     string              `json:"name"`
	Children []*SnapshotTreeNode `json:"children,omitempty"`
	NodeType string              `json:"panel_type"`
}

SnapshotTreeNode is a struct used to store the dashboard structure in the snapshot

type SteampipeSnapshot

type SteampipeSnapshot struct {
	SchemaVersion string                   `json:"schema_version"`
	Panels        map[string]SnapshotPanel `json:"panels"`
	Inputs        map[string]interface{}   `json:"inputs"`
	Variables     map[string]string        `json:"variables"`
	SearchPath    []string                 `json:"search_path"`
	StartTime     time.Time                `json:"start_time"`
	EndTime       time.Time                `json:"end_time"`
	Layout        *SnapshotTreeNode        `json:"layout"`
	FileNameRoot  string                   `json:"-"`
	Title         string                   `json:"-"`
}

func (*SteampipeSnapshot) AsCloudSnapshot

func (s *SteampipeSnapshot) AsCloudSnapshot() (*steampipecloud.WorkspaceSnapshotData, error)

func (*SteampipeSnapshot) AsStrippedJson

func (s *SteampipeSnapshot) AsStrippedJson(indent bool) ([]byte, error)

func (*SteampipeSnapshot) IsExportSourceData

func (*SteampipeSnapshot) IsExportSourceData()

IsExportSourceData implements ExportSourceData