forked from redpanda-data/connect
-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs.go
24 lines (18 loc) · 1.02 KB
/
docs.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
package processor
import "github.com/dafanshu/benthos/v3/internal/docs"
//------------------------------------------------------------------------------
// DocsUsesBatches returns a documentation paragraph regarding processors that
// benefit from input level batching.
var DocsUsesBatches = `
The functionality of this processor depends on being applied across messages
that are batched. You can find out more about batching [in this doc](/docs/configuration/batching).`
// PartsFieldSpec documents the parts field common to many processor types.
var PartsFieldSpec = docs.FieldInt(
"parts",
`An optional array of message indexes of a batch that the processor should apply to.
If left empty all messages are processed. This field is only applicable when
batching messages [at the input level](/docs/configuration/batching).
Indexes can be negative, and if so the part will be selected from the end
counting backwards starting from -1.`,
).Array().Advanced()
//------------------------------------------------------------------------------