-
Notifications
You must be signed in to change notification settings - Fork 74
/
clear.go
52 lines (46 loc) · 1.38 KB
/
clear.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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
// Copyright 2015-2017 trivago GmbH
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package format
import (
"github.com/trivago/gollum/core"
)
// Clear formatter
//
// This formatter erases the message payload or deletes a metadata key.
//
// Examples
//
// This example removes the "pipe" key from the metadata produced by
// consumer.Console.
//
// exampleConsumer:
// Type: consumer.Console
// Streams: stdin
// Modulators:
// - format.Clear
// ApplyTo: pipe
type Clear struct {
core.SimpleFormatter `gollumdoc:"embed_type"`
}
func init() {
core.TypeRegistry.Register(Clear{})
}
// Configure initializes this formatter with values from a plugin config.
func (format *Clear) Configure(conf core.PluginConfigReader) {
}
// ApplyFormatter update message payload
func (format *Clear) ApplyFormatter(msg *core.Message) error {
format.SetAppliedContent(msg, nil)
return nil
}