Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-12254 clarify Bulk operation header documentation for PutElasticsearchRecord and PutElasticsearchJson processors 

Signed-off-by: Pierre Villard <pierre.villard.fr@gmail.com>

This closes #7912.
This commit is contained in:
Chris Sampson 2023-10-20 00:04:52 +01:00 committed by Pierre Villard
parent 9e5892780a
commit 6c7d02e22e
No known key found for this signature in database
GPG Key ID: F92A93B30C07C6D5
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/PutElasticsearchJson.java
View File

@ -58,7 +58,8 @@ import java.util.stream.Collectors;
@InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED) @InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED)
@Tags({"json", "elasticsearch", "elasticsearch5", "elasticsearch6", "elasticsearch7", "elasticsearch8", "put", "index"}) @Tags({"json", "elasticsearch", "elasticsearch5", "elasticsearch6", "elasticsearch7", "elasticsearch8", "put", "index"})
@CapabilityDescription("An Elasticsearch put processor that uses the official Elastic REST client libraries.") @CapabilityDescription("An Elasticsearch put processor that uses the official Elastic REST client libraries. " +
"Each FlowFile is treated as a document to be sent to the Elasticsearch _bulk API. Multiple FlowFiles can be batched together into each Request sent to Elasticsearch.")
@WritesAttributes({ @WritesAttributes({
@WritesAttribute(attribute = "elasticsearch.put.error", @WritesAttribute(attribute = "elasticsearch.put.error",
description = "The error message if there is an issue parsing the FlowFile, sending the parsed document to Elasticsearch or parsing the Elasticsearch response"), description = "The error message if there is an issue parsing the FlowFile, sending the parsed document to Elasticsearch or parsing the Elasticsearch response"),
@ -72,6 +73,7 @@ import java.util.stream.Collectors;
expressionLanguageScope = ExpressionLanguageScope.FLOWFILE_ATTRIBUTES, expressionLanguageScope = ExpressionLanguageScope.FLOWFILE_ATTRIBUTES,
description = "Prefix: " + AbstractPutElasticsearch.BULK_HEADER_PREFIX + description = "Prefix: " + AbstractPutElasticsearch.BULK_HEADER_PREFIX +
" - adds the specified property name/value as a Bulk request header in the Elasticsearch Bulk API body used for processing. " + " - adds the specified property name/value as a Bulk request header in the Elasticsearch Bulk API body used for processing. " +
"If the value is null or blank, the Bulk header will be omitted for the document operation. " +
"These parameters will override any matching parameters in the _bulk request body."), "These parameters will override any matching parameters in the _bulk request body."),
@DynamicProperty( @DynamicProperty(
name = "The name of a URL query parameter to add", name = "The name of a URL query parameter to add",

7
nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/PutElasticsearchRecord.java
View File

@ -86,7 +86,9 @@ import java.util.stream.Collectors;
@InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED) @InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED)
@Tags({"json", "elasticsearch", "elasticsearch5", "elasticsearch6", "elasticsearch7", "elasticsearch8", "put", "index", "record"}) @Tags({"json", "elasticsearch", "elasticsearch5", "elasticsearch6", "elasticsearch7", "elasticsearch8", "put", "index", "record"})
@CapabilityDescription("A record-aware Elasticsearch put processor that uses the official Elastic REST client libraries.") @CapabilityDescription("A record-aware Elasticsearch put processor that uses the official Elastic REST client libraries. " +
"Each Record within the FlowFile is converted into a document to be sent to the Elasticsearch _bulk APi. " +
"Multiple documents can be batched into each Request sent to Elasticsearch. Each document's Bulk operation can be configured using Record Path expressions.")
@WritesAttributes({ @WritesAttributes({
@WritesAttribute(attribute = "elasticsearch.put.error", @WritesAttribute(attribute = "elasticsearch.put.error",
description = "The error message if there is an issue parsing the FlowFile records, sending the parsed documents to Elasticsearch or parsing the Elasticsearch response."), description = "The error message if there is an issue parsing the FlowFile records, sending the parsed documents to Elasticsearch or parsing the Elasticsearch response."),
@ -98,10 +100,11 @@ import java.util.stream.Collectors;
@DynamicProperties({ @DynamicProperties({
@DynamicProperty( @DynamicProperty(
name = "The name of the Bulk request header", name = "The name of the Bulk request header",
value = "The value of the Bulk request header", value = "A Record Path expression to retrieve the Bulk request header value",
expressionLanguageScope = ExpressionLanguageScope.FLOWFILE_ATTRIBUTES, expressionLanguageScope = ExpressionLanguageScope.FLOWFILE_ATTRIBUTES,
description = "Prefix: " + AbstractPutElasticsearch.BULK_HEADER_PREFIX + description = "Prefix: " + AbstractPutElasticsearch.BULK_HEADER_PREFIX +
" - adds the specified property name/value as a Bulk request header in the Elasticsearch Bulk API body used for processing. " + " - adds the specified property name/value as a Bulk request header in the Elasticsearch Bulk API body used for processing. " +
"If the Record Path expression results in a null or blank value, the Bulk header will be omitted for the document operation. " +
"These parameters will override any matching parameters in the _bulk request body."), "These parameters will override any matching parameters in the _bulk request body."),
@DynamicProperty( @DynamicProperty(
name = "The name of a URL query parameter to add", name = "The name of a URL query parameter to add",