kinesis

Documentation

Index

• func Module() fx.Option
• func NewEvent(c kinesis.Client, options *Options) repository.Event
• func RandomPartitionKeyValue() bool
• type Client
  • func NewClient(c kinesis.Client, options *Options) *Client
  • func (p *Client) Publish(ctx context.Context, outs []*v2.Event) (err error)
• type Options
  • func DefaultOptions() (*Options, error)

Functions

func Module

func Module() fx.Option

Module loads the kinesis module providing an initialized client.

The module is only loaded once.

func NewEvent

func NewEvent(c kinesis.Client, options *Options) repository.Event

NewEvent returns a initialized client

func RandomPartitionKeyValue

func RandomPartitionKeyValue() bool

RandomPartitionKeyValue returns if random partition key that is enabled or not via the "faas.provider.kinesis.randomPartitionKey" key. If not configured, the default is false.

Types

type Client

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

Client represents a kinesis client.

func NewClient

func NewClient(c kinesis.Client, options *Options) *Client

NewClient creates a new kinesis client.

func (*Client) Publish

func (p *Client) Publish(ctx context.Context, outs []*v2.Event) (err error)

Publish publishes one or multiple events.

type Options

type Options struct {
	RandomPartitionKey bool `config:"randompartitionkey"`
}

Options can be used to create customized kinesis client.

func DefaultOptions

func DefaultOptions() (*Options, error)

DefaultOptions returns options based in config.