Package reader defines implementations of an interface for generic message reading from various third party sources.

AppendProcessorsFromConfig takes a variant arg of pipeline constructor functions and returns a new slice of them where the processors of the provided input configuration will also be initialized.

Descriptions returns a formatted string of descriptions for each type.

DocumentPlugin adds a description and an optional configuration sanitiser function to the definition of a registered plugin.

GetDeprecatedPlugin returns a constructor for an old plugin if it exists.

New creates an input type based on an input configuration.

NewAmazonS3 creates a new AWS S3 input type.

NewAmazonSQS creates a new AWS SQS input type.

NewAMQP creates a new AMQP input type.

NewAMQP09 creates a new AMQP09 input type.

NewAMQP1 creates a new AMQP1 input type.

NewAsyncReader creates a new AsyncReader input type.

NewAWSKinesisConfig creates a new Config with default values.

NewAWSS3Config creates a new AWSS3Config with default values.

NewAWSS3SQSConfig creates a new AWSS3SQSConfig with default values.

NewAWSSQSConfig creates a new Config with default values.

NewAzureBlobStorageConfig creates a new AzureBlobStorageConfig with default values.

NewAzureQueueStorageConfig creates a new AzureQueueStorageConfig with default values.

NewBatcher creates a new Batcher around an input.

NewBloblangConfig creates a new BloblangConfig with default values.

NewBroker creates a new Broker input type.

NewBrokerConfig creates a new BrokerConfig with default values.

NewConfig returns a configuration struct fully populated with default values.

NewCSVFile creates a new CSV file input type.

NewCSVFileConfig creates a new CSVFileConfig with default values.

NewDynamic creates a new Dynamic input type.

NewDynamicConfig creates a new DynamicConfig with default values.

NewDynamoDBCheckpointConfig returns a DynamoDBCheckpoint config struct with default values.

NewFile creates a new File input type.

NewFileConfig creates a new FileConfig with default values.

NewFiles creates a new Files input type.

NewGCPCloudStorageConfig creates a new GCPCloudStorageConfig with default values.

NewGCPPubSub creates a new GCP Cloud Pub/Sub input type.

NewHDFS creates a new Files input type.

NewHTTPClient creates a new HTTPClient input type.

NewHTTPClientConfig creates a new HTTPClientConfig with default values.

NewHTTPServer creates a new HTTPServer input type.

NewHTTPServerConfig creates a new HTTPServerConfig with default values.

NewHTTPServerResponseConfig creates a new HTTPServerConfig with default values.

NewInproc creates a new Inproc input type.

NewInprocConfig creates a new inproc input config.

NewKafka creates a new Kafka input type.

NewKafkaBalanced creates a new KafkaBalanced input type.

NewKinesis creates a new AWS Kinesis input type.

NewKinesisBalanced creates a new AWS KinesisBalanced input type.

NewMQTT creates a new MQTT input type.

NewNanomsg creates a new Nanomsg input type.

NewNATS creates a new NATS input type.

NewNATSJetStreamConfig creates a new NATSJetstreamConfig with default values.

NewNATSStream creates a new NATSStream input type.

NewNSQ creates a new NSQ input type.

NewPulsarConfig creates a new PulsarConfig with default values.

NewReader creates a new Reader input type.

NewReadUntil creates a new ReadUntil input type.

NewReadUntilConfig creates a new ReadUntilConfig with default values.

NewRedisList creates a new Redis List input type.

NewRedisPubSub creates a new RedisPubSub input type.

NewRedisStreams creates a new Redis List input type.

NewResource returns a resource input.

NewSequence creates a new Sequence input type.

NewSequenceConfig creates a new SequenceConfig with default values.

NewSequenceShardedJoinConfig creates a new sequence sharding configuration with default values.

NewSFTPConfig creates a new SFTPConfig with default values.

NewSocket creates a new Socket input type.

NewSocketConfig creates a new SocketConfig with default values.

NewSocketServer creates a new SocketServer input type.

NewSocketServerConfig creates a new SocketServerConfig with default values.

NewSTDIN creates a new STDIN input type.

NewSTDINConfig creates a STDINConfig populated with default values.

NewSubprocessConfig creates a new SubprocessConfig with default values.

NewTCP creates a new TCP input type.

NewTCPConfig creates a new TCPConfig with default values.

NewTCPServer creates a new TCPServer input type.

NewTCPServerConfig creates a new TCPServerConfig with default values.

NewUDPServer creates a new UDPServer input type.

NewUDPServerConfig creates a new UDPServerConfig with default values.

NewWebsocket creates a new Websocket input type.

PluginCount returns the number of registered plugins.

PluginDescriptions generates and returns a markdown formatted document listing each registered plugin and an example configuration for it.

RegisterPlugin registers a plugin by a unique name so that it can be constructed similar to regular inputs.

SanitiseConfig returns a sanitised version of the Config, meaning sections that aren't relevant to behaviour are removed.

WalkConstructors iterates each component constructor.

WrapWithPipeline routes an input directly into a processing pipeline and returns a type that manages both and acts like an ordinary input.

WrapWithPipelines wraps an input with a variadic number of pipelines.

ErrCodeKMSThrottlingException is defined in the API Reference https://docs.aws.amazon.com/sdk-for-go/api/service/kinesis/#Kinesis.GetRecords.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

String constants representing each input type.

Input categories.

Input categories.

Input categories.

Input categories.

Input categories.

Input categories.

Input categories.

Constructors is a map of all input types with their specs.

ErrBrokerNoInputs is returned when creating a broker with zero inputs.

Common errors that might occur throughout checkpointing.

AsyncReader is an input implementation that reads messages from a reader.Async component.

AWSKinesisConfig is configuration values for the input type.

AWSS3Config contains configuration values for the aws_s3 input type.

AWSS3SQSConfig contains configuration for hooking up the S3 input with an SQS queue.

AWSSQSConfig contains configuration values for the input type.

AzureBlobStorageConfig contains configuration fields for the AzureBlobStorage input type.

AzureQueueStorageConfig contains configuration fields for the AzureQueueStorage input type.

Batcher wraps an input with a batch policy.

Bloblang executes a bloblang mapping with an empty context each time this input is read from.

BloblangConfig contains configuration for the Bloblang input type.

BrokerConfig contains configuration fields for the Broker input type.

Config is the all encompassing configuration struct for all input types.

CSVFileConfig contains configuration values for the CSVFile input type.

DynamicConfig contains configuration for the Dynamic input type.

DynamoDBCheckpointConfig contains configuration parameters for a DynamoDB based checkpoint store for Kinesis.

FileConfig contains configuration values for the File input type.

GCPCloudStorageConfig contains configuration fields for the Google Cloud Storage input type.

HTTPClient is an input type that continuously makes HTTP requests and reads the response bodies as message payloads.

HTTPClientConfig contains configuration for the HTTPClient output type.

HTTPServer is an input type that registers a range of HTTP endpoints where requests can send messages through Benthos.

HTTPServerConfig contains configuration for the HTTPServer input type.

HTTPServerResponseConfig provides config fields for customising the response given from successful requests.

Inproc is an input type that reads from a named pipe, which could be the output of a separate Benthos stream of the same process.

NATSJetStreamConfig contains configuration fields for the NATS Jetstream input type.

PulsarConfig contains configuration for the Pulsar input type.

Reader is an input implementation that reads messages from a reader.Type.

ReadUntil is an input type that continuously reads another input type until a condition returns true on a message consumed.

ReadUntilConfig contains configuration values for the ReadUntil input type.

Resource is an input that wraps an input resource.

Sequence is an input type that reads from a sequence of inputs, starting with the first, and when it ends gracefully it moves onto the next, and so on.

SequenceConfig contains configuration values for the Sequence input type.

SequenceShardedJoinConfig describes an optional mechanism for performing sharded joins of structured data resulting from the input sequence.

SFTPConfig contains configuration fields for the SFTP input type.

SocketConfig contains configuration values for the Socket input type.

SocketServer is an input type that binds to an address and consumes streams of messages over Socket.

SocketServerConfig contains configuration for the SocketServer input type.

STDINConfig contains config fields for the STDIN input type.

StreamConfig contains fields for specifying consumption behaviour when the body of a request is a constant stream of bytes.

Subprocess executes a bloblang mapping with an empty context each time this input is read from.

SubprocessConfig contains configuration for the Subprocess input type.

TCPConfig contains configuration values for the TCP input type.

TCPServer is an input type that binds to an address and consumes streams of messages over TCP.

TCPServerConfig contains configuration for the TCPServer input type.

TypeSpec is a struct containing constructors, markdown descriptions and an optional sanitisation function for each input type.

UDPServer is an input type that binds to an address and consumes streams of messages over UDP.

UDPServerConfig contains configuration for the UDPServer input type.

WithPipeline is a type that wraps both an input type and a pipeline type by routing the input through the pipeline, and implements the input.Type interface in order to act like an ordinary input.

Type is the standard interface of an input type.

Category describes the general category of an input.

ConstructorFunc is a func signature able to construct an input.

InprocConfig is a configuration type for the inproc input.

PluginConfigConstructor is a func that returns a pointer to a new and fully populated configuration struct for a plugin type.

PluginConfigSanitiser is a function that takes a configuration object for a plugin and returns a sanitised (minimal) version of it for printing in examples and plugin documentation.

PluginConstructor is a func that constructs a Benthos input plugin.