Add parse XML docs #6822
Merged
Add parse XML docs #6822
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Liz Snyder <[email protected]>
lizsnyder
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
graytaylor0
reviewed
Apr 1, 2024
Signed-off-by: Liz Snyder <[email protected]>
kolchfa-aws
approved these changes
Apr 1, 2024
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Liz Snyder <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Liz Snyder <[email protected]>
Signed-off-by: Liz Snyder <[email protected]>
natebower
reviewed
Apr 2, 2024
There was a problem hiding this comment.
@lizsnyder @kolchfa-aws Just a few comments/changes. Thanks!
|
|
||
| | Option | Required | Type | Description | | ||
| | :--- | :--- | :--- | :--- | | ||
| | `source` | No | String | The field in the `event` object that is parsed. Default value is `message`. | |
There was a problem hiding this comment.
As written, it's not clear whether the field or the object is parsed.
| | `source` | No | String | The field in the `event` object that is parsed. Default value is `message`. | | ||
| | `destination` | No | String | The destination field of the parsed XML. Defaults to the root of the `event`. Cannot be `""`, `/`, or any white-space-only string because these are not valid `event` fields. | | ||
| | `pointer` | No | String | A JSON pointer to the field to be parsed. The value is null by default, meaning that the entire `source` is parsed. The `pointer` can access JSON array indexes as well. If the JSON pointer is invalid, then the entire `source` data is parsed into the outgoing `event` object. If the key that is pointed to already exists in the `event` object and the `destination` is the root, then the pointer uses the entire path of the key. | | ||
| | `parse_when` | No | String | Specifies under what conditions the processor should perform parsing. Default is no condition. Accepts a Data Prepper expression string following the [Data Prepper Expression Syntax]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/expression-syntax/). | |
There was a problem hiding this comment.
Suggested change
| | `parse_when` | No | String | Specifies under what conditions the processor should perform parsing. Default is no condition. Accepts a Data Prepper expression string following the [Data Prepper Expression Syntax]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/expression-syntax/). | | |
| | `parse_when` | No | String | Specifies under what conditions the processor should perform parsing using the [Data Prepper expression syntax]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/expression-syntax/). Default is no condition. | |
| | `source` | No | String | The field in the `event` object that is parsed. Default value is `message`. | | ||
| | `destination` | No | String | The destination field of the parsed XML. Defaults to the root of the `event`. Cannot be `""`, `/`, or any white-space-only string because these are not valid `event` fields. | | ||
| | `pointer` | No | String | A JSON pointer to the field to be parsed. The value is null by default, meaning that the entire `source` is parsed. The `pointer` can access JSON array indexes as well. If the JSON pointer is invalid, then the entire `source` data is parsed into the outgoing `event` object. If the key that is pointed to already exists in the `event` object and the `destination` is the root, then the pointer uses the entire path of the key. | | ||
| | `parse_when` | No | String | Specifies under what conditions the processor should perform parsing. Default is no condition. Accepts a Data Prepper expression string following the [Data Prepper Expression Syntax]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/expression-syntax/). | |
There was a problem hiding this comment.
"Following" can be read as either "after" or "in accordance with" here.
Naarcha-AWS
reviewed
Apr 2, 2024
Naarcha-AWS
added
5 - Editorial review
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
approved these changes
Apr 2, 2024
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Apr 2, 2024
* Add parse XML docs Signed-off-by: Liz Snyder <[email protected]> * Add parse_when Signed-off-by: Liz Snyder <[email protected]> * Update _data-prepper/pipelines/configuration/processors/parse-xml.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Liz Snyder <[email protected]> * Update _data-prepper/pipelines/configuration/processors/parse-xml.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Liz Snyder <[email protected]> * Tweaks Signed-off-by: Liz Snyder <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Liz Snyder <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> (cherry picked from commit 7bbea74) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Naarcha-AWS
added a commit
that referenced
this pull request
Apr 2, 2024
* Add parse XML docs * Add parse_when * Update _data-prepper/pipelines/configuration/processors/parse-xml.md * Update _data-prepper/pipelines/configuration/processors/parse-xml.md * Tweaks * Apply suggestions from code review --------- (cherry picked from commit 7bbea74) Signed-off-by: Liz Snyder <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]>
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds docs for parse_xml processor:
Issues Resolved
N/A
Closes #6530
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.