From 4bb54418df21708fed0464d5b184ec0845d0964d Mon Sep 17 00:00:00 2001 From: Oleg Zhurakousky Date: Tue, 27 Mar 2018 11:41:27 -0400 Subject: [PATCH] GH-1251 added references to property classes Resolves GH-1251 --- .../asciidoc/spring-cloud-stream-overview.adoc | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/spring-cloud-stream-core-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc b/spring-cloud-stream-core-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc index 7e3a58a54..7323639d5 100644 --- a/spring-cloud-stream-core-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc +++ b/spring-cloud-stream-core-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc @@ -1193,7 +1193,8 @@ Currently, only Kafka binder supports the `PAUSED` and `RESUMED` states. === Binder Configuration Properties -The following properties are available when creating custom binder configurations. +The following properties are available when customizing binder configurations. These properties exposed via `org.springframework.cloud.stream.config.BinderProperties` + They must be prefixed with `spring.cloud.stream.binders.`. type:: @@ -1225,7 +1226,9 @@ Some binders let additional binding properties support middleware-specific featu Configuration options can be provided to Spring Cloud Stream applications through any mechanism supported by Spring Boot. This includes application arguments, environment variables, and YAML or .properties files. -=== Spring Cloud Stream Properties +=== Binding Service Properties + +These properties are exposed via `org.springframework.cloud.stream.config.BindingServiceProperties` spring.cloud.stream.instanceCount:: The number of deployed instances of an application. @@ -1274,7 +1277,9 @@ To avoid repetition, Spring Cloud Stream supports setting values for all channel In what follows, we indicate where we have omitted the `spring.cloud.stream.bindings..` prefix and focus just on the property name, with the understanding that the prefix ise included at runtime. -==== Properties for Use of Spring Cloud Stream +==== Common Binding Properties + +These properties are exposed via `org.springframework.cloud.stream.config.BindingProperties` The following binding properties are available for both input and output bindings and must be prefixed with `spring.cloud.stream.bindings..` (for example, `spring.cloud.stream.bindings.input.destination=ticktock`). @@ -1304,6 +1309,8 @@ Default: `null` (the default binder is used, if it exists). ==== Consumer Properties +These properties are exposed via `org.springframework.cloud.stream.binder.ConsumerProperties` + The following binding properties are available for input bindings only and must be prefixed with `spring.cloud.stream.bindings..consumer.` (for example, `spring.cloud.stream.bindings.input.consumer.concurrency=3`). Default values can be set by using the `spring.cloud.stream.default.consumer` prefix (for example, `spring.cloud.stream.default.consumer.headerMode=none`). @@ -1356,6 +1363,8 @@ Default: `-1`. ==== Producer Properties +These properties are exposed via `org.springframework.cloud.stream.binder.ProducerProperties` + The following binding properties are available for output bindings only and must be prefixed with `spring.cloud.stream.bindings..producer.` (for example, `spring.cloud.stream.bindings.input.producer.partitionKeyExpression=payload.id`). Default values can be set by using the prefix `spring.cloud.stream.default.producer` (for example, `spring.cloud.stream.default.producer.partitionKeyExpression=payload.id`).