forked from redpanda-data/connect
-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs.go
15 lines (13 loc) · 776 Bytes
/
docs.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
package retries
import "github.com/dafanshu/benthos/v3/internal/docs"
// FieldSpecs returns documentation specs for retry fields.
func FieldSpecs() docs.FieldSpecs {
return docs.FieldSpecs{
docs.FieldAdvanced("max_retries", "The maximum number of retries before giving up on the request. If set to zero there is no discrete limit."),
docs.FieldAdvanced("backoff", "Control time intervals between retry attempts.").WithChildren(
docs.FieldAdvanced("initial_interval", "The initial period to wait between retry attempts."),
docs.FieldAdvanced("max_interval", "The maximum period to wait between retry attempts."),
docs.FieldAdvanced("max_elapsed_time", "The maximum period to wait before retry attempts are abandoned. If zero then no limit is used."),
),
}
}