kinesis

package
v1.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 5, 2023 License: Apache-2.0 Imports: 39 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Name     = "kinesis"
	Version  = "v0.0.0"
	CommitID = ""
)
View Source 
var DefaultReceiverConfig = ReceiverConfig{
	StreamName:              "",
	AcknowledgeTimeout:      pointer.Int(5),
	ShardIteratorType:       kinesis.ShardIteratorTypeLatest,
	TracePayloadOnNack:      pointer.Bool(false),
	EnhancedFanOut:          pointer.Bool(false),
	ConsumerName:            "",
	AWSRoleARN:              "",
	AWSSecretAccessKey:      "",
	AWSAccessKeyId:          "",
	AWSRegion:               endpoints.UsWest2RegionID,
	MaxCheckpointAgeSeconds: pointer.Int(86400),
	UseCheckpoint:           pointer.Bool(true),
	UseShardMonitor:         pointer.Bool(false),
	StartingTimestamp:       pointer.Int64(0),
	StartingSequenceNumber:  "",
}
View Source 
var DefaultSenderConfig = SenderConfig{
	StreamName:          "",
	MaxNumberOfMessages: pointer.Int(1),
	SendTimeout:         pointer.Int(1),
	PartitionKey:        "",
	PartitionKeyPath:    "",
	AWSRoleARN:          "",
	AWSSecretAccessKey:  "",
	AWSAccessKeyId:      "",
	AWSRegion:           endpoints.UsWest2RegionID,
}

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, tableSyncer syncer.DeltaSyncer) (receiver.Receiver, error)

func NewSender 

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

Types

type KinesisError added in v1.1.0 

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

func (*KinesisError) Error added in v1.1.0 

func (e *KinesisError) Error() string

func (*KinesisError) Unwrap added in v1.1.0 

func (e *KinesisError) Unwrap() error

type Receiver 

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

func (*Receiver) Config 

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

func (*Receiver) EventErrorCount added in v1.1.2 

func (r *Receiver) EventErrorCount() int

func (*Receiver) EventErrorVelocity added in v1.1.2 

func (r *Receiver) EventErrorVelocity() int

func (*Receiver) EventSuccessCount added in v1.1.2 

func (r *Receiver) EventSuccessCount() int

func (*Receiver) EventSuccessVelocity added in v1.1.2 

func (r *Receiver) EventSuccessVelocity() int

func (*Receiver) EventTs added in v1.1.2 

func (r *Receiver) EventTs() int64

func (*Receiver) Hash added in v1.1.2 

func (r *Receiver) Hash() string

func (*Receiver) LogSuccess added in v1.1.2 

func (r *Receiver) LogSuccess()

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 {
	StreamName              string `json:"streamName,omitempty"`
	AcknowledgeTimeout      *int   `json:"acknowledgeTimeout,omitempty"`
	ShardIteratorType       string `json:"shardIteratorType,omitempty"`
	TracePayloadOnNack      *bool  `json:"tracePayloadOnNack,omitempty"`
	EnhancedFanOut          *bool  `json:"enhancedFanOut,omitempty"`
	ConsumerName            string `json:"consumerName,omitempty"` // enhanced fan-out only
	AWSRoleARN              string `json:"awsRoleARN,omitempty"`
	AWSAccessKeyId          string `json:"awsAccessKeyId,omitempty"`
	AWSSecretAccessKey      string `json:"awsSecretAccessKey,omitempty"`
	AWSRegion               string `json:"awsRegion,omitempty"`
	UseCheckpoint           *bool  `json:"useCheckpoint,omitempty"`
	MaxCheckpointAgeSeconds *int   `json:"maxCheckpointAgeSeconds,omitempty"`
	UseShardMonitor         *bool  `json:"useShardMonitor,omitempty"`
	StartingSequenceNumber  string `json:"startingSequenceNumber,omitempty"`
	StartingTimestamp       *int64 `json:"startingTimestamp,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) EventErrorCount added in v1.1.2 

func (s *Sender) EventErrorCount() int

func (*Sender) EventErrorVelocity added in v1.1.2 

func (s *Sender) EventErrorVelocity() int

func (*Sender) EventSuccessCount added in v1.1.2 

func (s *Sender) EventSuccessCount() int

func (*Sender) EventSuccessVelocity added in v1.1.2 

func (s *Sender) EventSuccessVelocity() int

func (*Sender) EventTs added in v1.1.2 

func (s *Sender) EventTs() int64

func (*Sender) Hash added in v1.1.2 

func (s *Sender) Hash() string

func (*Sender) Name 

func (s *Sender) Name() string

func (*Sender) Plugin 

func (s *Sender) Plugin() string

func (*Sender) Send 

func (s *Sender) Send(e 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 {
	StreamName          string `json:"streamName,omitempty"`
	MaxNumberOfMessages *int   `json:"maxNumberOfMessages,omitempty"`
	SendTimeout         *int   `json:"sendTimeout,omitempty"`
	PartitionKey        string `json:"partitionKey,omitempty"`
	PartitionKeyPath    string `json:"partitionKeyPath,omitempty"`
	AWSRoleARN          string `json:"awsRoleARN,omitempty"`
	AWSAccessKeyId      string `json:"awsAccessKeyId,omitempty"`
	AWSSecretAccessKey  string `json:"awsSecretAccessKey,omitempty"`
	AWSRegion           string `json:"awsRegion,omitempty"`
}

func (*SenderConfig) Validate 

func (sc *SenderConfig) Validate() error

Validate

func (SenderConfig) WithDefaults 

func (sc SenderConfig) WithDefaults() SenderConfig

WithDefaults

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.