[DOC] Add set processor documentation #5989
Merged
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: Melissa Vagi <vagimeli@amazon.com>
vagimeli
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki and
natebower
as code owners
vagimeli
added
Needs SME
|
@hdhalter We need a dev to take the first pass at drafting this content. I can support them in refining the content and getting it through the documentation process. The ingest processor template is provided with this PR, so it should help the dev get started. Thanks! |
45 tasks
vagimeli
requested review from
dlvenable,
stephen-crawford and
epugh
as code owners
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
|
@gaobinlong This PR is ready for your review at your availability. Thank you for all your technical reviews on these topics! |
vagimeli
added
3 - Tech review
Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
gaobinlong
reviewed
May 31, 2024
_ingest-pipelines/processors/set.md
Outdated
|
|
||
| # Set processor | ||
|
|
||
| The `set` processor adds or updates fields in a document. It sets one field and associates it with the specified value. If the field already exists, its value is replaced with the provided one. |
There was a problem hiding this comment.
If the field already exists, its value is replaced with the provided one
This is not always true, because if the parameter override is set to false and the specified field exists, the value of the field will not change.
_ingest-pipelines/processors/set.md
Outdated
| `field` | Required | The name of the field to be set or updated. Supports [template snippets]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/#template-snippets). | ||
| `value` | Required | The value to be assigned to the field. Supports [template snippets]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/#template-snippets). | ||
| `overrideEnabled` | Optional | A Boolean flag that determines whether the processor should override the exisitng value of the field. | ||
| `ignoreEmptyValue` | Optional | A Boolean flag that determines whether the processor should ignore empty values. |
There was a problem hiding this comment.
ignoreEmptyValue should be ignore_empty_value, defaults to false, empty value means null or empty string.
vagimeli
commented
Jun 6, 2024
vagimeli
commented
Jun 6, 2024
vagimeli
commented
Jun 6, 2024
vagimeli
commented
Jun 6, 2024
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
added
5 - Editorial review
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
|
@natebower Thank you for the thorough review. I've accepted your edits. Will you approve for merging? This is part of the series that I opened PRs and co-authored with dev, but can't approve. Thank you. |
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jun 10, 2024
* Add set processor documentation Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * add text and examples Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * add text and examples Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update set.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/set.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/set.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/set.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/set.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/set.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/set.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> --------- Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit 7df5fee) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
RasonJ
pushed a commit
to o19s/documentation-website
that referenced
this pull request
Jun 12, 2024
* Add set processor documentation Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * add text and examples Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * add text and examples Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update set.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/set.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/set.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/set.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/set.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/set.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/set.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> --------- Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com>
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
Closes content gap
Issues Resolved
#4647
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.