Documentation
¶
Index ¶
- Constants
- Variables
- func OutputError(ctx context.Context, err error)
- func OutputMessage(ctx context.Context, msg string)
- func OutputReady(ctx context.Context, msg string)
- func OutputWait(ctx context.Context, msg string)
- func OutputWarning(ctx context.Context, msg string)
- type AvailableDashboardsPayload
- type ClientRequest
- type ClientRequestDashboardPayload
- type ClientRequestPayload
- type ControlEventPayload
- type DashboardCLIMetadata
- type DashboardClientInfo
- type DashboardMetadata
- type DashboardMetadataPayload
- type DisplaySnapshotPayload
- type ErrorPayload
- type ExecutionCompletePayload
- type ExecutionErrorPayload
- type ExecutionStartedPayload
- type InputValuesClearedPayload
- type LeafNodeUpdatedPayload
- type ListenPort
- type ListenType
- type ModAvailableBenchmark
- type ModAvailableDashboard
- type ModMetadata
- type SearchPathMetadata
- type Server
- type ServerMetadata
- type ServerMetadataPayload
Constants ¶
View Source
const ( ListenTypeLocal ListenType = "local" ListenTypeNetwork ListenType = "network" DashboardServerDefaultPort int = 9033 )
Variables ¶
View Source
var ExecutionCompletePayloadSchemaVersion int64 = 20240607
View Source
var ExecutionStartedSchemaVersion int64 = 20240607
View Source
var LeafNodeUpdatedSchemaVersion int64 = 20240607
Functions ¶
func OutputError ¶
func OutputMessage ¶
func OutputReady ¶
func OutputWait ¶
func OutputWarning ¶
Types ¶
type AvailableDashboardsPayload ¶
type AvailableDashboardsPayload struct {
Action string `json:"action"`
Dashboards map[string]ModAvailableDashboard `json:"dashboards"`
Benchmarks map[string]ModAvailableBenchmark `json:"benchmarks"`
DetectionBenchmarks map[string]ModAvailableBenchmark `json:"detection_benchmarks"`
Snapshots map[string]string `json:"snapshots"`
}
type ClientRequest ¶
type ClientRequest struct {
Action string `json:"action"`
Payload ClientRequestPayload `json:"payload"`
}
type ClientRequestDashboardPayload ¶
type ClientRequestDashboardPayload struct {
FullName string `json:"full_name"`
}
type ClientRequestPayload ¶
type ClientRequestPayload struct {
Dashboard ClientRequestDashboardPayload `json:"dashboard"`
Inputs map[string]interface{} `json:"inputs"`
DateTimeRange utils.TimeRange `json:"datetime_range"`
ChangedInput string `json:"changed_input"`
SearchPath []string `json:"search_path"`
SearchPathPrefix []string `json:"search_path_prefix"`
}
func (*ClientRequestPayload) InputValues ¶
func (p *ClientRequestPayload) InputValues() *dashboardexecute.InputValues
type ControlEventPayload ¶
type ControlEventPayload struct {
Action string `json:"action"`
Control controlstatus.ControlRunStatusProvider `json:"control"`
Name string `json:"name"`
Progress *controlstatus.ControlProgress `json:"progress"`
ExecutionId string `json:"execution_id"`
Timestamp time.Time `json:"timestamp"`
}
type DashboardCLIMetadata ¶
type DashboardCLIMetadata struct {
Version string `json:"version,omitempty"`
}
type DashboardClientInfo ¶
type DashboardClientInfo struct {
Session *melody.Session
Dashboard *string
DashboardInputs *dashboardexecute.InputValues
}
type DashboardMetadata ¶
type DashboardMetadataPayload ¶
type DashboardMetadataPayload struct {
Action string `json:"action"`
Metadata DashboardMetadata `json:"metadata"`
}
type DisplaySnapshotPayload ¶
type DisplaySnapshotPayload struct {
Action string `json:"action"`
SchemaVersion string `json:"schema_version"`
// snapshot is a map here as we cannot deserialise SteampipeSnapshot into a struct
// (without custom deserialisation code) as the Panels property is an interface
Snapshot map[string]any `json:"snapshot"`
ExecutionId string `json:"execution_id"`
}
type ErrorPayload ¶
type ExecutionCompletePayload ¶
type ExecutionCompletePayload struct {
Action string `json:"action"`
SchemaVersion string `json:"schema_version"`
Snapshot *steampipeconfig.SteampipeSnapshot `json:"snapshot"`
ExecutionId string `json:"execution_id"`
}
type ExecutionErrorPayload ¶
type ExecutionStartedPayload ¶
type ExecutionStartedPayload struct {
SchemaVersion string `json:"schema_version"`
Action string `json:"action"`
ExecutionId string `json:"execution_id"`
Panels map[string]any `json:"panels"`
Layout *steampipeconfig.SnapshotTreeNode `json:"layout"`
Inputs map[string]interface{} `json:"inputs,omitempty"`
Variables map[string]string `json:"variables,omitempty"`
StartTime time.Time `json:"start_time"`
}
type LeafNodeUpdatedPayload ¶
type ListenPort ¶
type ListenPort int
func (ListenPort) IsValid ¶
func (lp ListenPort) IsValid() error
IsValid is a validator for ListenType known values
type ListenType ¶
type ListenType string
func (ListenType) IsValid ¶
func (lt ListenType) IsValid() error
IsValid is a validator for ListenType known values
type ModAvailableBenchmark ¶
type ModAvailableBenchmark struct {
Title string `json:"title,omitempty"`
FullName string `json:"full_name"`
ShortName string `json:"short_name"`
BenchmarkType string `json:"benchmark_type"`
Tags map[string]string `json:"tags"`
IsTopLevel bool `json:"is_top_level"`
Children []ModAvailableBenchmark `json:"children,omitempty"`
Trunks [][]string `json:"trunks"`
ModFullName string `json:"mod_full_name"`
}
type ModAvailableDashboard ¶
type ModMetadata ¶
type SearchPathMetadata ¶
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
func (*Server) HandleDashboardEvent ¶
func (s *Server) HandleDashboardEvent(ctx context.Context, event dashboardevents.DashboardEvent)
type ServerMetadata ¶
type ServerMetadata struct {
Mod *ModMetadata `json:"mod,omitempty"`
InstalledMods map[string]*ModMetadata `json:"installed_mods,omitempty"`
CLI DashboardCLIMetadata `json:"cli"`
Cloud *steampipeconfig.PipesMetadata `json:"cloud,omitempty"`
Telemetry string `json:"telemetry"`
SearchPath *SearchPathMetadata `json:"search_path"`
SupportsSearchPath bool `json:"supports_search_path"`
SupportsTimeRange bool `json:"supports_time_range"`
}
type ServerMetadataPayload ¶
type ServerMetadataPayload struct {
Action string `json:"action"`
Metadata ServerMetadata `json:"metadata"`
}
Click to show internal directories.
Click to hide internal directories.