awskinesis

Documentation

Index

• Constants
• Variables
• type Kinesis
  • func New(connOpts *opts.ConnectionOptions) (*Kinesis, error)
  • func (k *Kinesis) Close(_ context.Context) error
  • func (k *Kinesis) DisplayError(msg *records.ErrorRecord) error
  • func (k *Kinesis) DisplayMessage(cliOpts *opts.CLIOptions, msg *records.ReadRecord) error
  • func (k *Kinesis) Name() string
  • func (k *Kinesis) Read(ctx context.Context, readOpts *opts.ReadOptions, ...) error
  • func (k *Kinesis) Relay(ctx context.Context, relayOpts *opts.RelayOptions, relayCh chan interface{}, ...) error
  • func (k *Kinesis) Test(_ context.Context) error
  • func (k *Kinesis) Tunnel(ctx context.Context, tunnelOpts *opts.TunnelOptions, tunnelSvc tunnel.ITunnel, ...) error
  • func (k *Kinesis) Write(ctx context.Context, writeOpts *opts.WriteOptions, ...) error

Constants

const BackendName = "kinesis"

Variables

var (
	ErrEmptyPartitionKey      = errors.New("partition key cannot be empty")
	ErrEmptyStream            = errors.New("stream cannot be empty")
	ErrEmptyShard             = errors.New("shard cannot be empty")
	ErrEmptyShardWithSequence = errors.New("when reading from all shards, you cannot specify a sequence number")
)

Types

type Kinesis

type Kinesis struct {
	// contains filtered or unexported fields
}

func New

func New(connOpts *opts.ConnectionOptions) (*Kinesis, error)

func (*Kinesis) Close

func (k *Kinesis) Close(_ context.Context) error

func (*Kinesis) DisplayError

func (k *Kinesis) DisplayError(msg *records.ErrorRecord) error

DisplayError will parse an Error record and print (pretty) output to STDOUT

func (*Kinesis) DisplayMessage

func (k *Kinesis) DisplayMessage(cliOpts *opts.CLIOptions, msg *records.ReadRecord) error

DisplayMessage will parse a Read record and print (pretty) output to STDOUT

func (*Kinesis) Name

func (k *Kinesis) Name() string

func (*Kinesis) Read

func (k *Kinesis) Read(ctx context.Context, readOpts *opts.ReadOptions, resultsChan chan *records.ReadRecord, errorChan chan *records.ErrorRecord) error

Read reads records from a Kinesis stream

func (*Kinesis) Relay

func (k *Kinesis) Relay(ctx context.Context, relayOpts *opts.RelayOptions, relayCh chan interface{}, errorCh chan<- *records.ErrorRecord) error

func (*Kinesis) Test

func (k *Kinesis) Test(_ context.Context) error

func (*Kinesis) Tunnel

func (k *Kinesis) Tunnel(ctx context.Context, tunnelOpts *opts.TunnelOptions, tunnelSvc tunnel.ITunnel, errorCh chan<- *records.ErrorRecord) error

func (*Kinesis) Write

func (k *Kinesis) Write(ctx context.Context, writeOpts *opts.WriteOptions, errorCh chan<- *records.ErrorRecord, messages ...*records.WriteRecord) error