batchconfig

Documentation

Index

• type Config
  • func FromAny(v any) (conf Config, err error)
  • func NewConfig() Config
  • func (p Config) IsHardLimited() bool
  • func (p Config) IsLimited() bool
  • func (p Config) IsNoop() bool

Types

type Config

type Config struct {
	ByteSize   int                `json:"byte_size" yaml:"byte_size"`
	Count      int                `json:"count" yaml:"count"`
	Check      string             `json:"check" yaml:"check"`
	Period     string             `json:"period" yaml:"period"`
	Processors []processor.Config `json:"processors" yaml:"processors"`
}

Config contains configuration parameters for a batch policy.

func FromAny

func FromAny(v any) (conf Config, err error)

FromAny attempts to extract a Config from any value.

func NewConfig

func NewConfig() Config

NewConfig creates a default PolicyConfig.

func (Config) IsHardLimited

func (p Config) IsHardLimited() bool

IsHardLimited returns true if there's a realistic limit on the batching policy, where checks are not included.

func (Config) IsLimited

func (p Config) IsLimited() bool

IsLimited returns true if there's any limit on the batching policy.

func (Config) IsNoop

func (p Config) IsNoop() bool

IsNoop returns true if this batch policy configuration does nothing.