s3

Documentation

Index

• Variables
• func NewPlugin() (*pkgplugin.Plugin, error)
• func NewPluginVersion(name string, version string, commitID string) (*pkgplugin.Plugin, error)
• func NewReceiver(tid tenant.Id, plugin string, name string, config interface{}, ...) (receiver.Receiver, error)
• func NewSender(tid tenant.Id, plugin string, name string, config interface{}, ...) (sender.Sender, error)
• type Receiver
  • func (r *Receiver) Config() interface{}
  • func (r *Receiver) Count() int
  • func (r *Receiver) Name() string
  • func (r *Receiver) Plugin() string
  • func (r *Receiver) Receive(next receiver.NextFn) error
  • func (r *Receiver) StopReceiving(ctx context.Context) error
  • func (r *Receiver) Tenant() tenant.Id
  • func (r *Receiver) Trigger(e event.Event)
• type ReceiverConfig
  • func (rc *ReceiverConfig) Validate() error
  • func (rc *ReceiverConfig) WithDefaults() ReceiverConfig
• type Sender
  • func (s *Sender) Config() interface{}
  • func (s *Sender) Count() int
  • func (s *Sender) Name() string
  • func (s *Sender) Plugin() string
  • func (s *Sender) Send(evt event.Event)
  • func (s *Sender) StopSending(ctx context.Context)
  • func (s *Sender) Tenant() tenant.Id
  • func (s *Sender) Unwrap() sender.Sender
• type SenderConfig
  • func (sc *SenderConfig) Validate() error
  • func (sc SenderConfig) WithDefaults() SenderConfig

Variables

var (
	Name     = "s3"
	Version  = "v0.0.0"
	CommitID = ""
)

var DefaultReceiverConfig = ReceiverConfig{
	Bucket:             "",
	Path:               "",
	Region:             endpoints.UsWest2RegionID,
	AcknowledgeTimeout: pointer.Int(5),
}

var DefaultSenderConfig = SenderConfig{
	Bucket:   "",
	Path:     "",
	Region:   endpoints.UsWest2RegionID,
	FileName: "",
	FilePath: "",
}

Functions

func NewPlugin

func NewPlugin() (*pkgplugin.Plugin, error)

func NewPluginVersion

func NewPluginVersion(name string, version string, commitID string) (*pkgplugin.Plugin, error)

func NewReceiver

func NewReceiver(tid tenant.Id, plugin string, name string, config interface{}, secrets secret.Vault) (receiver.Receiver, error)

func NewSender

func NewSender(tid tenant.Id, plugin string, name string, config interface{}, secrets secret.Vault) (sender.Sender, error)

Types

type Receiver

type Receiver struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*Receiver) Config

func (r *Receiver) Config() interface{}

func (*Receiver) Count

func (r *Receiver) Count() int

func (*Receiver) Name

func (r *Receiver) Name() string

func (*Receiver) Plugin

func (r *Receiver) Plugin() string

func (*Receiver) Receive

func (r *Receiver) Receive(next receiver.NextFn) error

func (*Receiver) StopReceiving

func (r *Receiver) StopReceiving(ctx context.Context) error

func (*Receiver) Tenant

func (r *Receiver) Tenant() tenant.Id

func (*Receiver) Trigger

func (r *Receiver) Trigger(e event.Event)

type ReceiverConfig

type ReceiverConfig struct {
	Bucket             string `json:"bucket,omitempty"`
	Path               string `json:"path,omitempty"`
	Region             string `json:"region,omitempty"`
	AcknowledgeTimeout *int   `json:"acknowledgeTimeout,omitempty"`
}

func (*ReceiverConfig) Validate

func (rc *ReceiverConfig) Validate() error

Validate returns an error upon validation failure

func (*ReceiverConfig) WithDefaults

func (rc *ReceiverConfig) WithDefaults() ReceiverConfig

WithDefaults returns a new config object that has all of the unset (nil) values filled in.

type Sender

type Sender struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*Sender) Config

func (s *Sender) Config() interface{}

func (*Sender) Count

func (s *Sender) Count() int

func (*Sender) Name

func (s *Sender) Name() string

func (*Sender) Plugin

func (s *Sender) Plugin() string

func (*Sender) Send

func (s *Sender) Send(evt event.Event)

func (*Sender) StopSending

func (s *Sender) StopSending(ctx context.Context)

func (*Sender) Tenant

func (s *Sender) Tenant() tenant.Id

func (*Sender) Unwrap

func (s *Sender) Unwrap() sender.Sender

type SenderConfig

type SenderConfig struct {
	Bucket   string `json:"bucket,omitempty"`
	Path     string `json:"path,omitempty"`
	Region   string `json:"region,omitempty"`
	FileName string `json:"fileName,omitempty"`
	FilePath string `json:"filePath,omitempty"`
}

SenderConfig can be passed into NewSender() in order to configure the behavior of the sender.

func (*SenderConfig) Validate

func (sc *SenderConfig) Validate() error

Validate

func (SenderConfig) WithDefaults

func (sc SenderConfig) WithDefaults() SenderConfig

WithDefaults