Documentation ¶
Index ¶
- Constants
- Variables
- func IsCloudWorkspaceIdentifier(name string) bool
- func StripSnapshot(snapshot *steampipecloud.WorkspaceSnapshotData) error
- type ActorMetadata
- type CloudMetadata
- type DependencyPathKey
- type ErrorsAndWarningsNotification
- type IdentityMetadata
- type MissingVariableError
- type PluginRemoveReport
- type PluginRemoveReports
- type PostgresNotification
- type PostgresNotificationType
- type SnapshotPanel
- type SnapshotTreeNode
- type SteampipeSnapshot
- type ValidationFailure
- type VariableValidationFailedError
- type WorkspaceMetadata
- type WorkspaceProfileLoader
Constants ¶
View Source
const PostgresNotificationStructVersion = 20230306
Variables ¶
View Source
var SteampipeSnapshotSchemaVersion int64 = 20240130
Functions ¶
func IsCloudWorkspaceIdentifier ¶
IsCloudWorkspaceIdentifier returns whether name is a cloud workspace identifier of the form: {identity_handle}/{workspace_handle},
func StripSnapshot ¶ added in v0.3.0
func StripSnapshot(snapshot *steampipecloud.WorkspaceSnapshotData) error
Types ¶
type ActorMetadata ¶
type CloudMetadata ¶
type CloudMetadata struct { Actor *ActorMetadata `json:"actor,omitempty"` Identity *IdentityMetadata `json:"identity,omitempty"` Workspace *WorkspaceMetadata `json:"workspace,omitempty"` ConnectionString string `json:"-"` }
type DependencyPathKey ¶
type DependencyPathKey string
DependencyPathKey is a string representation of a dependency path
- a set of mod dependencyPath values separated by '->'
e.g. local -> github.com/kaidaguerre/steampipe-mod-m1@v3.1.1 -> github.com/kaidaguerre/steampipe-mod-m2@v5.1.1
func NewDependencyPathKey ¶
func NewDependencyPathKey(dependencyPath ...string) DependencyPathKey
func (DependencyPathKey) GetParent ¶
func (k DependencyPathKey) GetParent() DependencyPathKey
func (DependencyPathKey) PathLength ¶
func (k DependencyPathKey) PathLength() int
how long is the depdency path
type ErrorsAndWarningsNotification ¶
type ErrorsAndWarningsNotification struct { PostgresNotification Errors []string Warnings []string }
func NewErrorsAndWarningsNotification ¶
func NewErrorsAndWarningsNotification(errorAndWarnings error_helpers.ErrorAndWarnings) *ErrorsAndWarningsNotification
type IdentityMetadata ¶
type MissingVariableError ¶
type MissingVariableError struct { MissingVariables []*modconfig.Variable MissingTransitiveVariables map[DependencyPathKey][]*modconfig.Variable // contains filtered or unexported fields }
func NewMissingVarsError ¶
func NewMissingVarsError(workspaceMod *modconfig.Mod) MissingVariableError
func (MissingVariableError) Error ¶
func (m MissingVariableError) Error() string
type PluginRemoveReport ¶
type PluginRemoveReport struct { Image *ociinstaller.SteampipeImageRef ShortName string Connections []*modconfig.Connection }
type PluginRemoveReports ¶
type PluginRemoveReports []PluginRemoveReport
func (PluginRemoveReports) Print ¶
func (r PluginRemoveReports) Print()
type PostgresNotification ¶
type PostgresNotification struct { StructVersion int Type PostgresNotificationType }
func NewSchemaUpdateNotification ¶
func NewSchemaUpdateNotification() *PostgresNotification
type PostgresNotificationType ¶
type PostgresNotificationType int
const ( PgNotificationSchemaUpdate PostgresNotificationType = iota + 1 PgNotificationConnectionError )
type SnapshotPanel ¶ added in v0.3.0
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 ¶ added in v0.3.0
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 ¶ added in v0.3.0
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 ¶ added in v0.3.0
func (s *SteampipeSnapshot) AsCloudSnapshot() (*steampipecloud.WorkspaceSnapshotData, error)
func (*SteampipeSnapshot) AsStrippedJson ¶ added in v0.3.0
func (s *SteampipeSnapshot) AsStrippedJson(indent bool) ([]byte, error)
func (*SteampipeSnapshot) IsExportSourceData ¶ added in v0.3.0
func (*SteampipeSnapshot) IsExportSourceData()
IsExportSourceData implements ExportSourceData
type ValidationFailure ¶
type ValidationFailure struct { Plugin string ConnectionName string Message string ShouldDropIfExists bool }
func (ValidationFailure) String ¶
func (v ValidationFailure) String() string
type VariableValidationFailedError ¶
type VariableValidationFailedError struct {
// contains filtered or unexported fields
}
func NewVariableValidationFailedError ¶
func NewVariableValidationFailedError(diags tfdiags.Diagnostics) VariableValidationFailedError
func (VariableValidationFailedError) Error ¶
func (m VariableValidationFailedError) Error() string
type WorkspaceMetadata ¶
type WorkspaceProfileLoader ¶
type WorkspaceProfileLoader[T modconfig.WorkspaceProfile] struct { DefaultProfile T ConfiguredProfile T // contains filtered or unexported fields }
func NewWorkspaceProfileLoader ¶
func NewWorkspaceProfileLoader[T modconfig.WorkspaceProfile](workspaceProfilePaths ...string) (*WorkspaceProfileLoader[T], error)
func (*WorkspaceProfileLoader[T]) GetActiveWorkspaceProfile ¶
func (l *WorkspaceProfileLoader[T]) GetActiveWorkspaceProfile() T
Click to show internal directories.
Click to hide internal directories.