GelfMessageBuilder (logstash logging connectors 1.15.2-SNAPSHOT API)

java.lang.Object
- biz.paluch.logging.gelf.GelfMessageBuilder

Direct Known Subclasses:

PoolingGelfMessageBuilder
```
public class GelfMessageBuilder
extends Object
```
Builder to create a GelfMessage.

Since:

18.07.14 20:52

Author:

Mark Paluch, Thomas Herzog

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,String>`	`additionalFields`
`protected Map<String,String>`	`additionalFieldTypes`
`protected Map<Pattern,String>`	`dynamicMdcFieldTypes`
`protected String`	`facility`
`protected String`	`fullMessage`
`protected String`	`host`
`protected long`	`javaTimestamp`
`protected String`	`level`
`protected int`	`maximumMessageSize`
`protected String`	`shortMessage`
`protected String`	`version`

Constructor Summary

Constructors
Modifier Constructor and Description

protected GelfMessageBuilder()

Constructors
Modifier	Constructor and Description
`protected`	`GelfMessageBuilder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GelfMessage`	`build()` Build a new Gelf message based on the builder settings.
`static GelfMessageBuilder`	`newInstance()` Creates a new instance of the GelfMessageBuilder.
`GelfMessageBuilder`	`withAdditionalFieldTypes(Map<String,String> additionalFieldTypes)` Set additional field types
`GelfMessageBuilder`	`withDynamicMdcFieldTypes(Map<Pattern,String> dynamicMdcFieldTypes)` Set dynamic mdc field types
`GelfMessageBuilder`	`withFacility(String facility)` Set the facility.
`GelfMessageBuilder`	`withField(String key, String value)` Add an additional field.
`GelfMessageBuilder`	`withFields(Map<String,String> additionalFields)` Add additional fields.
`GelfMessageBuilder`	`withFullMessage(String fullMessage)` Set the full_message.
`GelfMessageBuilder`	`withHost(String host)` Set the host.
`GelfMessageBuilder`	`withJavaTimestamp(long javaTimestamp)` Set the java timestamp (millis).
`GelfMessageBuilder`	`withLevel(String level)` Set the level (severity).
`GelfMessageBuilder`	`withMaximumMessageSize(int maximumMessageSize)` Set the max message size.
`GelfMessageBuilder`	`withShortMessage(String shortMessage)` Set the short_message.
`GelfMessageBuilder`	`withVersion(String version)` Set the version.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - version
```
protected String version
```
  - host
```
protected String host
```
  - shortMessage
```
protected String shortMessage
```
  - fullMessage
```
protected String fullMessage
```
  - javaTimestamp
```
protected long javaTimestamp
```
  - level
```
protected String level
```
  - facility
```
protected String facility
```
  - maximumMessageSize
```
protected int maximumMessageSize
```
  - additionalFields
```
protected Map<String,String> additionalFields
```
  - additionalFieldTypes
```
protected Map<String,String> additionalFieldTypes
```
  - dynamicMdcFieldTypes
```
protected Map<Pattern,String> dynamicMdcFieldTypes
```
- Constructor Detail
  - GelfMessageBuilder
```
protected GelfMessageBuilder()
```
- Method Detail
  - newInstance
```
public static GelfMessageBuilder newInstance()
```
    Creates a new instance of the GelfMessageBuilder.
    
    Returns:
    
    GelfMessageBuilder
  - withVersion
```
public GelfMessageBuilder withVersion(String version)
```
    Set the version.
    
    Parameters:
    
    version - the version
    
    Returns:
    
    GelfMessageBuilder
  - withHost
```
public GelfMessageBuilder withHost(String host)
```
    Set the host.
    
    Parameters:
    
    host - the host
    
    Returns:
    
    GelfMessageBuilder
  - withShortMessage
```
public GelfMessageBuilder withShortMessage(String shortMessage)
```
    Set the short_message.
    
    Parameters:
    
    shortMessage - the short_message
    
    Returns:
    
    GelfMessageBuilder
  - withFullMessage
```
public GelfMessageBuilder withFullMessage(String fullMessage)
```
    Set the full_message.
    
    Parameters:
    
    fullMessage - the fullMessage
    
    Returns:
    
    GelfMessageBuilder
  - withLevel
```
public GelfMessageBuilder withLevel(String level)
```
    Set the level (severity).
    
    Parameters:
    
    level - the level
    
    Returns:
    
    GelfMessageBuilder
  - withFacility
```
public GelfMessageBuilder withFacility(String facility)
```
    Set the facility.
    
    Parameters:
    
    facility - the facility
    
    Returns:
    
    GelfMessageBuilder
  - withMaximumMessageSize
```
public GelfMessageBuilder withMaximumMessageSize(int maximumMessageSize)
```
    Set the max message size.
    
    Parameters:
    
    maximumMessageSize - the maximumMessageSize
    
    Returns:
    
    GelfMessageBuilder
  - withJavaTimestamp
```
public GelfMessageBuilder withJavaTimestamp(long javaTimestamp)
```
    Set the java timestamp (millis).
    
    Parameters:
    
    javaTimestamp - the javaTimestamp
    
    Returns:
    
    GelfMessageBuilder
  - withFields
```
public GelfMessageBuilder withFields(Map<String,String> additionalFields)
```
    Add additional fields.
    
    Parameters:
    
    additionalFields - the additionalFields
    
    Returns:
    
    GelfMessageBuilder
  - withField
```
public GelfMessageBuilder withField(String key,
                                    String value)
```
    Add an additional field.
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Returns:
    
    GelfMessageBuilder
  - withAdditionalFieldTypes
```
public GelfMessageBuilder withAdditionalFieldTypes(Map<String,String> additionalFieldTypes)
```
    Set additional field types
    
    Parameters:
    
    additionalFieldTypes - the type map
    
    Returns:
    
    GelfMessageBuilder
  - withDynamicMdcFieldTypes
```
public GelfMessageBuilder withDynamicMdcFieldTypes(Map<Pattern,String> dynamicMdcFieldTypes)
```
    Set dynamic mdc field types
    
    Parameters:
    
    dynamicMdcFieldTypes - the type map
    
    Returns:
    
    GelfMessageBuilder
  - build
```
public GelfMessage build()
```
    Build a new Gelf message based on the builder settings.
    
    Returns:
    
    GelfMessage

Class GelfMessageBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

host

shortMessage

fullMessage

javaTimestamp

level

facility

maximumMessageSize

additionalFields

additionalFieldTypes

dynamicMdcFieldTypes

Constructor Detail

GelfMessageBuilder

Method Detail

newInstance

withVersion

withHost

withShortMessage

withFullMessage

withLevel

withFacility

withMaximumMessageSize

withJavaTimestamp

withFields

withField

withAdditionalFieldTypes

withDynamicMdcFieldTypes

build