Struct ParseKeyValueBuilder

#[non_exhaustive]
pub struct ParseKeyValueBuilder { /* private fields */ }

A builder for ParseKeyValue.

Implementations

impl ParseKeyValueBuilder

pub fn source(self, input: impl Into<String>) -> Self

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

pub fn set_source(self, input: Option<String>) -> Self

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

pub fn get_source(&self) -> &Option<String>

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

pub fn destination(self, input: impl Into<String>) -> Self

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

pub fn set_destination(self, input: Option<String>) -> Self

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

pub fn get_destination(&self) -> &Option<String>

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

pub fn field_delimiter(self, input: impl Into<String>) -> Self

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.

pub fn set_field_delimiter(self, input: Option<String>) -> Self

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.

pub fn get_field_delimiter(&self) -> &Option<String>

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.

pub fn key_value_delimiter(self, input: impl Into<String>) -> Self

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.

pub fn set_key_value_delimiter(self, input: Option<String>) -> Self

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.

pub fn get_key_value_delimiter(&self) -> &Option<String>

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.

pub fn key_prefix(self, input: impl Into<String>) -> Self

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

pub fn set_key_prefix(self, input: Option<String>) -> Self

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

pub fn get_key_prefix(&self) -> &Option<String>

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

pub fn non_match_value(self, input: impl Into<String>) -> Self

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

pub fn set_non_match_value(self, input: Option<String>) -> Self

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

pub fn get_non_match_value(&self) -> &Option<String>

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

pub fn overwrite_if_exists(self, input: bool) -> Self

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

pub fn set_overwrite_if_exists(self, input: Option<bool>) -> Self

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

pub fn get_overwrite_if_exists(&self) -> &Option<bool>

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

pub fn build(self) -> ParseKeyValue

Consumes the builder and constructs a ParseKeyValue.

Trait Implementations

impl Clone for ParseKeyValueBuilder

fn clone(&self) -> ParseKeyValueBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParseKeyValueBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ParseKeyValueBuilder

fn default() -> ParseKeyValueBuilder

Returns the “default value” for a type.

impl PartialEq for ParseKeyValueBuilder

fn eq(&self, other: &ParseKeyValueBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ParseKeyValueBuilder