Descriptions returns a formatted string of collated descriptions of each type.

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

New creates a condition type based on a condition configuration.

NewAll returns an All condition.

NewAllConfig returns a AllConfig with default values.

NewAnd returns an And condition.

NewAndConfig returns a AndConfig with default values.

NewAny returns an Any condition.

NewAnyConfig returns a AnyConfig with default values.

NewBoundsCheck returns a BoundsCheck condition.

NewBoundsCheckConfig returns a BoundsCheckConfig with default values.

NewCheckField returns a CheckField condition.

NewCheckFieldConfig returns a CheckFieldConfig with default values.

NewConfig returns a configuration struct fully populated with default values.

NewCount returns a Count condition.

NewCountConfig returns a CountConfig with default values.

NewJMESPath returns a JMESPath condition.

NewJMESPathConfig returns a JMESPathConfig with default values.

NewMetadata returns a Metadata condition.

NewMetadataConfig returns a MetadataConfig with default values.

NewNot returns a Not condition.

NewNotConfig returns a NotConfig with default values.

NewOr returns an Or condition.

NewOrConfig returns a OrConfig with default values.

NewProcessorFailed returns a ProcessorFailed condition.

NewProcessorFailedConfig returns a ProcessorFailedConfig with default values.

NewResource returns a resource condition.

NewStatic returns a Static condition.

NewText returns a Text condition.

NewTextConfig returns a TextConfig with default values.

NewXor returns an Xor condition.

NewXorConfig returns a XorConfig with default values.

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 constucted similar to regular conditions.

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

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

Errors for the metadata condition.

Errors for the text condition.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

String constants representing each condition type.

All is a condition that returns the logical or of all children.

AllConfig is a configuration struct containing fields for the All condition.

And is a condition that returns the logical AND of all children.

Any is a condition that returns the logical or of all children.

AnyConfig is a configuration struct containing fields for the Any condition.

BoundsCheck is a condition that checks a message against a set of bounds.

BoundsCheckConfig contains configuration fields for the BoundsCheck condition.

CheckField is a condition that extracts a field and checks the contents against a child condition.

CheckFieldConfig contains configuration fields for the CheckField condition.

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

Count is a condition that counts each message and returns false once a target count has been reached, at which point it resets the counter and starts again.

CountConfig is a configuration struct containing fields for the Count condition.

JMESPath is a condition that checks message against a jmespath query.

JMESPathConfig is a configuration struct containing fields for the jmespath condition.

Metadata is a condition that checks message text against logical operators.

MetadataConfig is a configuration struct containing fields for the metadata condition.

Not is a condition that returns the opposite of a child condition.

NotConfig is a configuration struct containing fields for the Not condition.

Or is a condition that returns the logical or of all children.

ProcessorFailed is a condition that checks whether processing steps have failed for a message.

ProcessorFailedConfig is a configuration struct containing fields for the processor_failed condition.

Resource is a condition that returns the result of a condition resource.

Static is a condition that always returns a static boolean value.

Text is a condition that checks message text against logical operators.

TextConfig is a configuration struct containing fields for the text condition.

TypeSpec Constructor and a usage description for each condition type.

Xor is a condition that returns the logical xor of all children.

Type reads a message, calculates a condition and returns a boolean.

AndConfig is a configuration struct containing fields for the And condition.

OrConfig is a configuration struct containing fields for the Or condition.

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 condition plugin.

XorConfig is a configuration struct containing fields for the Xor condition.