The highest tagged major version is
Documentation
¶
Overview ¶
Package writer defines implementations of an interface for generic message writing that outputs to various third party sinks.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AmazonAWSCredentialsConfig ¶ added in v0.7.5
type AmazonAWSCredentialsConfig struct {
ID string `json:"id"`
Secret string `json:"secret"`
Token string `json:"token"`
}
AmazonAWSCredentialsConfig contains configuration params for AWS credentials.
type AmazonS3 ¶ added in v0.7.5
type AmazonS3 struct {
// contains filtered or unexported fields
}
AmazonS3 is a benthos writer.Type implementation that writes messages to an Amazon S3 bucket.
func NewAmazonS3 ¶ added in v0.7.5
NewAmazonS3 creates a new Amazon S3 bucket writer.Type.
func (*AmazonS3) CloseAsync ¶ added in v0.7.5
func (a *AmazonS3) CloseAsync()
CloseAsync begins cleaning up resources used by this reader asynchronously.
func (*AmazonS3) Connect ¶ added in v0.7.5
Connect attempts to establish a connection to the target S3 bucket and any relevant queues used to traverse the objects (SQS, etc).
func (*AmazonS3) WaitForClose ¶ added in v0.7.5
WaitForClose will block until either the reader is closed or a specified timeout occurs.
type AmazonS3Config ¶ added in v0.7.5
type AmazonS3Config struct {
Region string `json:"region" yaml:"region"`
Bucket string `json:"bucket" yaml:"bucket"`
Path string `json:"path" yaml:"path"`
Credentials AmazonAWSCredentialsConfig `json:"credentials" yaml:"credentials"`
TimeoutS int64 `json:"timeout_s" yaml:"timeout_s"`
}
AmazonS3Config is configuration values for the input type.
func NewAmazonS3Config ¶ added in v0.7.5
func NewAmazonS3Config() AmazonS3Config
NewAmazonS3Config creates a new Config with default values.
type AmazonSQS ¶ added in v0.8.1
type AmazonSQS struct {
// contains filtered or unexported fields
}
AmazonSQS is a benthos writer.Type implementation that writes messages to an Amazon S3 bucket.
func NewAmazonSQS ¶ added in v0.8.1
NewAmazonSQS creates a new Amazon S3 bucket writer.Type.
func (*AmazonSQS) CloseAsync ¶ added in v0.8.1
func (a *AmazonSQS) CloseAsync()
CloseAsync begins cleaning up resources used by this reader asynchronously.
func (*AmazonSQS) Connect ¶ added in v0.8.1
Connect attempts to establish a connection to the target S3 bucket and any relevant queues used to traverse the objects (SQS, etc).
func (*AmazonSQS) WaitForClose ¶ added in v0.8.1
WaitForClose will block until either the reader is closed or a specified timeout occurs.
type AmazonSQSConfig ¶ added in v0.8.1
type AmazonSQSConfig struct {
Region string `json:"region" yaml:"region"`
URL string `json:"url" yaml:"url"`
Credentials AmazonAWSCredentialsConfig `json:"credentials" yaml:"credentials"`
}
AmazonSQSConfig is configuration values for the input type.
func NewAmazonSQSConfig ¶ added in v0.8.1
func NewAmazonSQSConfig() AmazonSQSConfig
NewAmazonSQSConfig creates a new Config with default values.
type Files ¶ added in v0.7.7
type Files struct {
// contains filtered or unexported fields
}
Files is a benthos writer.Type implementation that writes messages parts each to their own file.
func (*Files) CloseAsync ¶ added in v0.7.7
func (f *Files) CloseAsync()
CloseAsync begins cleaning up resources used by this reader asynchronously.
func (*Files) WaitForClose ¶ added in v0.7.7
WaitForClose will block until either the reader is closed or a specified timeout occurs.
type FilesConfig ¶ added in v0.7.7
type FilesConfig struct {
Path string `json:"path" yaml:"path"`
}
FilesConfig is configuration values for the input type.
func NewFilesConfig ¶ added in v0.7.7
func NewFilesConfig() FilesConfig
NewFilesConfig creates a new Config with default values.
type Kafka ¶
type Kafka struct {
// contains filtered or unexported fields
}
Kafka is a writer type that writes messages into kafka.
func (*Kafka) CloseAsync ¶
func (k *Kafka) CloseAsync()
CloseAsync shuts down the Kafka writer and stops processing messages.
func (*Kafka) WaitForClose ¶
WaitForClose blocks until the Kafka writer has closed down.
type KafkaConfig ¶
type KafkaConfig struct {
Addresses []string `json:"addresses" yaml:"addresses"`
ClientID string `json:"client_id" yaml:"client_id"`
Topic string `json:"topic" yaml:"topic"`
MaxMsgBytes int `json:"max_msg_bytes" yaml:"max_msg_bytes"`
TimeoutMS int `json:"timeout_ms" yaml:"timeout_ms"`
AckReplicas bool `json:"ack_replicas" yaml:"ack_replicas"`
}
KafkaConfig is configuration for the Kafka output type.
func NewKafkaConfig ¶
func NewKafkaConfig() KafkaConfig
NewKafkaConfig creates a new KafkaConfig with default values.
type RedisList ¶
type RedisList struct {
// contains filtered or unexported fields
}
RedisList is an output type that serves RedisList messages.
func NewRedisList ¶
NewRedisList creates a new RedisList output type.
func (*RedisList) CloseAsync ¶
func (r *RedisList) CloseAsync()
CloseAsync shuts down the RedisList output and stops processing messages.
func (*RedisList) WaitForClose ¶
WaitForClose blocks until the RedisList output has closed down.
type RedisListConfig ¶
type RedisListConfig struct {
URL string `json:"url" yaml:"url"`
Key string `json:"key" yaml:"key"`
}
RedisListConfig is configuration for the RedisList output type.
func NewRedisListConfig ¶
func NewRedisListConfig() RedisListConfig
NewRedisListConfig creates a new RedisListConfig with default values.
type Type ¶
type Type interface {
// Connect attempts to establish a connection to the sink, if unsuccessful
// returns an error. If the attempt is successful (or not necessary) returns
// nil.
Connect() error
// Write should block until either the message is sent (and acknowledged) to
// a sink, or a transport specific error has occurred, or the Type is
// closed.
Write(msg types.Message) error
types.Closable
}
Type is a type that writes Benthos messages to a third party sink.
Source Files