schema

Documentation

Index

• Constants
• Variables
• func IsValidResourceItemType(blockType string) bool

Constants

const (
	// require blocks
	BlockTypeSteampipe = "steampipe"
	BlockTypeMod       = "mod"
	BlockTypePlugin    = "plugin"
	// resource blocks
	BlockTypeQuery          = "query"
	BlockTypeControl        = "control"
	BlockTypeBenchmark      = "benchmark"
	BlockTypeDashboard      = "dashboard"
	BlockTypeContainer      = "container"
	BlockTypeChart          = "chart"
	BlockTypeCard           = "card"
	BlockTypeFlow           = "flow"
	BlockTypeGraph          = "graph"
	BlockTypeHierarchy      = "hierarchy"
	BlockTypeImage          = "image"
	BlockTypeInput          = "input"
	BlockTypeTable          = "table"
	BlockTypeText           = "text"
	BlockTypeLocals         = "locals"
	BlockTypeVariable       = "variable"
	BlockTypeParam          = "param"
	BlockTypeRequire        = "require"
	BlockTypeNode           = "node"
	BlockTypeEdge           = "edge"
	BlockTypeLegacyRequires = "requires"
	BlockTypeCategory       = "category"
	BlockTypeWith           = "with"
	BlockTypeError          = "error"

	// config blocks
	BlockTypeRateLimiter       = "limiter"
	BlockTypeConnection        = "connection"
	BlockTypeOptions           = "options"
	BlockTypeWorkspaceProfile  = "workspace"
	BlockTypePipeline          = "pipeline"
	BlockTypePipelineStep      = "step"
	BlockTypePipelineOutput    = "output"
	BlockTypeTrigger           = "trigger"
	BlockTypePipelineBasicAuth = "basic_auth"
	BlockTypeIntegration       = "integration"
	BlockTypeCredential        = "credential"
	BlockTypeCredentialImport  = "credential_import" //nolint:gosec // this is not a password
	BlockTypeNotify            = "notify"
	BlockTypeNotifier          = "notifier"
	BlockTypeLoop              = "loop"
	BlockTypeRetry             = "retry"
	BlockTypeThrow             = "throw"
	BlockTypeOption            = "option"
	BlockTypeCapture           = "capture"
	BlockTypeMethod            = "method"

	AttributeTypeValue = "value"

	AttributeTypeType    = "type"
	AttributeTypeDefault = "default"

	// Pipeline param block
	AttributeTypeOptional = "optional"

	// Pipeline blocks
	BlockTypePipelineStepHttp      = "http"
	BlockTypePipelineStepSleep     = "sleep"
	BlockTypePipelineStepEmail     = "email"
	BlockTypePipelineStepTransform = "transform"
	BlockTypePipelineStepQuery     = "query"
	BlockTypePipelineStepPipeline  = "pipeline"
	BlockTypePipelineStepFunction  = "function"
	BlockTypePipelineStepContainer = "container"
	BlockTypePipelineStepInput     = "input"
	BlockTypePipelineStepMessage   = "message"

	// error block
	AttributeTypeIgnore = "ignore"

	// Common step attributes
	AttributeTypeTitle       = "title"
	AttributeTypeDependsOn   = "depends_on"
	AttributeTypeForEach     = "for_each"
	AttributeTypeDescription = "description"
	AttributeTypeIf          = "if"
	AttributeTypeUsername    = "username"
	AttributeTypePassword    = "password"
	AttributeTypeStepName    = "step_name"
	AttributeTypeFlowpipe    = "flowpipe"

	AttributeTypeMaxAttempts = "max_attempts"
	AttributeTypeStrategy    = "strategy"
	AttributeTypeMinInterval = "min_interval"
	AttributeTypeMaxInterval = "max_interval"

	// pipeline attributes
	AttributeTypeTags            = "tags"
	AttributeTypeDocumentation   = "documentation"
	AttributeTypeUnqualifiedName = "unqualified_name"
	AttributeTypeName            = "name"
	AttributeTypeShortName       = "short_name"

	AttributeTypeStartedAt  = "started_at"
	AttributeTypeFinishedAt = "finished_at"

	// Used by query step
	AttributeTypeSql      = "sql"
	AttributeTypeArgs     = "args"
	AttributeTypeQuery    = "query"
	AttributeTypeRows     = "rows"
	AttributeTypeDatabase = "database"

	// Used by email step
	AttributeTypeBcc         = "bcc"
	AttributeTypeBody        = "body"
	AttributeTypeCc          = "cc"
	AttributeTypeContentType = "content_type"
	AttributeTypeFrom        = "from"
	AttributeTypeHost        = "host"
	AttributeTypePort        = "port"
	AttributeTypeSenderName  = "sender_name"
	AttributeTypeSubject     = "subject"
	AttributeTypeTo          = "to"

	AttributeTypeToken         = "token"
	AttributeTypeSigningSecret = "signing_secret"
	AttributeTypeWebhookUrl    = "webhook_url"

	AttributeTypeIntegration = "integration"
	AttributeTypeCredential  = "credential"

	AttributeTypeChannel = "channel"

	// Used by sleep step
	AttributeTypeDuration = "duration"

	// Used by http step
	AttributeTypeUrl             = "url"
	AttributeTypeMethod          = "method"
	AttributeTypeRequestBody     = "request_body"
	AttributeTypeRequestHeaders  = "request_headers"
	AttributeTypeCaCertPem       = "ca_cert_pem"
	AttributeTypeInsecure        = "insecure"
	AttributeTypeResponseHeaders = "response_headers"
	AttributeTypeResponseBody    = "response_body"
	AttributeTypeStatusCode      = "status_code"
	AttributeTypeStatus          = "status"

	// Used byy Pipeline step
	AttributeTypePipeline = "pipeline"

	// Used by input and message step
	AttributeTypeOptions      = "options"
	AttributeTypeResponseUrl  = "response_url"
	AttributeTypeSmtpHost     = "smtp_host"
	AttributeTypeSmtpPassword = "smtp_password"
	AttributeTypeSmtpPort     = "smtp_port"
	AttributeTypeSmtpServer   = "smtp_server"
	AttributeTypeSmtpTls      = "smtp_tls"
	AttributeTypeSmtpUsername = "smtp_username"
	AttributeTypeSmtpsPort    = "smtps_port"
	AttributeTypeLabel        = "label"
	AttributeTypeSelected     = "selected"
	AttributeTypeNotifier     = "notifier"
	AttributeTypeNotifies     = "notifies"
	AttributeTypeMarkdown     = "markdown"
	AttributeTypeStyle        = "style"

	AttributeTypeMessage = "message"

	// Functions attributes
	AttributeTypeRuntime  = "runtime"
	AttributeTypeEnv      = "env"
	AttributeTypeHandler  = "handler"
	AttributeTypeFunction = "function"
	AttributeTypeEvent    = "event"

	AttributeTypeImage             = "image"
	AttributeTypeSource            = "source"
	AttributeTypeUser              = "user"
	AttributeTypeWorkdir           = "workdir"
	AttributeTypeCmd               = "cmd"
	AttributeTypeEntryPoint        = "entrypoint"
	AttributeTypeTimeout           = "timeout"
	AttributeTypeMaxConcurrency    = "max_concurrency"
	AttributeTypeCpuShares         = "cpu_shares"
	AttributeTypeMemory            = "memory"
	AttributeTypeMemoryReservation = "memory_reservation"
	AttributeTypeMemorySwap        = "memory_swap"
	AttributeTypeMemorySwappiness  = "memory_swappiness"
	AttributeTypeReadOnly          = "read_only"
	AttributeTypeExitCode          = "exit_code"
	AttributeTypeContainerId       = "container_id"
	AttributeTypeStdout            = "stdout"
	AttributeTypeStderr            = "stderr"
	AttributeTypeLines             = "lines"
	AttributeTypeResult            = "result"

	// Trigger attributes
	AttributeTypeSchedule   = "schedule"
	AttributeTypePrimaryKey = "primary_key"
	AttributeTypeEnabled    = "enabled"

	// HTTP Trigger attributes
	AttributeTypeExecutionMode = "execution_mode"

	// Input step attributes
	AttributeTypePrompt    = "prompt"
	AttributeTypeSlackType = "slack_type"
	AttributeTypeText      = "text"

	// All Possible Trigger Types
	TriggerTypeSchedule = "schedule"
	TriggerTypeQuery    = "query"
	TriggerTypeHttp     = "http"

	// Integration Types
	IntegrationTypeSlack = "slack"
	IntegrationTypeEmail = "email"
	IntegrationTypeTeams = "teams"
	IntegrationTypeHttp  = "http"

	LabelName = "name"
	LabelType = "type"

	ResourceTypeSnapshot = "snapshot"
	AttributeArgs        = "args"
	AttributeQuery       = "query"

	AttributeVar   = "var"
	AttributeLocal = "local"

	AttributeEach = "each"
	AttributeKey  = "key"
)

NOTE: when adding a block type, be sure to update QueryProviderBlocks/ReferenceBlocks/AllBlockTypes as needed

Variables

var NodeAndEdgeProviderBlocks = []string{
	BlockTypeHierarchy,
	BlockTypeFlow,
	BlockTypeGraph,
}

NodeAndEdgeProviderBlocks is a list of block types which implementnodeAndEdgeProvider

var QueryProviderBlocks = []string{
	BlockTypeCard,
	BlockTypeChart,
	BlockTypeControl,
	BlockTypeEdge,
	BlockTypeFlow,
	BlockTypeGraph,
	BlockTypeHierarchy,
	BlockTypeImage,
	BlockTypeInput,
	BlockTypeQuery,
	BlockTypeNode,
	BlockTypeTable,
	BlockTypeWith,
}

QueryProviderBlocks is a list of block types which implement QueryProvider

var ReferenceBlocks = []string{
	BlockTypeMod,
	BlockTypeQuery,
	BlockTypeControl,
	BlockTypeBenchmark,
	BlockTypeDashboard,
	BlockTypeContainer,
	BlockTypeCard,
	BlockTypeChart,
	BlockTypeFlow,
	BlockTypeGraph,
	BlockTypeHierarchy,
	BlockTypeImage,
	BlockTypeInput,
	BlockTypeTable,
	BlockTypeText,
	BlockTypeParam,
	BlockTypeCategory,
	BlockTypeWith,
}

ReferenceBlocks is a list of block types we store references for

var ValidResourceItemTypes = []string{
	BlockTypeMod,
	BlockTypeQuery,
	BlockTypeControl,
	BlockTypeBenchmark,
	BlockTypeDashboard,
	BlockTypeContainer,
	BlockTypeChart,
	BlockTypeCard,
	BlockTypeFlow,
	BlockTypeGraph,
	BlockTypeHierarchy,
	BlockTypeImage,
	BlockTypeInput,
	BlockTypeTable,
	BlockTypeText,
	BlockTypeLocals,
	BlockTypeVariable,
	BlockTypeParam,
	BlockTypeRequire,
	BlockTypeNode,
	BlockTypeEdge,
	BlockTypeLegacyRequires,
	BlockTypeCategory,
	BlockTypeConnection,
	BlockTypeOptions,
	BlockTypeWorkspaceProfile,
	BlockTypePipeline,
	BlockTypeTrigger,
	BlockTypeWith,

	"local",

	"ref",

	"var",
}

Functions

func IsValidResourceItemType

func IsValidResourceItemType(blockType string) bool