dashboardtypes

Documentation

Index

• Variables
• func StripSnapshot(snapshot *steampipecloud.WorkspaceSnapshotData) error
• type DashboardNodeParent
• type DashboardNodeRun
• type DashboardRunStatus
• type LeafData
  • func NewLeafData(result *queryresult.SyncQueryResult) *LeafData
• type ResolvedRuntimeDependencyValue
• type SnapshotPanel
• type SnapshotTreeNode
• type SteampipeSnapshot
  • func (s *SteampipeSnapshot) AsCloudSnapshot() (*steampipecloud.WorkspaceSnapshotData, error)
  • func (s *SteampipeSnapshot) AsStrippedJson(indent bool) ([]byte, error)
  • func (*SteampipeSnapshot) IsExportSourceData()
• type WithResult

Variables

var SteampipeSnapshotSchemaVersion int64 = 20220929

Functions

func StripSnapshot

func StripSnapshot(snapshot *steampipecloud.WorkspaceSnapshotData) error

Types

type DashboardNodeParent

type DashboardNodeParent interface {
	GetName() string
	ChildCompleteChan() chan DashboardNodeRun
}

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

type DashboardNodeRun

type DashboardNodeRun interface {
	Initialise(ctx context.Context)
	Execute(ctx context.Context)
	GetName() string
	GetTitle() string
	GetRunStatus() DashboardRunStatus
	SetError(context.Context, error)
	GetError() error
	SetComplete(context.Context)
	RunComplete() bool
	GetChildren() []DashboardNodeRun
	ChildrenComplete() bool
	GetInputsDependingOn(string) []string
	AsTreeNode() *SnapshotTreeNode
}

DashboardNodeRun is an interface implemented by all dashboard run nodes

type DashboardRunStatus

type DashboardRunStatus string

const (
	DashboardRunReady    DashboardRunStatus = "ready"
	DashboardRunComplete DashboardRunStatus = "complete"
	DashboardRunError    DashboardRunStatus = "error"
)

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 ResolvedRuntimeDependencyValue

type ResolvedRuntimeDependencyValue struct {
	Value any
	Error error
}

type SnapshotPanel

type SnapshotPanel interface {
	IsSnapshotPanel()
}

SnapshotPanel is an interface implemented by all nodes which are to be included in the Snapshot Panels map

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

type WithResult

type WithResult struct {
	*LeafData
	Error error
}