Interface StructuredParameter

All Known Implementing Classes:
KeyValueParameter

public interface StructuredParameter
A structured parameter usable as logging payload.

Any instance of StructuredParameter can be passed as a log parameter to the *f family of logging functions on Logger.

Example:

StructuredParameter p1 = ...;
StructuredParameter p2 = ...;

logger.logf("Something interesting happened.", p1, p2);
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.json.JsonObjectBuilder
    The JSON to be embedded in the payload of the log entry.
  • Method Details

    • json

      jakarta.json.JsonObjectBuilder json()
      The JSON to be embedded in the payload of the log entry.

      May contain multiple keys and values as well as nested objects. Each top-level entry of the returned object is embedded as a top-level entry in the payload of the log entry.

      Returns:
      A JsonObjectBuilder holding a set of key–value pairs.