Clean up README files, fix typos and broken links
This commit is contained in:
@@ -1,8 +1,8 @@
|
||||
# Aggregator Function
|
||||
= Aggregator Function
|
||||
|
||||
This module provides an aggregation function that can be reused and composed in other applications.
|
||||
|
||||
## Beans for injection
|
||||
== Beans for injection
|
||||
|
||||
You can import the `AggregatorFunctionConfiguration` in a Spring Boot application and then inject the following bean.
|
||||
|
||||
@@ -12,16 +12,16 @@ 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
|
||||
== 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
|
||||
== Tests
|
||||
|
||||
See this link:src/test/java/org/springframework/cloud/fn/aggregator/AggregatorFunctionApplicationTests.java[test suite] for examples of how this function is used.
|
||||
See this link:src/test/java/org/springframework/cloud/fn/aggregator/AbstractAggregatorFunctionTests.java[test suite] for examples of how this function is used.
|
||||
|
||||
## Other usage
|
||||
== Other usage
|
||||
|
||||
See this link:../../../applications/processor/aggregator-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
|
||||
See this https://github.com/spring-cloud/stream-applications/blob/main/applications/processor/aggregator-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# Filter Function
|
||||
= Filter Function
|
||||
|
||||
This module provides a filter function that can be reused and composed in other applications.
|
||||
|
||||
## Beans for injection
|
||||
== Beans for injection
|
||||
|
||||
The `FilterFunctionConfiguration` auto-configuration provides following bean:
|
||||
|
||||
@@ -12,16 +12,16 @@ You can use `filterFunction` 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
|
||||
== Configuration Options
|
||||
|
||||
All configuration properties are prefixed with `filter.function`.
|
||||
|
||||
For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/filter/FilterFunctionProperties.java[FilterFunctionProperties.java]
|
||||
|
||||
## Examples
|
||||
== Examples
|
||||
|
||||
See this link:src/test/java/org/springframework/cloud/fn/filter/FilterFunctionApplicationTests.java[test suite] for examples of how this function is used.
|
||||
|
||||
## Other usage
|
||||
== Other usage
|
||||
|
||||
See this link:../../../applications/processor/filter-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
|
||||
See this https://github.com/spring-cloud/stream-applications/blob/main/applications/processor/filter-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
|
||||
@@ -1,8 +1,8 @@
|
||||
# Header Enricher Function
|
||||
= Header Enricher Function
|
||||
|
||||
This module provides a header enricher function that can be reused and composed in other applications.
|
||||
|
||||
## Beans for injection
|
||||
== Beans for injection
|
||||
|
||||
The `HeaderEnricherFunctionConfiguration` auto-configuration provides the following bean:
|
||||
|
||||
@@ -12,14 +12,14 @@ You can use `headerEnricherFunction` 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
|
||||
== Configuration Options
|
||||
|
||||
For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/header/enricher/HeaderEnricherFunctionProperties.java[HeaderEnricherFunctionProperties.java]
|
||||
|
||||
## Tests
|
||||
== Tests
|
||||
|
||||
See this link:src/test/java/org/springframework/cloud/fn/header/enricher/HeaderEnricherFunctionApplicationTests.java[test suite] for examples of how this function is used.
|
||||
|
||||
## Other usage
|
||||
== Other usage
|
||||
|
||||
See this link:../../../applications/processor/header-enricher-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
|
||||
See this https://github.com/spring-cloud/stream-applications/blob/main/applications/processor/header-enricher-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
|
||||
@@ -22,4 +22,4 @@ See this link:src/test/java/org/springframework/cloud/fn/header/filter/HeaderFil
|
||||
|
||||
== Other usage
|
||||
|
||||
See this link:../../../applications/processor/header-filter-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
|
||||
See this https://github.com/spring-cloud/stream-applications/blob/main/applications/processor/header-filter-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
|
||||
@@ -1,11 +1,11 @@
|
||||
# HTTP Request Function
|
||||
= HTTP Request Function
|
||||
|
||||
This module provides an HTTP request function that can be reused and composed in other applications.
|
||||
The `Function` uses the reactive `WebClient` from `Spring WebFlux` and is implemented as a `java.util.function.Function`.
|
||||
This function gives you a reactive stream of `ResponseEntity` given a stream of request messages as the function a signature of `Function<Message<?>,ResponseEntity>`.
|
||||
Users have to subscribe to the returned `Flux` to receive the data.
|
||||
|
||||
## Beans for injection
|
||||
== Beans for injection
|
||||
|
||||
The `HttpRequestFunction` auto-configuration provides the following bean:
|
||||
|
||||
@@ -17,16 +17,16 @@ You can use `httpRequestFunction` as a qualifier when injecting.
|
||||
|
||||
Once injected, you can use the `apply` method of the `Function` to invoke it and then subscribe to the returned `Flux`.
|
||||
|
||||
## Configuration Options
|
||||
== Configuration Options
|
||||
|
||||
All configuration properties are prefixed with `http.request`.
|
||||
|
||||
For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/http/request/HttpRequestFunctionProperties.java[HttpRequestFunctionProperties.java]
|
||||
|
||||
## Examples
|
||||
== Examples
|
||||
|
||||
See this link:src/test/java/org/springframework/cloud/fn/http/request/HttpRequestFunctionTests.java[test suite] for examples of how this function is used.
|
||||
|
||||
## Other usage
|
||||
== Other usage
|
||||
|
||||
See this link:../../../applications/processor/http-request-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application to process HTTP requests.
|
||||
See this https://github.com/spring-cloud/stream-applications/blob/main/applications/processor/http-request-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application to process HTTP requests.
|
||||
@@ -1,9 +1,9 @@
|
||||
# SpEL Function
|
||||
= SpEL Function
|
||||
|
||||
This module provides a SpEL function that can be reused and composed in other applications.
|
||||
The function can be used to apply SpEL transformations on data based on a SpEL expression.
|
||||
|
||||
## Beans for injection
|
||||
== Beans for injection
|
||||
|
||||
The `SpelFunctionConfiguration` auto-configuration provides the following bean:
|
||||
|
||||
@@ -13,16 +13,16 @@ You can use `spelFunction` 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
|
||||
== Configuration Options
|
||||
|
||||
All configuration properties are prefixed with `spel`.
|
||||
|
||||
For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/spel/SpelFunctionProperties.java[SpelFunctionProperties.java]
|
||||
|
||||
## Tests
|
||||
== Tests
|
||||
|
||||
See this link:src/test/java/org/springframework/cloud/fn/spel/SpelFunctionApplicationTests.java[test suite] for examples of how this function is used.
|
||||
|
||||
## Other usage
|
||||
== Other usage
|
||||
|
||||
See this link:../../../applications/processor/transform-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream transformer application.
|
||||
See this https://github.com/spring-cloud/stream-applications/blob/main/applications/processor/transform-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream transformer application.
|
||||
@@ -1,8 +1,8 @@
|
||||
# Splitter Function
|
||||
= Splitter Function
|
||||
|
||||
This module provides a splitter function that can be reused and composed in other applications.
|
||||
|
||||
## Beans for injection
|
||||
== Beans for injection
|
||||
|
||||
The `SpliiterFunctionConfiguration` auto-configuration provides the following bean:
|
||||
|
||||
@@ -12,14 +12,14 @@ You can use `splitterFunction` 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
|
||||
== Configuration Options
|
||||
|
||||
For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/splitter/SplitterFunctionProperties.java[SplitterFunctionProperties.java]
|
||||
|
||||
## Tests
|
||||
== Tests
|
||||
|
||||
See this link:src/test/java/org/springframework/cloud/fn/splitter/SplitterFunctionApplicationTests.java[test suite] for examples of how this function is used.
|
||||
|
||||
## Other usage
|
||||
== Other usage
|
||||
|
||||
See this link:../../../applications/processor/splitter-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
|
||||
See this https://github.com/spring-cloud/stream-applications/blob/main/applications/processor/splitter-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
|
||||
@@ -1,9 +1,9 @@
|
||||
# Task Launch Request Function
|
||||
= Task Launch Request Function
|
||||
|
||||
This module provides a function that can be reused and composed in other applications to transform the output to a link:src/main/java/org/springframework/cloud/fn/task/launch/request/TaskLaunchRequest.java[TaskLaunchRequest]
|
||||
that can be used as input to the TaskLauncher function to launch a task.
|
||||
|
||||
## Beans for injection
|
||||
== Beans for injection
|
||||
|
||||
The `TaskLaunchRequestFunctionConfiguration` auto-configuration provides the following bean:
|
||||
|
||||
@@ -13,10 +13,10 @@ You can use `taskLaunchRequestFunction` 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
|
||||
== Configuration Options
|
||||
|
||||
For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/task/launch/request/TaskLaunchRequestFunctionProperties.java[TaskLaunchRequestFunctionProperties.java]
|
||||
|
||||
## Examples
|
||||
== Examples
|
||||
|
||||
See this link:src/test/java/org/springframework/cloud/fn/task/launch/request/TaskLaunchRequestFunctionApplicationTests.java[test suite] for examples of how this function is used.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Twitter Functions
|
||||
= Twitter Functions
|
||||
|
||||
This module provides couple of twitter functions that can be reused and composed in other applications.
|
||||
|
||||
@@ -10,7 +10,7 @@ This module exposes auto-configurations for the following beans:
|
||||
|
||||
Each of them are conditional by specific configuration properties.
|
||||
|
||||
## 1. Twitter Trend Function
|
||||
== 1. Twitter Trend Function
|
||||
|
||||
Function can return either Trends topics or the Locations of the trending topics.
|
||||
The `twitter.trend.trend-query-type` property allows choosing between both types.
|
||||
@@ -25,22 +25,22 @@ If the `latitude`, `longitude` parameters are provided the processor performs th
|
||||
|
||||
Response is an array of `locations` that encode the location's WOEID and some other human-readable information such as a canonical name and country the location belongs in.
|
||||
|
||||
### 1.1 Beans for injection
|
||||
=== 1.1 Beans for injection
|
||||
|
||||
You can use `Function<Message<?>, Message<byte[]>> twitterTrendFunction` as a qualifier when injecting.
|
||||
|
||||
Once injected, you can use the `apply` method of the `Function` to invoke it and get the result.
|
||||
|
||||
### 1.2 Configuration Options
|
||||
=== 1.2 Configuration Options
|
||||
|
||||
TIP: For `SpEL` expression properties wrap the literal values in single quotes (`'`).
|
||||
|
||||
For more information on the various options available, please see link:../twitter-function/src/main/java/org/springframework/cloud/fn/twitter/trend/TwitterTrendFunctionProperties.java[TwitterTrendFunctionProperties.java]
|
||||
|
||||
### 1.3 Tests
|
||||
=== 1.3 Tests
|
||||
See this link:src/test/java/org/springframework/cloud/fn/twitter/trend/TwitterTrendFunctionTests.java[test suite] for examples of how this function is used.
|
||||
|
||||
### 1.4 Other usage
|
||||
=== 1.4 Other usage
|
||||
|
||||
Leveraging the Spring Cloud Function "composability", you can compose the Trend function in your boot app like this:
|
||||
|
||||
@@ -56,7 +56,7 @@ public class MyTwitterTrendBootApp {
|
||||
}
|
||||
----
|
||||
|
||||
## 2. Twitter Geo Function.
|
||||
== 2. Twitter Geo Function.
|
||||
|
||||
Function based on the https://developer.twitter.com/en/docs/geo/places-near-location/overview[Geo API] that retrieves Twitter place information based on query parameters such as (`latitude`, `longitude`) pair, an `IP` address, or a place `name`.
|
||||
|
||||
@@ -77,22 +77,22 @@ NOTE: Limits: 15 requests / 15-min window (user auth).
|
||||
|
||||
This function auto-configuration is conditional on `twitter.geo.search.ip != null || (twitter.geo.location.lat != null && twitter.geo.location.lon != null)`
|
||||
|
||||
### 2.1 Beans for injection
|
||||
=== 2.1 Beans for injection
|
||||
|
||||
You can use `Function<Message<?>, Message<byte[]>> twitterGeoFunction` as a qualifier when injecting.
|
||||
Once injected, you can use the `apply` method of the `Function` to invoke it and get the result.
|
||||
|
||||
### 2.2 Configuration Options
|
||||
=== 2.2 Configuration Options
|
||||
|
||||
TIP: For `SpEL` expression properties wrap the literal values in single quotes (`'`).
|
||||
|
||||
For more information on the various options available, please see link:../twitter-function/src/main/java/org/springframework/cloud/fn/twitter/geo/TwitterGeoFunctionProperties.java[TwitterGeoFunctionProperties.java]
|
||||
|
||||
### 2.3 Tests
|
||||
=== 2.3 Tests
|
||||
|
||||
See this link:src/test/java/org/springframework/cloud/fn/twitter/geo/TwitterGeoFunctionTests.java[test suite] for examples of how this function is used.
|
||||
|
||||
### 2.4 Other usage
|
||||
=== 2.4 Other usage
|
||||
|
||||
Leveraging the Spring Cloud Function composability, you can compose the Geo function in your boot app like this:
|
||||
|
||||
@@ -108,7 +108,7 @@ public class MyTwitterGeoProcessorBootApp {
|
||||
}
|
||||
----
|
||||
|
||||
## 3. Twitter Users Function
|
||||
== 3. Twitter Users Function
|
||||
|
||||
Retrieves users either by list of use ids and/or screen-names (https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup[Users Lookup API]) or by text search query (https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search[Users Search API]).
|
||||
Uses SpEL expressions to compute the query parameters from the input message.
|
||||
@@ -121,19 +121,17 @@ This property is required to trigger the `twitterUsersFunction` auto-configurati
|
||||
* https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search[Users Search API] - Relevance-based search interface to public user accounts on Twitter.
|
||||
Querying by topical interest, full name, company name, location, or other criteria. Exact match searches are not supported. Only the first 1,000 matching results are available. Rate limits:(900 requests / 15-min window)
|
||||
|
||||
### 3.1 Beans for injection
|
||||
=== 3.1 Beans for injection
|
||||
|
||||
You can use `Function<Message<?>, Message<byte[]>> twitterUsersFunction` as a qualifier when injecting.
|
||||
Once injected, you can use the `apply` method of the `Function` to invoke it and get the result.
|
||||
|
||||
|
||||
### 3.2 Configuration Options
|
||||
=== 3.2 Configuration Options
|
||||
|
||||
TIP: For `SpEL` expression properties wrap the literal values in single quotes (`'`).
|
||||
|
||||
For more information on the various options available, please see link:../twitter-function/src/main/java/org/springframework/cloud/fn/twitter/users/TwitterUsersFunctionProperties.java[TwitterUsersFunctionProperties.java]
|
||||
|
||||
### 3.3 Tests
|
||||
=== 3.3 Tests
|
||||
See this link:src/test/java/org/springframework/cloud/fn/twitter/users/TwitterUsersFunctionTests.java[test suite] for examples of how this function is used.
|
||||
|
||||
### 3.4 Other usage
|
||||
|
||||
Reference in New Issue
Block a user