types

type ArtifactInfo struct {
	// this is the original name of the artifact
	Name string `json:"original_name"`

	// enrichment values passed from the source to the collection to include in the enrichment process
	SourceEnrichment *schema.SourceEnrichment `json:"-"`
	Timestamp        time.Time                `json:"timestamp"`
}

type CollectRequest struct {
	TableName     string
	PartitionName string

	// unique identifier for collection execution this will be used as base for the filename fo the resultiung JSONL files
	ExecutionId string
	// the parent folder for all collection related files (JSONL files, temp source files)
	CollectionTempDir string
	// the filepath for the collection state json file
	CollectionStatePath string
	// the source to use (with raw config)
	SourceData *SourceConfigData
	// the source format to use (with either raw hcl config, or the preset name)
	SourceFormat *FormatConfigData
	// the raw hcl of the connection
	ConnectionData *ConnectionConfigData
	// the collection start time
	From time.Time
	// the collection end time
	To time.Time
	// the custom table definition, if specified
	CustomTableSchema *schema.TableSchema
	// the max space to take with temp files
	TempDirMaxMb int64
	// recollect all data for the specified time range even if it has been collected already
	Recollect bool
}

type Config interface {
	Validate() error
	Identifier() string
}

type ConfigData interface {
	GetHcl() []byte
	GetRange() hcl.Range
	Identifier() string
	ToProto() *proto.ConfigData
	GetConfigType() string
}

type ConfigDataImpl struct {
	Hcl   []byte
	Range hcl.Range
	// ConfigType is the type of the config data, i.e. connection, source, partition, format
	ConfigType string
	// InstanceType represent the subtype type of the config instance:
	// - if this is a partition config, this will be the table name
	// - if this is a source config, this will be the source type
	// - if this is a connection config, this will be the connection type (i.e. plugin name)
	// - if this is a format config, this will be the format type
	InstanceType string
}

type ConnectionConfigData struct {
	*ConfigDataImpl
}

type DescribeResponse struct {
	// proto fields
	Schemas       schema.SchemaMap
	Sources       SourceMetadataMap
	FormatPresets FormatDescriptionMap
	CustomFormats FormatDescriptionMap
	FormatTypes   []string

	// non-proto fields - should be populated by PluginManager before returning
	PluginName string
}

type DownloadedArtifactInfo struct {
	ArtifactInfo
	// the path of the downloaded artifact
	LocalName string `json:"local_name"`

	Size int64 `json:"size"`
}

type DynamicRow struct {

	// the output columns, as a map of string to interface{} - the result of enrichment and type conversion
	OutputColumns map[string]interface{}
	// contains filtered or unexported fields
}

type DynamicTableConfig interface {
	GetSchema() (*schema.TableSchema, error)
}

type ExtensionLookup map[string]struct{}

type FormatConfigData struct {
	*ConfigDataImpl
	Name       string
	PresetName string
	Regex      string
}

type FormatDescription struct {
	Type        string
	Name        string
	Description string
	Regex       string
	Properties  map[string]string
}

type FormatDescriptionMap map[string]*FormatDescription

type JSONString string

type PropertyMetadata struct {
	Description string `json:"description,omitempty"`
	Type        string `json:"type,omitempty"`
	Required    bool   `json:"required,omitempty"`
	Default     string `json:"default,omitempty"`
}

type RowData struct {
	Data             any
	SourceEnrichment *schema.SourceEnrichment
}

type SourceConfigData struct {
	*ConfigDataImpl
	ReattachConfig *SourcePluginReattach
}

type SourceMetadata struct {
	Name        string                       `json:"name"`
	Description string                       `json:"description,omitempty"`
	Properties  map[string]*PropertyMetadata `json:"properties,omitempty"`
}

type SourceMetadataMap map[string]*SourceMetadata

type SourcePluginReattach struct {
	Reattach *plugin.ReattachConfig

	Plugin     string
	SourceType string
}

type TimeMillis int64

type UnixMillis int64

type UpdateCollectionStateRequest struct {
	// the folder containing collection state files (e.g. last collection time)
	CollectionStatePath string
	// the source to use (with raw config)
	SourceData *SourceConfigData
	// the start time - this will be the new state end time
	From time.Time
}