github.com/Jeffail/benthos/v3@v3.65.0/lib/util/retries/docs.go (about)

     1  package retries
     2  
     3  import "github.com/Jeffail/benthos/v3/internal/docs"
     4  
     5  // FieldSpecs returns documentation specs for retry fields.
     6  func FieldSpecs() docs.FieldSpecs {
     7  	return docs.FieldSpecs{
     8  		docs.FieldAdvanced("max_retries", "The maximum number of retries before giving up on the request. If set to zero there is no discrete limit."),
     9  		docs.FieldAdvanced("backoff", "Control time intervals between retry attempts.").WithChildren(
    10  			docs.FieldAdvanced("initial_interval", "The initial period to wait between retry attempts."),
    11  			docs.FieldAdvanced("max_interval", "The maximum period to wait between retry attempts."),
    12  			docs.FieldAdvanced("max_elapsed_time", "The maximum period to wait before retry attempts are abandoned. If zero then no limit is used."),
    13  		),
    14  	}
    15  }