Files
spring-functions-catalog/function/spring-aggregator-function/README.adoc
Chris Bono 84e732da08 Prefix function names with spring-
* Add `spring-` prefix to function names

Fixes: #9

This commit renames each sub-module in the common, consumer, function
and supplier groups with a prefix of `spring-`.

* Update README.adoc links to new prefixed names
2024-01-02 14:07:00 -05:00

28 lines
1.2 KiB
Plaintext

# Aggregator Function
This module provides an aggregation function that can be reused and composed in other applications.
## Beans for injection
You can import the `AggregatorFunctionConfiguration` in a Spring Boot application and then inject the following bean.
`aggregatorFunction`
You can use `aggregatorFunction` as a qualifier when injecting.
Once injected, you can use the `apply` method of the `Function` to invoke it and get the result.
## Configuration Options
For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/aggregator/AggregatorFunctionProperties.java[AggregatorFunctionProperties.java]
A `ComponentCustomizer<AggregatorFactoryBean>` bean can be added in the target project to provide any custom options for the `AggregatorFactoryBean` configuration used by the `aggregatorFunction` definition.
## Tests
See this link:src/test/java/org/springframework/cloud/fn/aggregator/AggregatorFunctionApplicationTests.java[test suite] for examples of how this function is used.
## Other usage
See this link:../../../applications/processor/aggregator-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.