StructuredDataLookup (Apache Log4j 2 2.17.2 API)

java.lang.Object
- org.apache.logging.log4j.core.lookup.StructuredDataLookup

All Implemented Interfaces:: StrLookup

@Plugin(name="sd",
        category="Lookup")
public class StructuredDataLookup
extends Object
implements StrLookup

Looks up keys from StructuredDataMessage log messages.

Field Summary

Fields
Modifier and Type Field Description

static String ID_KEY
Key to obtain the id of a structured message.

static String TYPE_KEY
Key to obtain the type of a structured message.
- Fields inherited from interface org.apache.logging.log4j.core.lookup.StrLookup
  CATEGORY

Constructor Summary

Constructors
Constructor Description

StructuredDataLookup()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`lookup(String key)`	Returns `null`.
`String`	`lookup(LogEvent event, String key)`	Looks up the value for the key using the data in the LogEvent.

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

Methods inherited from interface org.apache.logging.log4j.core.lookup.StrLookup
evaluate, evaluate

- Field Detail
  - ID_KEY
```
public static final String ID_KEY
```
    Key to obtain the id of a structured message.
    
    See Also:
    
    Constant Field Values
  - TYPE_KEY
```
public static final String TYPE_KEY
```
    Key to obtain the type of a structured message.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StructuredDataLookup
```
public StructuredDataLookup()
```
- Method Detail
  - lookup
```
public String lookup(String key)
```
    Returns null. This Lookup plugin does not make sense outside the context of a LogEvent.
    
    Specified by:
    
    lookup in interface StrLookup
    
    Parameters:
    
    key - The key to be looked up, may be null.
    
    Returns:
    
    null
  - lookup
```
public String lookup(LogEvent event,
                     String key)
```
    Looks up the value for the key using the data in the LogEvent.
    
    Specified by:
    
    lookup in interface StrLookup
    
    Parameters:
    
    event - The current LogEvent.
    
    key - The key to be looked up, may be null.
    
    Returns:
    
    The value associated with the key.