Files
OpenSearch-Docs-Cn/_data-prepper/configuration/processors/substitute-string.md
T
Caroline f64e9dccb4 Restructure Data Prepper plugins documentation (#2073)
* Removed content from Data Prepper reference and broke out into separate pages.

Signed-off-by: carolxob <[email protected]>

* Checking in file to make sure it's the right version.

Signed-off-by: carolxob <[email protected]>

* Minor update.

Signed-off-by: carolxob <[email protected]>

* Updated files.

Signed-off-by: carolxob <[email protected]>

* Adding Sinks file.

Signed-off-by: carolxob <[email protected]>

* Added file to PR.

Signed-off-by: carolxob <[email protected]>

* Corrected TOC hierarchy.

Signed-off-by: carolxob <[email protected]>

* Added images and reorganized files.

Signed-off-by: carolxob <[email protected]>

* Reconfigured some content based on David's feedback.

Signed-off-by: carolxob <[email protected]>

* Modified reference page.

Signed-off-by: carolxob <[email protected]>

* Fixed minor heading issue.

Signed-off-by: carolxob <[email protected]>

* Minor edits.

Signed-off-by: carolxob <[email protected]>

* Major edits, files created, moved, and content broken out from main config page.

Signed-off-by: carolxob <[email protected]>

* Adding key value and processors pages to the PR.

Signed-off-by: carolxob <[email protected]>

* Basic ToC reorg.

Signed-off-by: carolxob <[email protected]>

* ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor update.:

Signed-off-by: carolxob <[email protected]>

* Minor edits to ToC again.

Signed-off-by: carolxob <[email protected]>

* Minor updates.

Signed-off-by: carolxob <[email protected]>

* Minor TOC update

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates

Signed-off-by: carolxob <[email protected]>

* Minor ToC changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC edits.

Signed-off-by: carolxob <[email protected]>

* Changed filename.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates

Signed-off-by: carolxob <[email protected]>

* Making small Toc changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Added comment blocks for Config and Metrics sections.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates to add Sinks and Sources under config guide.

Signed-off-by: carolxob <[email protected]>

Signed-off-by: carolxob <[email protected]>
2022-12-27 14:58:48 -08:00

28 lines
1.1 KiB
Markdown

---
layout: default
title: substitute_string
parent: Processors
grand_parent: Configuring Data Prepper
nav_order: 45
---
# substitute_string
## Overview
Matches a key's value against a regular expression and replaces all matches with a replacement string. `substitute_string` is part of [mutate string](https://github.com/opensearch-project/data-prepper/tree/main/data-prepper-plugins/mutate-string-processors#mutate-string-processors) processors.
Option | Required | Type | Description
:--- | :--- | :--- | :---
entries | Yes | List | List of entries. Valid values are `source`, `from`, and `to`.
source | N/A | N/A | The key to modify.
from | N/A | N/A | The Regex String to be replaced. Special regex characters such as `[` and `]` must be escaped using `\\` when using double quotes and `\ ` when using single quotes. See [Java Patterns](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html) for more information.
to | N/A | N/A | The String to be substituted for each match of `from`.
<!---## Configuration
Content will be added to this section.
## Metrics
Content will be added to this section.--->