Skip to content

Commit 6bee116

Browse files
dan-s1dan-s1
authored
NIFI-15881 Replaced non-standard spelling of FlowFile in documentation (#11180)
Signed-off-by: David Handermann <exceptionfactory@apache.org>
1 parent f1f3ee9 commit 6bee116

35 files changed

Lines changed: 112 additions & 112 deletions

File tree

‎nifi-extension-bundles/nifi-aws-bundle/nifi-aws-processors/src/main/java/org/apache/nifi/processors/aws/lambda/PutLambda.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,11 +201,11 @@ public void migrateProperties(PropertyConfiguration config) {
201201
}
202202

203203
/**
204-
* Populate exception attributes in the flow file
204+
* Populate exception attributes in the FlowFile
205205
* @param session process session
206-
* @param flowFile the flow file
206+
* @param flowFile the FlowFile
207207
* @param exception exception thrown during invocation
208-
* @return FlowFile the updated flow file
208+
* @return FlowFile the updated FlowFile
209209
*/
210210
private FlowFile populateExceptionAttributes(final ProcessSession session, FlowFile flowFile,
211211
final AwsServiceException exception) {

‎nifi-extension-bundles/nifi-aws-bundle/nifi-aws-processors/src/main/java/org/apache/nifi/processors/aws/s3/ListS3.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,9 +127,9 @@
127127
@WritesAttribute(attribute = "s3.storeClass", description = "The storage class of the object"),
128128
@WritesAttribute(attribute = "s3.version", description = "The version of the object, if applicable"),
129129
@WritesAttribute(attribute = "s3.tag.___", description = "If 'Write Object Tags' is set to 'True', the tags associated to the S3 object that is being listed " +
130-
"will be written as part of the flowfile attributes"),
130+
"will be written as part of the FlowFile attributes"),
131131
@WritesAttribute(attribute = "s3.user.metadata.___", description = "If 'Write User Metadata' is set to 'True', the user defined metadata associated to the S3 object that is being listed " +
132-
"will be written as part of the flowfile attributes")})
132+
"will be written as part of the FlowFile attributes")})
133133
@DefaultSchedule(strategy = SchedulingStrategy.TIMER_DRIVEN, period = "1 min")
134134
public class ListS3 extends AbstractS3Processor implements VerifiableProcessor {
135135

‎nifi-extension-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/services/azure/data/explorer/StandardKustoIngestService.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
import java.util.Optional;
6060

6161
@Tags({"Azure", "Data", "Explorer", "ADX", "Kusto", "ingest", "azure"})
62-
@CapabilityDescription("Sends batches of flowfile content or stream flowfile content to an Azure ADX cluster.")
62+
@CapabilityDescription("Sends batches of FlowFile content or stream FlowFile content to an Azure ADX cluster.")
6363
public class StandardKustoIngestService extends AbstractControllerService implements KustoIngestService {
6464

6565
public static final PropertyDescriptor AUTHENTICATION_STRATEGY = new PropertyDescriptor.Builder()

‎nifi-extension-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/AbstractByQueryElasticsearch.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@
4343

4444
public abstract class AbstractByQueryElasticsearch extends AbstractProcessor implements ElasticsearchRestProcessor {
4545
public static final Relationship REL_FAILURE = new Relationship.Builder().name("failure")
46-
.description("If the \"by query\" operation fails, and a flowfile was read, it will be sent to this relationship.")
46+
.description("If the \"by query\" operation fails, and a FlowFile was read, it will be sent to this relationship.")
4747
.build();
4848

4949
public static final Relationship REL_SUCCESS = new Relationship.Builder().name("success")
50-
.description("If the \"by query\" operation succeeds, and a flowfile was read, it will be sent to this relationship.")
50+
.description("If the \"by query\" operation succeeds, and a FlowFile was read, it will be sent to this relationship.")
5151
.build();
5252

5353
private static final Set<Relationship> relationships = Set.of(REL_SUCCESS, REL_FAILURE, REL_RETRY);

‎nifi-extension-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/AbstractJsonQueryElasticsearch.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public abstract class AbstractJsonQueryElasticsearch<Q extends JsonQueryParamete
6363

6464
public static final PropertyDescriptor SEARCH_RESULTS_SPLIT = new PropertyDescriptor.Builder()
6565
.name("Search Results Split")
66-
.description("Output a flowfile containing all hits or one flowfile for each individual hit.")
66+
.description("Output a FlowFile containing all hits or one FlowFile for each individual hit.")
6767
.allowableValues(ResultOutputStrategy.getNonPaginatedResponseOutputStrategies())
6868
.defaultValue(ResultOutputStrategy.PER_RESPONSE)
6969
.required(true)
@@ -80,7 +80,7 @@ public abstract class AbstractJsonQueryElasticsearch<Q extends JsonQueryParamete
8080
.build();
8181
public static final PropertyDescriptor AGGREGATION_RESULTS_SPLIT = new PropertyDescriptor.Builder()
8282
.name("Aggregation Results Split")
83-
.description("Output a flowfile containing all aggregations or one flowfile for each individual aggregation.")
83+
.description("Output a FlowFile containing all aggregations or one FlowFile for each individual aggregation.")
8484
.allowableValues(ResultOutputStrategy.getNonPaginatedResponseOutputStrategies())
8585
.defaultValue(ResultOutputStrategy.PER_RESPONSE)
8686
.required(true)
@@ -97,8 +97,8 @@ public abstract class AbstractJsonQueryElasticsearch<Q extends JsonQueryParamete
9797
.build();
9898
public static final PropertyDescriptor OUTPUT_NO_HITS = new PropertyDescriptor.Builder()
9999
.name("Output No Hits")
100-
.description("Output a \"" + REL_HITS.getName() + "\" flowfile even if no hits found for query. " +
101-
"If true, an empty \"" + REL_HITS.getName() + "\" flowfile will be output even if \"" +
100+
.description("Output a \"" + REL_HITS.getName() + "\" FlowFile even if no hits found for query. " +
101+
"If true, an empty \"" + REL_HITS.getName() + "\" FlowFile will be output even if \"" +
102102
REL_AGGREGATIONS.getName() + "\" are output.")
103103
.allowableValues("true", "false")
104104
.defaultValue("false")

‎nifi-extension-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/AbstractPaginatedJsonQueryElasticsearch.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
public abstract class AbstractPaginatedJsonQueryElasticsearch extends AbstractJsonQueryElasticsearch<PaginatedJsonQueryParameters> {
4848
public static final PropertyDescriptor SEARCH_RESULTS_SPLIT = new PropertyDescriptor.Builder()
4949
.fromPropertyDescriptor(AbstractJsonQueryElasticsearch.SEARCH_RESULTS_SPLIT)
50-
.description("Output a flowfile containing all hits or one flowfile for each individual hit " +
51-
"or one flowfile containing all hits from all paged responses.")
50+
.description("Output a FlowFile containing all hits or one FlowFile for each individual hit " +
51+
"or one FlowFile containing all hits from all paged responses.")
5252
.allowableValues(ResultOutputStrategy.class)
5353
.build();
5454

‎nifi-extension-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/ConsumeElasticsearch.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@
5959

6060
@WritesAttributes({
6161
@WritesAttribute(attribute = "mime.type", description = "application/json"),
62-
@WritesAttribute(attribute = "page.number", description = "The number of the page (request), starting from 1, in which the results were returned that are in the output flowfile"),
63-
@WritesAttribute(attribute = "hit.count", description = "The number of hits that are in the output flowfile"),
62+
@WritesAttribute(attribute = "page.number", description = "The number of the page (request), starting from 1, in which the results were returned that are in the output FlowFile"),
63+
@WritesAttribute(attribute = "hit.count", description = "The number of hits that are in the output FlowFile"),
6464
@WritesAttribute(attribute = "elasticsearch.query.error", description = "The error message provided by Elasticsearch if there is an error querying the index.")
6565
})
6666
@InputRequirement(InputRequirement.Requirement.INPUT_FORBIDDEN)

‎nifi-extension-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/DeleteByQueryElasticsearch.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
@InputRequirement(InputRequirement.Requirement.INPUT_ALLOWED)
4141
@SupportsBatching
4242
@Tags({ "elastic", "elasticsearch", "elasticsearch7", "elasticsearch8", "elasticsearch9", "delete", "query"})
43-
@CapabilityDescription("Delete from an Elasticsearch index using a query. The query can be loaded from a flowfile body " +
43+
@CapabilityDescription("Delete from an Elasticsearch index using a query. The query can be loaded from a FlowFile body " +
4444
"or from the Query parameter.")
4545
@DynamicProperties({
4646
@DynamicProperty(

‎nifi-extension-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/ElasticsearchRestProcessor.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ public interface ElasticsearchRestProcessor extends Processor, VerifiableProcess
9292
PropertyDescriptor QUERY = new PropertyDescriptor.Builder()
9393
.name("Query")
9494
.description("A query in JSON syntax, not Lucene syntax. Ex: {\"query\":{\"match\":{\"somefield\":\"somevalue\"}}}. " +
95-
"If this parameter is not set, the query will be read from the flowfile content. " +
96-
"If the query (property and flowfile content) is empty, a default empty JSON Object will be used, " +
95+
"If this parameter is not set, the query will be read from the FlowFile content. " +
96+
"If the query (property and FlowFile content) is empty, a default empty JSON Object will be used, " +
9797
"which will result in a \"match_all\" query in Elasticsearch.")
9898
.dependsOn(QUERY_DEFINITION_STYLE, QueryDefinitionType.FULL_QUERY)
9999
.required(false)
@@ -174,7 +174,7 @@ public interface ElasticsearchRestProcessor extends Processor, VerifiableProcess
174174

175175
PropertyDescriptor QUERY_ATTRIBUTE = new PropertyDescriptor.Builder()
176176
.name("Query Attribute")
177-
.description("If set, the executed query will be set on each result flowfile in the specified attribute.")
177+
.description("If set, the executed query will be set on each result FlowFile in the specified attribute.")
178178
.expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES)
179179
.addValidator(Validator.VALID)
180180
.required(false)

‎nifi-extension-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/JsonQueryElasticsearch.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,17 @@
4040

4141
@WritesAttributes({
4242
@WritesAttribute(attribute = "mime.type", description = "application/json"),
43-
@WritesAttribute(attribute = "aggregation.name", description = "The name of the aggregation whose results are in the output flowfile"),
44-
@WritesAttribute(attribute = "aggregation.number", description = "The number of the aggregation whose results are in the output flowfile"),
45-
@WritesAttribute(attribute = "hit.count", description = "The number of hits that are in the output flowfile"),
43+
@WritesAttribute(attribute = "aggregation.name", description = "The name of the aggregation whose results are in the output FlowFile"),
44+
@WritesAttribute(attribute = "aggregation.number", description = "The number of the aggregation whose results are in the output FlowFile"),
45+
@WritesAttribute(attribute = "hit.count", description = "The number of hits that are in the output FlowFile"),
4646
@WritesAttribute(attribute = "elasticsearch.query.error", description = "The error message provided by Elasticsearch if there is an error querying the index.")
4747
})
4848
@InputRequirement(InputRequirement.Requirement.INPUT_ALLOWED)
4949
@SupportsBatching
5050
@Tags({"elasticsearch", "elasticsearch7", "elasticsearch8", "elasticsearch9", "query", "read", "get", "json"})
5151
@CapabilityDescription("A processor that allows the user to run a query (with aggregations) written with the " +
5252
"Elasticsearch JSON DSL. It does not automatically paginate queries for the user. If an incoming relationship is added to this " +
53-
"processor, it will use the flowfile's content for the query. Care should be taken on the size of the query because the entire response " +
53+
"processor, it will use the FlowFile's content for the query. Care should be taken on the size of the query because the entire response " +
5454
"from Elasticsearch will be loaded into memory all at once and converted into the resulting FlowFiles.")
5555
@SeeAlso(PaginatedJsonQueryElasticsearch.class)
5656
@DynamicProperties({

0 commit comments

Comments
 (0)