http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-atomix/src/main/docs/atomix-set-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atomix/src/main/docs/atomix-set-component.adoc b/components/camel-atomix/src/main/docs/atomix-set-component.adoc index 7f5eb11..e0051c5 100644 --- a/components/camel-atomix/src/main/docs/atomix-set-component.adoc +++ b/components/camel-atomix/src/main/docs/atomix-set-component.adoc @@ -1,4 +1,4 @@ -## Atomix Set Component +== Atomix Set Component *Available as of Camel version 2.20* @@ -29,52 +29,54 @@ The Atomix Set component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | The shared component configuration | | AtomixSetConfiguration -| **atomix** (common) | The shared AtomixClient instance | | AtomixClient -| **nodes** (common) | The nodes the AtomixClient should connect to | | List -| **configurationUri** (common) | The path to the AtomixClient configuration | | String -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (common) | The shared component configuration | | AtomixSetConfiguration +| *atomix* (common) | The shared AtomixClient instance | | AtomixClient +| *nodes* (common) | The nodes the AtomixClient should connect to | | List +| *configurationUri* (common) | The path to the AtomixClient configuration | | String +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END // endpoint options: START The Atomix Set endpoint is configured using URI syntax: - atomix-set:setName +---- +atomix-set:setName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **resourceName** | *Required* The distributed resource name | | String -|======================================================================= +| *resourceName* | *Required* The distributed resource name | | String +|=== -#### Query Parameters (17 parameters): +==== Query Parameters (17 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **atomix** (common) | The Atomix instance to use | | Atomix -| **configurationUri** (common) | The Atomix configuration uri. | | String -| **defaultAction** (common) | The default action. | ADD | Action -| **nodes** (common) | The address of the nodes composing the cluster. | | String -| **resultHeader** (common) | The header that wil carry the result. | | String -| **transport** (common) | Sets the Atomix transport. | io.atomix.catalyst.transport.netty.NettyTransport | Transport -| **ttl** (common) | The resource ttl. | | long -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **defaultResourceConfig** (advanced) | The cluster wide default resource configuration. | | Properties -| **defaultResourceOptions** (advanced) | The local default resource options. | | Properties -| **ephemeral** (advanced) | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | boolean -| **readConsistency** (advanced) | The read consistency level. | | ReadConsistency -| **resourceConfigs** (advanced) | Cluster wide resources configuration. | | Map -| **resourceOptions** (advanced) | Local resources configurations | | Map -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *atomix* (common) | The Atomix instance to use | | Atomix +| *configurationUri* (common) | The Atomix configuration uri. | | String +| *defaultAction* (common) | The default action. | ADD | Action +| *nodes* (common) | The address of the nodes composing the cluster. | | String +| *resultHeader* (common) | The header that wil carry the result. | | String +| *transport* (common) | Sets the Atomix transport. | io.atomix.catalyst.transport.netty.NettyTransport | Transport +| *ttl* (common) | The resource ttl. | | long +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *defaultResourceConfig* (advanced) | The cluster wide default resource configuration. | | Properties +| *defaultResourceOptions* (advanced) | The local default resource options. | | Properties +| *ephemeral* (advanced) | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | boolean +| *readConsistency* (advanced) | The read consistency level. | | ReadConsistency +| *resourceConfigs* (advanced) | Cluster wide resources configuration. | | Map +| *resourceOptions* (advanced) | Local resources configurations | | Map +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-atomix/src/main/docs/atomix-value-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atomix/src/main/docs/atomix-value-component.adoc b/components/camel-atomix/src/main/docs/atomix-value-component.adoc index 8437d89..325fe80 100644 --- a/components/camel-atomix/src/main/docs/atomix-value-component.adoc +++ b/components/camel-atomix/src/main/docs/atomix-value-component.adoc @@ -1,4 +1,4 @@ -## Atomix Value Component +== Atomix Value Component *Available as of Camel version 2.20* @@ -29,52 +29,54 @@ The Atomix Value component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | The shared component configuration | | AtomixValue Configuration -| **atomix** (common) | The shared AtomixClient instance | | AtomixClient -| **nodes** (common) | The nodes the AtomixClient should connect to | | List -| **configurationUri** (common) | The path to the AtomixClient configuration | | String -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (common) | The shared component configuration | | AtomixValue Configuration +| *atomix* (common) | The shared AtomixClient instance | | AtomixClient +| *nodes* (common) | The nodes the AtomixClient should connect to | | List +| *configurationUri* (common) | The path to the AtomixClient configuration | | String +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END // endpoint options: START The Atomix Value endpoint is configured using URI syntax: - atomix-value:valueName +---- +atomix-value:valueName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **resourceName** | *Required* The distributed resource name | | String -|======================================================================= +| *resourceName* | *Required* The distributed resource name | | String +|=== -#### Query Parameters (17 parameters): +==== Query Parameters (17 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **atomix** (common) | The Atomix instance to use | | Atomix -| **configurationUri** (common) | The Atomix configuration uri. | | String -| **defaultAction** (common) | The default action. | SET | Action -| **nodes** (common) | The address of the nodes composing the cluster. | | String -| **resultHeader** (common) | The header that wil carry the result. | | String -| **transport** (common) | Sets the Atomix transport. | io.atomix.catalyst.transport.netty.NettyTransport | Transport -| **ttl** (common) | The resource ttl. | | long -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **defaultResourceConfig** (advanced) | The cluster wide default resource configuration. | | Properties -| **defaultResourceOptions** (advanced) | The local default resource options. | | Properties -| **ephemeral** (advanced) | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | boolean -| **readConsistency** (advanced) | The read consistency level. | | ReadConsistency -| **resourceConfigs** (advanced) | Cluster wide resources configuration. | | Map -| **resourceOptions** (advanced) | Local resources configurations | | Map -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *atomix* (common) | The Atomix instance to use | | Atomix +| *configurationUri* (common) | The Atomix configuration uri. | | String +| *defaultAction* (common) | The default action. | SET | Action +| *nodes* (common) | The address of the nodes composing the cluster. | | String +| *resultHeader* (common) | The header that wil carry the result. | | String +| *transport* (common) | Sets the Atomix transport. | io.atomix.catalyst.transport.netty.NettyTransport | Transport +| *ttl* (common) | The resource ttl. | | long +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *defaultResourceConfig* (advanced) | The cluster wide default resource configuration. | | Properties +| *defaultResourceOptions* (advanced) | The local default resource options. | | Properties +| *ephemeral* (advanced) | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | boolean +| *readConsistency* (advanced) | The read consistency level. | | ReadConsistency +| *resourceConfigs* (advanced) | Cluster wide resources configuration. | | Map +| *resourceOptions* (advanced) | Local resources configurations | | Map +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-avro/src/main/docs/avro-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-avro/src/main/docs/avro-component.adoc b/components/camel-avro/src/main/docs/avro-component.adoc index 9edb78d..edd9900 100644 --- a/components/camel-avro/src/main/docs/avro-component.adoc +++ b/components/camel-avro/src/main/docs/avro-component.adoc @@ -1,4 +1,4 @@ -## Avro Component +== Avro Component *Available as of Camel version 2.10* @@ -176,11 +176,11 @@ The Avro component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (advanced) | To use a shared AvroConfiguration to configure options once | | AvroConfiguration -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (advanced) | To use a shared AvroConfiguration to configure options once | | AvroConfiguration +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END @@ -191,37 +191,39 @@ The Avro component supports 2 options which are listed below. // endpoint options: START The Avro endpoint is configured using URI syntax: - avro:transport:host:port/messageName +---- +avro:transport:host:port/messageName +---- with the following path and query parameters: -#### Path Parameters (4 parameters): +==== Path Parameters (4 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **transport** | *Required* Transport to use | | AvroTransport -| **port** | *Required* Port number to use | | int -| **host** | *Required* Hostname to use | | String -| **messageName** | The name of the message to send. | | String -|======================================================================= +| *transport* | *Required* Transport to use | | AvroTransport +| *port* | *Required* Port number to use | | int +| *host* | *Required* Hostname to use | | String +| *messageName* | The name of the message to send. | | String +|=== -#### Query Parameters (10 parameters): +==== Query Parameters (10 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **protocol** (common) | Avro protocol to use | | Protocol -| **protocolClassName** (common) | Avro protocol to use defined by the FQN class name | | String -| **protocolLocation** (common) | Avro protocol location | | String -| **reflectionProtocol** (common) | If protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto detected | false | boolean -| **singleParameter** (common) | If true consumer parameter won't be wrapped into array. Will fail if protocol specifies more then 1 parameter for the message | false | boolean -| **uriAuthority** (common) | Authority to use (username and password) | | String -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *protocol* (common) | Avro protocol to use | | Protocol +| *protocolClassName* (common) | Avro protocol to use defined by the FQN class name | | String +| *protocolLocation* (common) | Avro protocol location | | String +| *reflectionProtocol* (common) | If protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto detected | false | boolean +| *singleParameter* (common) | If true consumer parameter won't be wrapped into array. Will fail if protocol specifies more then 1 parameter for the message | false | boolean +| *uriAuthority* (common) | Authority to use (username and password) | | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-avro/src/main/docs/avro-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-avro/src/main/docs/avro-dataformat.adoc b/components/camel-avro/src/main/docs/avro-dataformat.adoc index 5341eef..e004d55 100644 --- a/components/camel-avro/src/main/docs/avro-dataformat.adoc +++ b/components/camel-avro/src/main/docs/avro-dataformat.adoc @@ -1,4 +1,4 @@ -## Avro DataFormat +== Avro DataFormat *Available as of Camel version 2.14* @@ -134,9 +134,9 @@ The Avro dataformat supports 2 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | instanceClassName | | String | Class name to use for marshal and unmarshalling | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-aws/src/main/docs/aws-cw-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-cw-component.adoc b/components/camel-aws/src/main/docs/aws-cw-component.adoc index ee6ef21..84b8c74 100644 --- a/components/camel-aws/src/main/docs/aws-cw-component.adoc +++ b/components/camel-aws/src/main/docs/aws-cw-component.adoc @@ -1,4 +1,4 @@ -## AWS CloudWatch Component +== AWS CloudWatch Component *Available as of Camel version 2.11* @@ -37,36 +37,38 @@ The AWS CloudWatch component has no options. // endpoint options: START The AWS CloudWatch endpoint is configured using URI syntax: - aws-cw:namespace +---- +aws-cw:namespace +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **namespace** | *Required* The metric namespace | | String -|======================================================================= +| *namespace* | *Required* The metric namespace | | String +|=== -#### Query Parameters (12 parameters): +==== Query Parameters (12 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessKey** (producer) | Amazon AWS Access Key | | String -| **amazonCwClient** (producer) | To use the AmazonCloudWatch as the client | | AmazonCloudWatch -| **amazonCwEndpoint** (producer) | The endpoint with which the AWS-CW client wants to work with. | | String -| **name** (producer) | The metric name | | String -| **proxyHost** (producer) | To define a proxy host when instantiating the CW client | | String -| **proxyPort** (producer) | To define a proxy port when instantiating the CW client | | Integer -| **region** (producer) | The region in which CW client needs to work | | String -| **secretKey** (producer) | Amazon AWS Secret Key | | String -| **timestamp** (producer) | The metric timestamp | | Date -| **unit** (producer) | The metric unit | | String -| **value** (producer) | The metric value | | Double -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *accessKey* (producer) | Amazon AWS Access Key | | String +| *amazonCwClient* (producer) | To use the AmazonCloudWatch as the client | | AmazonCloudWatch +| *amazonCwEndpoint* (producer) | The endpoint with which the AWS-CW client wants to work with. | | String +| *name* (producer) | The metric name | | String +| *proxyHost* (producer) | To define a proxy host when instantiating the CW client | | String +| *proxyPort* (producer) | To define a proxy port when instantiating the CW client | | Integer +| *region* (producer) | The region in which CW client needs to work | | String +| *secretKey* (producer) | Amazon AWS Secret Key | | String +| *timestamp* (producer) | The metric timestamp | | Date +| *unit* (producer) | The metric unit | | String +| *value* (producer) | The metric value | | Double +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-aws/src/main/docs/aws-ddb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-ddb-component.adoc b/components/camel-aws/src/main/docs/aws-ddb-component.adoc index 24b14d9..19544e9 100644 --- a/components/camel-aws/src/main/docs/aws-ddb-component.adoc +++ b/components/camel-aws/src/main/docs/aws-ddb-component.adoc @@ -1,4 +1,4 @@ -## AWS DynamoDB Component +== AWS DynamoDB Component *Available as of Camel version 2.10* @@ -34,38 +34,40 @@ The AWS DynamoDB component has no options. // endpoint options: START The AWS DynamoDB endpoint is configured using URI syntax: - aws-ddb:tableName +---- +aws-ddb:tableName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **tableName** | *Required* The name of the table currently worked with. | | String -|======================================================================= +| *tableName* | *Required* The name of the table currently worked with. | | String +|=== -#### Query Parameters (14 parameters): +==== Query Parameters (14 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessKey** (producer) | Amazon AWS Access Key | | String -| **amazonDDBClient** (producer) | To use the AmazonDynamoDB as the client | | AmazonDynamoDB -| **amazonDdbEndpoint** (producer) | The endpoint with which the AWS-DDB client wants to work with. | | String -| **consistentRead** (producer) | Determines whether or not strong consistency should be enforced when data is read. | false | boolean -| **keyAttributeName** (producer) | Attribute name when creating table | | String -| **keyAttributeType** (producer) | Attribute type when creating table | | String -| **operation** (producer) | What operation to perform | PutItem | DdbOperations -| **proxyHost** (producer) | To define a proxy host when instantiating the DDB client | | String -| **proxyPort** (producer) | To define a proxy port when instantiating the DDB client | | Integer -| **readCapacity** (producer) | The provisioned throughput to reserve for reading resources from your table | | Long -| **region** (producer) | The region in which DDB client needs to work | | String -| **secretKey** (producer) | Amazon AWS Secret Key | | String -| **writeCapacity** (producer) | The provisioned throughput to reserved for writing resources to your table | | Long -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *accessKey* (producer) | Amazon AWS Access Key | | String +| *amazonDDBClient* (producer) | To use the AmazonDynamoDB as the client | | AmazonDynamoDB +| *amazonDdbEndpoint* (producer) | The endpoint with which the AWS-DDB client wants to work with. | | String +| *consistentRead* (producer) | Determines whether or not strong consistency should be enforced when data is read. | false | boolean +| *keyAttributeName* (producer) | Attribute name when creating table | | String +| *keyAttributeType* (producer) | Attribute type when creating table | | String +| *operation* (producer) | What operation to perform | PutItem | DdbOperations +| *proxyHost* (producer) | To define a proxy host when instantiating the DDB client | | String +| *proxyPort* (producer) | To define a proxy port when instantiating the DDB client | | Integer +| *readCapacity* (producer) | The provisioned throughput to reserve for reading resources from your table | | Long +| *region* (producer) | The region in which DDB client needs to work | | String +| *secretKey* (producer) | Amazon AWS Secret Key | | String +| *writeCapacity* (producer) | The provisioned throughput to reserved for writing resources to your table | | Long +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc b/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc index 86a3af5..c97088c 100644 --- a/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc +++ b/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc @@ -1,4 +1,4 @@ -## AWS DynamoDB Streams Component +== AWS DynamoDB Streams Component *Available as of Camel version 2.17* @@ -37,47 +37,49 @@ The AWS DynamoDB Streams component has no options. // endpoint options: START The AWS DynamoDB Streams endpoint is configured using URI syntax: - aws-ddbstream:tableName +---- +aws-ddbstream:tableName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **tableName** | *Required* Name of the dynamodb table | | String -|======================================================================= +| *tableName* | *Required* Name of the dynamodb table | | String +|=== -#### Query Parameters (23 parameters): +==== Query Parameters (23 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **amazonDynamoDbStreams Client** (consumer) | *Required* Amazon DynamoDB client to use for all requests for this endpoint | | AmazonDynamoDBStreams -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **iteratorType** (consumer) | Defines where in the DynaboDB stream to start getting records. Note that using TRIM_HORIZON can cause a significant delay before the stream has caught up to real-time. if ATAFTER_SEQUENCE_NUMBER are used then a sequenceNumberProvider MUST be supplied. | LATEST | ShardIteratorType -| **maxResultsPerRequest** (consumer) | Maximum number of records that will be fetched in each poll | | int -| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean -| **sequenceNumberProvider** (consumer) | Provider for the sequence number when using one of the two ShardIteratorType.ATAFTER_SEQUENCE_NUMBER iterator types. Can be a registry reference or a literal sequence number. | | SequenceNumberProvider -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long -| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean -| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long -| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel -| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service -| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler -| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map -| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean -| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit -| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -|======================================================================= +| *amazonDynamoDbStreams Client* (consumer) | *Required* Amazon DynamoDB client to use for all requests for this endpoint | | AmazonDynamoDBStreams +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *iteratorType* (consumer) | Defines where in the DynaboDB stream to start getting records. Note that using TRIM_HORIZON can cause a significant delay before the stream has caught up to real-time. if ATAFTER_SEQUENCE_NUMBER are used then a sequenceNumberProvider MUST be supplied. | LATEST | ShardIteratorType +| *maxResultsPerRequest* (consumer) | Maximum number of records that will be fetched in each poll | | int +| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| *sequenceNumberProvider* (consumer) | Provider for the sequence number when using one of the two ShardIteratorType.ATAFTER_SEQUENCE_NUMBER iterator types. Can be a registry reference or a literal sequence number. | | SequenceNumberProvider +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *delay* (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean +| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-aws/src/main/docs/aws-ec2-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-ec2-component.adoc b/components/camel-aws/src/main/docs/aws-ec2-component.adoc index f990653..c297c18 100644 --- a/components/camel-aws/src/main/docs/aws-ec2-component.adoc +++ b/components/camel-aws/src/main/docs/aws-ec2-component.adoc @@ -1,4 +1,4 @@ -## AWS EC2 Component +== AWS EC2 Component *Available as of Camel version 2.16* @@ -34,33 +34,35 @@ The AWS EC2 component has no options. // endpoint options: START The AWS EC2 endpoint is configured using URI syntax: - aws-ec2:label +---- +aws-ec2:label +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **label** | *Required* Logical name | | String -|======================================================================= +| *label* | *Required* Logical name | | String +|=== -#### Query Parameters (9 parameters): +==== Query Parameters (9 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessKey** (producer) | Amazon AWS Access Key | | String -| **amazonEc2Client** (producer) | To use a existing configured AmazonEC2Client as client | | AmazonEC2Client -| **amazonEc2Endpoint** (producer) | The region with which the AWS-EC2 client wants to work with. | | String -| **operation** (producer) | *Required* The operation to perform. It can be createAndRunInstances startInstances stopInstances terminateInstances describeInstances describeInstancesStatus rebootInstances monitorInstances unmonitorInstances createTags or deleteTags | | EC2Operations -| **proxyHost** (producer) | To define a proxy host when instantiating the SQS client | | String -| **proxyPort** (producer) | To define a proxy port when instantiating the SQS client | | Integer -| **region** (producer) | The region in which EC2 client needs to work | | String -| **secretKey** (producer) | Amazon AWS Secret Key | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *accessKey* (producer) | Amazon AWS Access Key | | String +| *amazonEc2Client* (producer) | To use a existing configured AmazonEC2Client as client | | AmazonEC2Client +| *amazonEc2Endpoint* (producer) | The region with which the AWS-EC2 client wants to work with. | | String +| *operation* (producer) | *Required* The operation to perform. It can be createAndRunInstances startInstances stopInstances terminateInstances describeInstances describeInstancesStatus rebootInstances monitorInstances unmonitorInstances createTags or deleteTags | | EC2Operations +| *proxyHost* (producer) | To define a proxy host when instantiating the SQS client | | String +| *proxyPort* (producer) | To define a proxy port when instantiating the SQS client | | Integer +| *region* (producer) | The region in which EC2 client needs to work | | String +| *secretKey* (producer) | Amazon AWS Secret Key | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-aws/src/main/docs/aws-kinesis-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-kinesis-component.adoc b/components/camel-aws/src/main/docs/aws-kinesis-component.adoc index b449fdc..39006e5 100644 --- a/components/camel-aws/src/main/docs/aws-kinesis-component.adoc +++ b/components/camel-aws/src/main/docs/aws-kinesis-component.adoc @@ -1,4 +1,4 @@ -## AWS Kinesis Component +== AWS Kinesis Component *Available as of Camel version 2.17* @@ -38,48 +38,50 @@ The AWS Kinesis component has no options. // endpoint options: START The AWS Kinesis endpoint is configured using URI syntax: - aws-kinesis:streamName +---- +aws-kinesis:streamName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **streamName** | *Required* Name of the stream | | String -|======================================================================= +| *streamName* | *Required* Name of the stream | | String +|=== -#### Query Parameters (24 parameters): +==== Query Parameters (24 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **amazonKinesisClient** (common) | *Required* Amazon Kinesis client to use for all requests for this endpoint | | AmazonKinesis -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **iteratorType** (consumer) | Defines where in the Kinesis stream to start getting records | TRIM_HORIZON | ShardIteratorType -| **maxResultsPerRequest** (consumer) | Maximum number of records that will be fetched in each poll | 1 | int -| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean -| **sequenceNumber** (consumer) | The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER | | String -| **shardId** (consumer) | Defines which shardId in the Kinesis stream to get records from | | String -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long -| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean -| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long -| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel -| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service -| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler -| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map -| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean -| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit -| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -|======================================================================= +| *amazonKinesisClient* (common) | *Required* Amazon Kinesis client to use for all requests for this endpoint | | AmazonKinesis +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *iteratorType* (consumer) | Defines where in the Kinesis stream to start getting records | TRIM_HORIZON | ShardIteratorType +| *maxResultsPerRequest* (consumer) | Maximum number of records that will be fetched in each poll | 1 | int +| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| *sequenceNumber* (consumer) | The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER | | String +| *shardId* (consumer) | Defines which shardId in the Kinesis stream to get records from | | String +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *delay* (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean +| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc b/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc index d59412d..37e161a 100644 --- a/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc +++ b/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc @@ -1,4 +1,4 @@ -## AWS Kinesis Firehose Component +== AWS Kinesis Firehose Component *Available as of Camel version 2.19* @@ -37,26 +37,28 @@ The AWS Kinesis Firehose component has no options. // endpoint options: START The AWS Kinesis Firehose endpoint is configured using URI syntax: - aws-kinesis-firehose:streamName +---- +aws-kinesis-firehose:streamName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **streamName** | *Required* Name of the stream | | String -|======================================================================= +| *streamName* | *Required* Name of the stream | | String +|=== -#### Query Parameters (2 parameters): +==== Query Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **amazonKinesisFirehoseClient** (producer) | *Required* Amazon Kinesis Firehose client to use for all requests for this endpoint | | AmazonKinesisFirehose -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *amazonKinesisFirehoseClient* (producer) | *Required* Amazon Kinesis Firehose client to use for all requests for this endpoint | | AmazonKinesisFirehose +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-aws/src/main/docs/aws-s3-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-s3-component.adoc b/components/camel-aws/src/main/docs/aws-s3-component.adoc index 101906b..9536582 100644 --- a/components/camel-aws/src/main/docs/aws-s3-component.adoc +++ b/components/camel-aws/src/main/docs/aws-s3-component.adoc @@ -1,4 +1,4 @@ -## AWS S3 Storage Service Component +== AWS S3 Storage Service Component *Available as of Camel version 2.8* @@ -51,67 +51,69 @@ The AWS S3 Storage Service component has no options. // endpoint options: START The AWS S3 Storage Service endpoint is configured using URI syntax: - aws-s3:bucketNameOrArn +---- +aws-s3:bucketNameOrArn +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bucketNameOrArn** | *Required* Bucket name or ARN | | String -|======================================================================= +| *bucketNameOrArn* | *Required* Bucket name or ARN | | String +|=== -#### Query Parameters (43 parameters): +==== Query Parameters (43 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessKey** (common) | Amazon AWS Access Key | | String -| **amazonS3Client** (common) | Reference to a com.amazonaws.services.sqs.AmazonS3 in the link:registry.htmlRegistry. | | AmazonS3 -| **amazonS3Endpoint** (common) | The region with which the AWS-S3 client wants to work with. | | String -| **encryptionMaterials** (common) | The encryption materials to use in case of Symmetric/Asymmetric client usage | | EncryptionMaterials -| **pathStyleAccess** (common) | Whether or not the S3 client should use path style access | false | boolean -| **policy** (common) | The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3setBucketPolicy() method. | | String -| **proxyHost** (common) | To define a proxy host when instantiating the SQS client | | String -| **proxyPort** (common) | Specify a proxy port to be used inside the client definition. | | Integer -| **secretKey** (common) | Amazon AWS Secret Key | | String -| **useEncryption** (common) | Define if encryption must be used or not | false | boolean -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **deleteAfterRead** (consumer) | Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs the object is not deleted. If this option is false then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the link S3ConstantsBUCKET_NAME and link S3ConstantsKEY headers or only the link S3ConstantsKEY header. | true | boolean -| **fileName** (consumer) | To get the object from the bucket with the given file name | | String -| **includeBody** (consumer) | If it is true the exchange body will be set to a stream to the contents of the file. If false the headers will be set with the S3 object metadata but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false it will be up to the caller to close the S3Object stream. Setting autocloseBody to true will close the S3Object stream automatically. | true | boolean -| **maxConnections** (consumer) | Set the maxConnections parameter in the S3 client configuration | 60 | int -| **maxMessagesPerPoll** (consumer) | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited but use 0 or negative number to disable it as unlimited. | 10 | int -| **prefix** (consumer) | The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. | | String -| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean -| **autocloseBody** (consumer) | If this option is true and includeBody is true then the S3Object.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false it will be up to the caller to close the S3Object stream. Setting autocloseBody to true will close the S3Object stream automatically. | true | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy -| **deleteAfterWrite** (producer) | Delete file object after the S3 file has been uploaded | false | boolean -| **multiPartUpload** (producer) | If it is true camel will upload the file with multi part format the part size is decided by the option of partSize | false | boolean -| **operation** (producer) | The operation to do in case the user don't want to do only an upload | | S3Operations -| **partSize** (producer) | Setup the partSize which is used in multi part upload the default size is 25M. | 26214400 | long -| **region** (producer) | The region where the bucket is located. This option is used in the com.amazonaws.services.s3.model.CreateBucketRequest. | | String -| **serverSideEncryption** (producer) | Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256. | | String -| **storageClass** (producer) | The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request. | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long -| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean -| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long -| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel -| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service -| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler -| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map -| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean -| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit -| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -|======================================================================= +| *accessKey* (common) | Amazon AWS Access Key | | String +| *amazonS3Client* (common) | Reference to a com.amazonaws.services.sqs.AmazonS3 in the link:registry.htmlRegistry. | | AmazonS3 +| *amazonS3Endpoint* (common) | The region with which the AWS-S3 client wants to work with. | | String +| *encryptionMaterials* (common) | The encryption materials to use in case of Symmetric/Asymmetric client usage | | EncryptionMaterials +| *pathStyleAccess* (common) | Whether or not the S3 client should use path style access | false | boolean +| *policy* (common) | The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3setBucketPolicy() method. | | String +| *proxyHost* (common) | To define a proxy host when instantiating the SQS client | | String +| *proxyPort* (common) | Specify a proxy port to be used inside the client definition. | | Integer +| *secretKey* (common) | Amazon AWS Secret Key | | String +| *useEncryption* (common) | Define if encryption must be used or not | false | boolean +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *deleteAfterRead* (consumer) | Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs the object is not deleted. If this option is false then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the link S3ConstantsBUCKET_NAME and link S3ConstantsKEY headers or only the link S3ConstantsKEY header. | true | boolean +| *fileName* (consumer) | To get the object from the bucket with the given file name | | String +| *includeBody* (consumer) | If it is true the exchange body will be set to a stream to the contents of the file. If false the headers will be set with the S3 object metadata but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false it will be up to the caller to close the S3Object stream. Setting autocloseBody to true will close the S3Object stream automatically. | true | boolean +| *maxConnections* (consumer) | Set the maxConnections parameter in the S3 client configuration | 60 | int +| *maxMessagesPerPoll* (consumer) | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited but use 0 or negative number to disable it as unlimited. | 10 | int +| *prefix* (consumer) | The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. | | String +| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| *autocloseBody* (consumer) | If this option is true and includeBody is true then the S3Object.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false it will be up to the caller to close the S3Object stream. Setting autocloseBody to true will close the S3Object stream automatically. | true | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| *deleteAfterWrite* (producer) | Delete file object after the S3 file has been uploaded | false | boolean +| *multiPartUpload* (producer) | If it is true camel will upload the file with multi part format the part size is decided by the option of partSize | false | boolean +| *operation* (producer) | The operation to do in case the user don't want to do only an upload | | S3Operations +| *partSize* (producer) | Setup the partSize which is used in multi part upload the default size is 25M. | 26214400 | long +| *region* (producer) | The region where the bucket is located. This option is used in the com.amazonaws.services.s3.model.CreateBucketRequest. | | String +| *serverSideEncryption* (producer) | Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256. | | String +| *storageClass* (producer) | The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request. | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *delay* (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean +| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-aws/src/main/docs/aws-sdb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-sdb-component.adoc b/components/camel-aws/src/main/docs/aws-sdb-component.adoc index f133310..0163335 100644 --- a/components/camel-aws/src/main/docs/aws-sdb-component.adoc +++ b/components/camel-aws/src/main/docs/aws-sdb-component.adoc @@ -1,4 +1,4 @@ -## AWS SimpleDB Component +== AWS SimpleDB Component *Available as of Camel version 2.9* @@ -34,35 +34,37 @@ The AWS SimpleDB component has no options. // endpoint options: START The AWS SimpleDB endpoint is configured using URI syntax: - aws-sdb:domainName +---- +aws-sdb:domainName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **domainName** | *Required* The name of the domain currently worked with. | | String -|======================================================================= +| *domainName* | *Required* The name of the domain currently worked with. | | String +|=== -#### Query Parameters (11 parameters): +==== Query Parameters (11 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessKey** (producer) | Amazon AWS Access Key | | String -| **amazonSDBClient** (producer) | To use the AmazonSimpleDB as the client | | AmazonSimpleDB -| **amazonSdbEndpoint** (producer) | The region with which the AWS-SDB client wants to work with. | | String -| **consistentRead** (producer) | Determines whether or not strong consistency should be enforced when data is read. | false | boolean -| **maxNumberOfDomains** (producer) | The maximum number of domain names you want returned. The range is 1 to 100. | | Integer -| **operation** (producer) | Operation to perform | PutAttributes | SdbOperations -| **proxyHost** (producer) | To define a proxy host when instantiating the SDB client | | String -| **proxyPort** (producer) | To define a proxy port when instantiating the SDB client | | Integer -| **region** (producer) | The region in which SDB client needs to work | | String -| **secretKey** (producer) | Amazon AWS Secret Key | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *accessKey* (producer) | Amazon AWS Access Key | | String +| *amazonSDBClient* (producer) | To use the AmazonSimpleDB as the client | | AmazonSimpleDB +| *amazonSdbEndpoint* (producer) | The region with which the AWS-SDB client wants to work with. | | String +| *consistentRead* (producer) | Determines whether or not strong consistency should be enforced when data is read. | false | boolean +| *maxNumberOfDomains* (producer) | The maximum number of domain names you want returned. The range is 1 to 100. | | Integer +| *operation* (producer) | Operation to perform | PutAttributes | SdbOperations +| *proxyHost* (producer) | To define a proxy host when instantiating the SDB client | | String +| *proxyPort* (producer) | To define a proxy port when instantiating the SDB client | | Integer +| *region* (producer) | The region in which SDB client needs to work | | String +| *secretKey* (producer) | Amazon AWS Secret Key | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-aws/src/main/docs/aws-ses-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-ses-component.adoc b/components/camel-aws/src/main/docs/aws-ses-component.adoc index 4cd34e1..9893b08 100644 --- a/components/camel-aws/src/main/docs/aws-ses-component.adoc +++ b/components/camel-aws/src/main/docs/aws-ses-component.adoc @@ -1,4 +1,4 @@ -## AWS Simple Email Service Component +== AWS Simple Email Service Component *Available as of Camel version 2.9* @@ -34,36 +34,38 @@ The AWS Simple Email Service component has no options. // endpoint options: START The AWS Simple Email Service endpoint is configured using URI syntax: - aws-ses:from +---- +aws-ses:from +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **from** | *Required* The sender's email address. | | String -|======================================================================= +| *from* | *Required* The sender's email address. | | String +|=== -#### Query Parameters (12 parameters): +==== Query Parameters (12 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessKey** (producer) | Amazon AWS Access Key | | String -| **amazonSESClient** (producer) | To use the AmazonSimpleEmailService as the client | | AmazonSimpleEmail Service -| **amazonSESEndpoint** (producer) | The region with which the AWS-SES client wants to work with. | | String -| **proxyHost** (producer) | To define a proxy host when instantiating the SES client | | String -| **proxyPort** (producer) | To define a proxy port when instantiating the SES client | | Integer -| **region** (producer) | The region in which SES client needs to work | | String -| **replyToAddresses** (producer) | List of reply-to email address(es) for the message override it using 'CamelAwsSesReplyToAddresses' header. | | List -| **returnPath** (producer) | The email address to which bounce notifications are to be forwarded override it using 'CamelAwsSesReturnPath' header. | | String -| **secretKey** (producer) | Amazon AWS Secret Key | | String -| **subject** (producer) | The subject which is used if the message header 'CamelAwsSesSubject' is not present. | | String -| **to** (producer) | List of destination email address. Can be overriden with 'CamelAwsSesTo' header. | | List -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *accessKey* (producer) | Amazon AWS Access Key | | String +| *amazonSESClient* (producer) | To use the AmazonSimpleEmailService as the client | | AmazonSimpleEmail Service +| *amazonSESEndpoint* (producer) | The region with which the AWS-SES client wants to work with. | | String +| *proxyHost* (producer) | To define a proxy host when instantiating the SES client | | String +| *proxyPort* (producer) | To define a proxy port when instantiating the SES client | | Integer +| *region* (producer) | The region in which SES client needs to work | | String +| *replyToAddresses* (producer) | List of reply-to email address(es) for the message override it using 'CamelAwsSesReplyToAddresses' header. | | List +| *returnPath* (producer) | The email address to which bounce notifications are to be forwarded override it using 'CamelAwsSesReturnPath' header. | | String +| *secretKey* (producer) | Amazon AWS Secret Key | | String +| *subject* (producer) | The subject which is used if the message header 'CamelAwsSesSubject' is not present. | | String +| *to* (producer) | List of destination email address. Can be overriden with 'CamelAwsSesTo' header. | | List +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-aws/src/main/docs/aws-sns-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-sns-component.adoc b/components/camel-aws/src/main/docs/aws-sns-component.adoc index ac3839b..2009e5f 100644 --- a/components/camel-aws/src/main/docs/aws-sns-component.adoc +++ b/components/camel-aws/src/main/docs/aws-sns-component.adoc @@ -1,4 +1,4 @@ -## AWS Simple Notification System Component +== AWS Simple Notification System Component *Available as of Camel version 2.8* @@ -38,36 +38,38 @@ The AWS Simple Notification System component has no options. // endpoint options: START The AWS Simple Notification System endpoint is configured using URI syntax: - aws-sns:topicNameOrArn +---- +aws-sns:topicNameOrArn +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **topicNameOrArn** | *Required* Topic name or ARN | | String -|======================================================================= +| *topicNameOrArn* | *Required* Topic name or ARN | | String +|=== -#### Query Parameters (12 parameters): +==== Query Parameters (12 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessKey** (producer) | Amazon AWS Access Key | | String -| **amazonSNSClient** (producer) | To use the AmazonSNS as the client | | AmazonSNS -| **amazonSNSEndpoint** (producer) | The region with which the AWS-SNS client wants to work with. | | String -| **headerFilterStrategy** (producer) | To use a custom HeaderFilterStrategy to map headers to/from Camel. | | HeaderFilterStrategy -| **messageStructure** (producer) | The message structure to use such as json | | String -| **policy** (producer) | The policy for this queue | | String -| **proxyHost** (producer) | To define a proxy host when instantiating the SNS client | | String -| **proxyPort** (producer) | To define a proxy port when instantiating the SNS client | | Integer -| **region** (producer) | The region in which SNS client needs to work | | String -| **secretKey** (producer) | Amazon AWS Secret Key | | String -| **subject** (producer) | The subject which is used if the message header 'CamelAwsSnsSubject' is not present. | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *accessKey* (producer) | Amazon AWS Access Key | | String +| *amazonSNSClient* (producer) | To use the AmazonSNS as the client | | AmazonSNS +| *amazonSNSEndpoint* (producer) | The region with which the AWS-SNS client wants to work with. | | String +| *headerFilterStrategy* (producer) | To use a custom HeaderFilterStrategy to map headers to/from Camel. | | HeaderFilterStrategy +| *messageStructure* (producer) | The message structure to use such as json | | String +| *policy* (producer) | The policy for this queue | | String +| *proxyHost* (producer) | To define a proxy host when instantiating the SNS client | | String +| *proxyPort* (producer) | To define a proxy port when instantiating the SNS client | | Integer +| *region* (producer) | The region in which SNS client needs to work | | String +| *secretKey* (producer) | Amazon AWS Secret Key | | String +| *subject* (producer) | The subject which is used if the message header 'CamelAwsSnsSubject' is not present. | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END
