remove

Documentation

Overview

Code generated by processor/generate.go - DO NOT EDIT.

Index

• type Config
  • func (c *Config) InitDefaults()
• type Remove
  • func New(config Config) (*Remove, error)
  • func (p *Remove) Config() Config
  • func (p *Remove) Process(event processor.Event) error
  • func (p *Remove) String() string

Types

type Config

type Config struct {
	// Source fields to remove.
	Fields []string `config:"fields" validate:"required"`

	// If true and field does not exist or is null, the processor quietly
	// returns without modifying the document.
	IgnoreMissing bool `config:"ignore_missing"`
}

Config contains the configuration options for the remove processor.

func (*Config) InitDefaults

func (c *Config) InitDefaults()

InitDefaults initializes the configuration options to their default values.

type Remove

type Remove struct {
	// contains filtered or unexported fields
}

Removes existing fields. If one field doesn’t exist the processor will fail.

func New

func New(config Config) (*Remove, error)

New returns a new Remove processor.

func (*Remove) Config

func (p *Remove) Config() Config

Config returns the Remove processor config.

func (*Remove) Process

func (p *Remove) Process(event processor.Event) error

func (*Remove) String

func (p *Remove) String() string