scoop_protocol

type Action string

type AnnotatedKinesisConfig struct {
	ID               int
	AWSAccount       int64
	Team             string
	Version          int
	Contact          string
	Usage            string
	ConsumingLibrary string
	SpadeConfig      KinesisWriterConfig
	LastEditedAt     time.Time
	LastChangedBy    string
	Dropped          bool
	DroppedReason    string
}

type AuthScoopSigner struct {
	TimeSigner *msg_signer.TimeSigner
	Exp        time.Duration
}

type BatcherConfig struct {
	// MaxSize is the max combined size of the batch
	MaxSize int

	// MaxEntries is the max number of entries that can be batched together
	// if batches does not have an entry limit, set MaxEntries as -1
	MaxEntries int

	// MaxAge is the max age of the oldest entry in the glob
	MaxAge string

	// BufferLength is the length of the channel where newly
	// submitted entries are stored, decreasing the size of this
	// buffer can cause stalls, and increasing the size can increase
	// shutdown time
	BufferLength int
}

type ColumnDefinition struct {
	InboundName           string
	OutboundName          string
	Transformer           string // this should match one of the types in redshift types
	ColumnCreationOptions string
	SupportingColumns     string // comma separated list used by mapping transformers
}

type Config struct {
	EventName string
	Columns   []ColumnDefinition
	Version   int
}

type EventFilterFunc func(map[string]string) bool

type EventMetadataConfig struct {
	// The first key is the event name, second key is metadata type
	Metadata map[string](map[string]EventMetadataRow)
}

type EventMetadataRow struct {
	MetadataValue string
	TS            time.Time
	UserName      string
	Version       int
}

type EventMetadataType string

type FakeScoopSigner struct{}

type FilterOperator string

type GlobberConfig struct {
	// MaxSize is the max size per glob before compression
	MaxSize int

	// MaxAge is the max age of the oldest entry in the glob
	MaxAge string

	// BufferLength is the length of the channel where newly
	// submitted entries are stored, decreasing the size of this
	// buffer can cause stalls, and increasing the size can increase
	// shutdown time
	BufferLength int
}

type KinesisEventFilterConfig struct {
	Field    string
	Values   []string
	Operator FilterOperator
}

type KinesisWriterConfig struct {
	StreamName             string
	StreamRole             string
	StreamType             string // StreamType should be either "stream" or "firehose"
	StreamRegion           string // AWS region to write to. Blank to use default region.
	Compress               bool   // true if compress data with flate, false to output json
	FirehoseRedshiftStream bool   // true if JSON destined for Firehose->Redshift streaming
	EventNameTargetField   string // Field name to write the event's name to (useful for uncompressed streams)
	ExcludeEmptyFields     bool   // true if empty fields should be excluded from the JSON
	BufferSize             int
	MaxAttemptsPerRecord   int
	RetryDelay             string

	Events map[string]*KinesisWriterEventConfig

	Globber GlobberConfig
	Batcher BatcherConfig
}

type KinesisWriterEventConfig struct {
	Filter            string
	FilterFunc        EventFilterFunc `json:"-"`
	Fields            []string
	FieldRenames      map[string]string
	FullFieldMap      map[string]string `json:"-"`
	FilterParameters  []*KinesisEventFilterConfig
	SkipDefaultFilter bool
	AllFields         bool
}

type LoadCheckRequest struct {
	ManifestURL string
}

type LoadCheckResponse struct {
	LoadStatus  LoadStatus
	ManifestURL string
}

type LoadStatus string

type ManifestRowCopyRequest struct {
	ManifestURL string
	TableName   string
}

type Operation struct {
	Action         Action
	Name           string
	ActionMetadata map[string]string
	Version        int
	Ordering       int
}

type RowCopyRequest struct {
	KeyName      string
	TableName    string
	TableVersion int
}

type ScoopHealthCheck struct {
	RedshiftDBConnError *string
	IngesterDBConnError *string
}

type ScoopSigner interface {
	GetConfig(io.Reader) (*Config, error)
	GetRowCopyRequest(io.Reader) (*RowCopyRequest, error)
	SignJsonBody(interface{}) ([]byte, error)
	SignBody([]byte) ([]byte, error)
}

type TestableKinesisEventFilter struct {
	Config            []*KinesisEventFilterConfig
	MatchingEvents    []map[string]string
	NonMatchingEvents []map[string]string
}