Interface ParseKeyValue.Builder

    • Method Detail

      • source

        ParseKeyValue.Builder source​(String source)

        Path to the field in the log event that will be parsed. Use dot notation to access child fields. For example, store.book

        Parameters:
        source - Path to the field in the log event that will be parsed. Use dot notation to access child fields. For example, store.book
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • destination

        ParseKeyValue.Builder destination​(String destination)

        The destination field to put the extracted key-value pairs into

        Parameters:
        destination - The destination field to put the extracted key-value pairs into
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • fieldDelimiter

        ParseKeyValue.Builder fieldDelimiter​(String fieldDelimiter)

        The field delimiter string that is used between key-value pairs in the original log events. If you omit this, the ampersand & character is used.

        Parameters:
        fieldDelimiter - The field delimiter string that is used between key-value pairs in the original log events. If you omit this, the ampersand & character is used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • keyValueDelimiter

        ParseKeyValue.Builder keyValueDelimiter​(String keyValueDelimiter)

        The delimiter string to use between the key and value in each pair in the transformed log event.

        If you omit this, the equal = character is used.

        Parameters:
        keyValueDelimiter - The delimiter string to use between the key and value in each pair in the transformed log event.

        If you omit this, the equal = character is used.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • keyPrefix

        ParseKeyValue.Builder keyPrefix​(String keyPrefix)

        If you want to add a prefix to all transformed keys, specify it here.

        Parameters:
        keyPrefix - If you want to add a prefix to all transformed keys, specify it here.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • nonMatchValue

        ParseKeyValue.Builder nonMatchValue​(String nonMatchValue)

        A value to insert into the value field in the result, when a key-value pair is not successfully split.

        Parameters:
        nonMatchValue - A value to insert into the value field in the result, when a key-value pair is not successfully split.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • overwriteIfExists

        ParseKeyValue.Builder overwriteIfExists​(Boolean overwriteIfExists)

        Specifies whether to overwrite the value if the destination key already exists. If you omit this, the default is false.

        Parameters:
        overwriteIfExists - Specifies whether to overwrite the value if the destination key already exists. If you omit this, the default is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.