http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc b/components/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc index 6d0f3de..853a12c 100644 --- a/components/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc +++ b/components/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc @@ -1,4 +1,4 @@ -## Google BigQuery Component +== Google BigQuery Component *Available as of Camel version 2.20* @@ -63,41 +63,43 @@ The Google BigQuery component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **projectId** (producer) | Google Cloud Project Id | | String -| **datasetId** (producer) | BigQuery Dataset Id | | String -| **connectionFactory** (producer) | ConnectionFactory to obtain connection to Bigquery Service. If non provided the default one will be used | | GoogleBigQuery ConnectionFactory -| **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 -|======================================================================= +| *projectId* (producer) | Google Cloud Project Id | | String +| *datasetId* (producer) | BigQuery Dataset Id | | String +| *connectionFactory* (producer) | ConnectionFactory to obtain connection to Bigquery Service. If non provided the default one will be used | | GoogleBigQuery ConnectionFactory +| *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 Google BigQuery endpoint is configured using URI syntax: - google-bigquery:projectId:datasetId:tableName +---- +google-bigquery:projectId:datasetId:tableName +---- with the following path and query parameters: -#### Path Parameters (3 parameters): +==== Path Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **projectId** | *Required* Google Cloud Project Id | | String -| **datasetId** | *Required* BigQuery Dataset Id | | String -| **tableId** | BigQuery table id | | String -|======================================================================= +| *projectId* | *Required* Google Cloud Project Id | | String +| *datasetId* | *Required* BigQuery Dataset Id | | String +| *tableId* | BigQuery table id | | String +|=== -#### Query Parameters (3 parameters): +==== Query Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **connectionFactory** (producer) | ConnectionFactory to obtain connection to Bigquery Service. If non provided the default will be used. | | GoogleBigQuery ConnectionFactory -| **useAsInsertId** (producer) | Field name to use as insert id | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *connectionFactory* (producer) | ConnectionFactory to obtain connection to Bigquery Service. If non provided the default will be used. | | GoogleBigQuery ConnectionFactory +| *useAsInsertId* (producer) | Field name to use as insert id | | 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 ### Message Headers @@ -157,6 +159,3 @@ A insert id can be set on the exchange with the header `GoogleBigQueryConstants. query parameter `useAsInsertId`. As an insert id need to be specified per row inserted the exchange header can't be used when the payload is a list - if the payload is a list the `GoogleBigQueryConstants.INSERT_ID` will be ignored. In that case use the query parameter `useAsInsertId`. - - -
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc index c6616b8..cfbe61e 100644 --- a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc +++ b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc @@ -1,4 +1,4 @@ -## Google Calendar Component +== Google Calendar Component *Available as of Camel version 2.15* @@ -42,12 +42,12 @@ The Google Calendar component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | To use the shared configuration | | GoogleCalendar Configuration -| **clientFactory** (advanced) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory | | GoogleCalendarClient Factory -| **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) | To use the shared configuration | | GoogleCalendar Configuration +| *clientFactory* (advanced) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory | | GoogleCalendarClient Factory +| *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 @@ -60,39 +60,41 @@ The Google Calendar component supports 3 options which are listed below. // endpoint options: START The Google Calendar endpoint is configured using URI syntax: - google-calendar:apiName/methodName +---- +google-calendar:apiName/methodName +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiName** | *Required* What kind of operation to perform | | GoogleCalendarApiName -| **methodName** | *Required* What sub operation to use for the selected operation | | String -|======================================================================= +| *apiName* | *Required* What kind of operation to perform | | GoogleCalendarApiName +| *methodName* | *Required* What sub operation to use for the selected operation | | String +|=== -#### Query Parameters (14 parameters): +==== Query Parameters (14 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessToken** (common) | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | | String -| **applicationName** (common) | Google calendar application name. Example would be camel-google-calendar/1.0 | | String -| **clientId** (common) | Client ID of the calendar application | | String -| **clientSecret** (common) | Client secret of the calendar application | | String -| **emailAddress** (common) | The emailAddress of the Google Service Account. | | String -| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String -| **p12FileName** (common) | The name of the p12 file which has the private key to use with the Google Service Account. | | String -| **refreshToken** (common) | OAuth 2 refresh token. Using this the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. | | String -| **scopes** (common) | Specifies the level of permissions you want a calendar application to have to a user account. You can separate multiple scopes by comma. See https://developers.google.com/google-apps/calendar/auth for more info. | https://www.googleapis.com/auth/calendar | String -| **user** (common) | The email address of the user the application is trying to impersonate in the service account flow | | 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 -|======================================================================= +| *accessToken* (common) | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | | String +| *applicationName* (common) | Google calendar application name. Example would be camel-google-calendar/1.0 | | String +| *clientId* (common) | Client ID of the calendar application | | String +| *clientSecret* (common) | Client secret of the calendar application | | String +| *emailAddress* (common) | The emailAddress of the Google Service Account. | | String +| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| *p12FileName* (common) | The name of the p12 file which has the private key to use with the Google Service Account. | | String +| *refreshToken* (common) | OAuth 2 refresh token. Using this the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. | | String +| *scopes* (common) | Specifies the level of permissions you want a calendar application to have to a user account. You can separate multiple scopes by comma. See https://developers.google.com/google-apps/calendar/auth for more info. | https://www.googleapis.com/auth/calendar | String +| *user* (common) | The email address of the user the application is trying to impersonate in the service account flow | | 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-google-drive/src/main/docs/google-drive-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-google-drive/src/main/docs/google-drive-component.adoc b/components/camel-google-drive/src/main/docs/google-drive-component.adoc index 26f5339..44e1800 100644 --- a/components/camel-google-drive/src/main/docs/google-drive-component.adoc +++ b/components/camel-google-drive/src/main/docs/google-drive-component.adoc @@ -1,4 +1,4 @@ -## Google Drive Component +== Google Drive Component *Available as of Camel version 2.14* @@ -67,12 +67,12 @@ The Google Drive component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | To use the shared configuration | | GoogleDrive Configuration -| **clientFactory** (advanced) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory | | GoogleDriveClient Factory -| **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) | To use the shared configuration | | GoogleDrive Configuration +| *clientFactory* (advanced) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory | | GoogleDriveClient Factory +| *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 @@ -85,37 +85,39 @@ The Google Drive component supports 3 options which are listed below. // endpoint options: START The Google Drive endpoint is configured using URI syntax: - google-drive:apiName/methodName +---- +google-drive:apiName/methodName +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiName** | *Required* What kind of operation to perform | | GoogleDriveApiName -| **methodName** | *Required* What sub operation to use for the selected operation | | String -|======================================================================= +| *apiName* | *Required* What kind of operation to perform | | GoogleDriveApiName +| *methodName* | *Required* What sub operation to use for the selected operation | | String +|=== -#### Query Parameters (12 parameters): +==== Query Parameters (12 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessToken** (common) | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | | String -| **applicationName** (common) | Google drive application name. Example would be camel-google-drive/1.0 | | String -| **clientFactory** (common) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory | | GoogleDriveClient Factory -| **clientId** (common) | Client ID of the drive application | | String -| **clientSecret** (common) | Client secret of the drive application | | String -| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String -| **refreshToken** (common) | OAuth 2 refresh token. Using this the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. | | String -| **scopes** (common) | Specifies the level of permissions you want a drive application to have to a user account. See https://developers.google.com/drive/web/scopes for more info. | | List -| **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 -|======================================================================= +| *accessToken* (common) | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | | String +| *applicationName* (common) | Google drive application name. Example would be camel-google-drive/1.0 | | String +| *clientFactory* (common) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory | | GoogleDriveClient Factory +| *clientId* (common) | Client ID of the drive application | | String +| *clientSecret* (common) | Client secret of the drive application | | String +| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| *refreshToken* (common) | OAuth 2 refresh token. Using this the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. | | String +| *scopes* (common) | Specifies the level of permissions you want a drive application to have to a user account. See https://developers.google.com/drive/web/scopes for more info. | | List +| *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-google-mail/src/main/docs/google-mail-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-google-mail/src/main/docs/google-mail-component.adoc b/components/camel-google-mail/src/main/docs/google-mail-component.adoc index 95100c5..f7459e0 100644 --- a/components/camel-google-mail/src/main/docs/google-mail-component.adoc +++ b/components/camel-google-mail/src/main/docs/google-mail-component.adoc @@ -1,4 +1,4 @@ -## Google Mail Component +== Google Mail Component *Available as of Camel version 2.15* @@ -62,12 +62,12 @@ The Google Mail component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | To use the shared configuration | | GoogleMailConfiguration -| **clientFactory** (advanced) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory | | GoogleMailClient Factory -| **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) | To use the shared configuration | | GoogleMailConfiguration +| *clientFactory* (advanced) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory | | GoogleMailClient Factory +| *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 @@ -79,36 +79,38 @@ The Google Mail component supports 3 options which are listed below. // endpoint options: START The Google Mail endpoint is configured using URI syntax: - google-mail:apiName/methodName +---- +google-mail:apiName/methodName +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiName** | *Required* What kind of operation to perform | | GoogleMailApiName -| **methodName** | *Required* What sub operation to use for the selected operation | | String -|======================================================================= +| *apiName* | *Required* What kind of operation to perform | | GoogleMailApiName +| *methodName* | *Required* What sub operation to use for the selected operation | | String +|=== -#### Query Parameters (11 parameters): +==== Query Parameters (11 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessToken** (common) | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | | String -| **applicationName** (common) | Google mail application name. Example would be camel-google-mail/1.0 | | String -| **clientId** (common) | Client ID of the mail application | | String -| **clientSecret** (common) | Client secret of the mail application | | String -| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String -| **refreshToken** (common) | OAuth 2 refresh token. Using this the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. | | String -| **scopes** (common) | Specifies the level of permissions you want a mail application to have to a user account. See https://developers.google.com/gmail/api/auth/scopes for more info. | | List -| **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 -|======================================================================= +| *accessToken* (common) | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | | String +| *applicationName* (common) | Google mail application name. Example would be camel-google-mail/1.0 | | String +| *clientId* (common) | Client ID of the mail application | | String +| *clientSecret* (common) | Client secret of the mail application | | String +| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| *refreshToken* (common) | OAuth 2 refresh token. Using this the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. | | String +| *scopes* (common) | Specifies the level of permissions you want a mail application to have to a user account. See https://developers.google.com/gmail/api/auth/scopes for more info. | | List +| *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-google-pubsub/src/main/docs/google-pubsub-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc b/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc index 6f94639..ecc7650 100644 --- a/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc +++ b/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc @@ -1,4 +1,4 @@ -## Google Pubsub Component +== Google Pubsub Component *Available as of Camel version 2.19* @@ -61,44 +61,46 @@ The Google Pubsub component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **connectionFactory** (common) | Sets the connection factory to use: provides the ability to explicitly manage connection credentials: - the path to the key file - the Service Account Key / Email pair | | GooglePubsubConnection Factory -| **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 -|======================================================================= +| *connectionFactory* (common) | Sets the connection factory to use: provides the ability to explicitly manage connection credentials: - the path to the key file - the Service Account Key / Email pair | | GooglePubsubConnection Factory +| *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 Google Pubsub endpoint is configured using URI syntax: - google-pubsub:projectId:destinationName +---- +google-pubsub:projectId:destinationName +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **projectId** | *Required* Project Id | | String -| **destinationName** | *Required* Destination Name | | String -|======================================================================= +| *projectId* | *Required* Project Id | | String +| *destinationName* | *Required* Destination Name | | String +|=== -#### Query Parameters (9 parameters): +==== Query Parameters (9 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **ackMode** (common) | AUTO = exchange gets ack'ed/nack'ed on completion. NONE = downstream process has to ack/nack explicitly | AUTO | AckMode -| **concurrentConsumers** (common) | The number of parallel streams consuming from the subscription | 1 | Integer -| **connectionFactory** (common) | ConnectionFactory to obtain connection to PubSub Service. If non provided the default will be used. | | GooglePubsubConnection Factory -| **loggerId** (common) | Logger ID to use when a match to the parent route required | | String -| **maxMessagesPerPoll** (common) | The max number of messages to receive from the server in a single API call | 1 | Integer -| **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 -|======================================================================= +| *ackMode* (common) | AUTO = exchange gets ack'ed/nack'ed on completion. NONE = downstream process has to ack/nack explicitly | AUTO | AckMode +| *concurrentConsumers* (common) | The number of parallel streams consuming from the subscription | 1 | Integer +| *connectionFactory* (common) | ConnectionFactory to obtain connection to PubSub Service. If non provided the default will be used. | | GooglePubsubConnection Factory +| *loggerId* (common) | Logger ID to use when a match to the parent route required | | String +| *maxMessagesPerPoll* (common) | The max number of messages to receive from the server in a single API call | 1 | Integer +| *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 ### Producer Endpoints http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-gora/src/main/docs/gora-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-gora/src/main/docs/gora-component.adoc b/components/camel-gora/src/main/docs/gora-component.adoc index 9e3916a..49fb152 100644 --- a/components/camel-gora/src/main/docs/gora-component.adoc +++ b/components/camel-gora/src/main/docs/gora-component.adoc @@ -1,4 +1,4 @@ -## Gora Component +== Gora Component *Available as of Camel version 2.14* @@ -85,45 +85,47 @@ The Gora component has no options. // endpoint options: START The Gora endpoint is configured using URI syntax: - gora:name +---- +gora:name +---- 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 -| **name** | *Required* Instance name | | String -|======================================================================= +| *name* | *Required* Instance name | | String +|=== -#### Query Parameters (21 parameters): +==== Query Parameters (21 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **dataStoreClass** (common) | The type of the dataStore | | String -| **keyClass** (common) | The type class of the key | | String -| **valueClass** (common) | The type of the value | | 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 -| **concurrentConsumers** (consumer) | Number of concurrent consumers | 1 | int -| **endKey** (consumer) | The End Key | | Object -| **endTime** (consumer) | The End Time | | long -| **fields** (consumer) | The Fields | | Strings -| **keyRangeFrom** (consumer) | The Key Range From | | Object -| **keyRangeTo** (consumer) | The Key Range To | | Object -| **limit** (consumer) | The Limit | | long -| **startKey** (consumer) | The Start Key | | Object -| **startTime** (consumer) | The Start Time | | long -| **timeRangeFrom** (consumer) | The Time Range From | | long -| **timeRangeTo** (consumer) | The Time Range To | | long -| **timestamp** (consumer) | The Timestamp | | long -| **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 -| **flushOnEveryOperation** (producer) | Flush on every operation | true | boolean -| **hadoopConfiguration** (advanced) | Hadoop Configuration | | Configuration -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *dataStoreClass* (common) | The type of the dataStore | | String +| *keyClass* (common) | The type class of the key | | String +| *valueClass* (common) | The type of the value | | 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 +| *concurrentConsumers* (consumer) | Number of concurrent consumers | 1 | int +| *endKey* (consumer) | The End Key | | Object +| *endTime* (consumer) | The End Time | | long +| *fields* (consumer) | The Fields | | Strings +| *keyRangeFrom* (consumer) | The Key Range From | | Object +| *keyRangeTo* (consumer) | The Key Range To | | Object +| *limit* (consumer) | The Limit | | long +| *startKey* (consumer) | The Start Key | | Object +| *startTime* (consumer) | The Start Time | | long +| *timeRangeFrom* (consumer) | The Time Range From | | long +| *timeRangeTo* (consumer) | The Time Range To | | long +| *timestamp* (consumer) | The Timestamp | | long +| *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 +| *flushOnEveryOperation* (producer) | Flush on every operation | true | boolean +| *hadoopConfiguration* (advanced) | Hadoop Configuration | | Configuration +| *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-grape/src/main/docs/grape-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-grape/src/main/docs/grape-component.adoc b/components/camel-grape/src/main/docs/grape-component.adoc index 2119770..c725fd2 100644 --- a/components/camel-grape/src/main/docs/grape-component.adoc +++ b/components/camel-grape/src/main/docs/grape-component.adoc @@ -1,4 +1,4 @@ -## Grape Component +== Grape Component *Available as of Camel version 2.16* @@ -19,26 +19,28 @@ The Grape component has no options. // endpoint options: START The Grape endpoint is configured using URI syntax: - grape:defaultCoordinates +---- +grape:defaultCoordinates +---- 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 -| **defaultCoordinates** | *Required* Maven coordinates to use as default to grab if the message body is empty. | | String -|======================================================================= +| *defaultCoordinates* | *Required* Maven coordinates to use as default to grab if the message body is empty. | | String +|=== -#### Query Parameters (2 parameters): +==== Query Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **exchangePattern** () | Sets the default exchange pattern when creating an exchange. | InOnly | ExchangePattern -| **synchronous** () | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *exchangePattern* () | Sets the default exchange pattern when creating an exchange. | InOnly | ExchangePattern +| *synchronous* () | 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-groovy/src/main/docs/groovy-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-groovy/src/main/docs/groovy-language.adoc b/components/camel-groovy/src/main/docs/groovy-language.adoc index 017acef..0f6252b 100644 --- a/components/camel-groovy/src/main/docs/groovy-language.adoc +++ b/components/camel-groovy/src/main/docs/groovy-language.adoc @@ -1,4 +1,4 @@ -## Groovy Language +== Groovy Language *Available as of Camel version 1.3* @@ -30,10 +30,10 @@ The Groovy language supports 1 options which are listed below. [width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks -|======================================================================= +|=== // language options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-grpc/src/main/docs/grpc-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-grpc/src/main/docs/grpc-component.adoc b/components/camel-grpc/src/main/docs/grpc-component.adoc index 60ee8da..d1252b1 100644 --- a/components/camel-grpc/src/main/docs/grpc-component.adoc +++ b/components/camel-grpc/src/main/docs/grpc-component.adoc @@ -1,4 +1,4 @@ -## gRPC Component +== gRPC Component *Available as of Camel version 2.19* @@ -35,50 +35,52 @@ The gRPC component has no options. // endpoint options: START The gRPC endpoint is configured using URI syntax: - grpc:host:port/service +---- +grpc:host:port/service +---- with the following path and query parameters: -#### Path Parameters (3 parameters): +==== Path Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | *Required* The gRPC server host name. This is localhost or 0.0.0.0 when being a consumer or remote server host name when using producer. | | String -| **port** | *Required* The gRPC local or remote server port | | int -| **service** | *Required* Fully qualified service name from the protocol buffer descriptor file (package dot service definition name) | | String -|======================================================================= +| *host* | *Required* The gRPC server host name. This is localhost or 0.0.0.0 when being a consumer or remote server host name when using producer. | | String +| *port* | *Required* The gRPC local or remote server port | | int +| *service* | *Required* Fully qualified service name from the protocol buffer descriptor file (package dot service definition name) | | String +|=== -#### Query Parameters (24 parameters): +==== Query Parameters (24 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **flowControlWindow** (common) | The HTTP/2 flow control window size (MiB) | 1048576 | int -| **maxMessageSize** (common) | The maximum message size allowed to be received/sent (MiB) | 4194304 | int -| **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 -| **consumerStrategy** (consumer) | This option specifies the top-level strategy for processing service requests and responses in streaming mode. If an aggregation strategy is selected all requests will be accumulated in the list then transferred to the flow and the accumulated responses will be sent to the sender. If a propagation strategy is selected request is sent to the stream and the response will be immediately sent back to the sender. | PROPAGATION | GrpcConsumerStrategy -| **forwardOnCompleted** (consumer) | Determines if onCompleted events should be pushed to the Camel route. | false | boolean -| **forwardOnError** (consumer) | Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body. | false | boolean -| **maxConcurrentCallsPer Connection** (consumer) | The maximum number of concurrent calls permitted for each incoming server connection | 2147483647 | int -| **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 -| **method** (producer) | gRPC method name | | String -| **producerStrategy** (producer) | The mode used to communicate with a remote gRPC server. In SIMPLE mode a single exchange is translated into a remote procedure call. In STREAMING mode all exchanges will be sent within the same request (input and output of the recipient gRPC service must be of type 'stream'). | SIMPLE | GrpcProducerStrategy -| **streamRepliesTo** (producer) | When using STREAMING client mode it indicates the endpoint where responses should be forwarded. | | String -| **userAgent** (producer) | The user agent header passed to the server | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **authenticationType** (security) | Authentication method type in advance to the SSL/TLS negotiation | NONE | GrpcAuthType -| **jwtIssuer** (security) | JSON Web Token issuer | | String -| **jwtSecret** (security) | JSON Web Token secret | | String -| **jwtSubject** (security) | JSON Web Token subject | | String -| **keyCertChainResource** (security) | The X.509 certificate chain file resource in PEM format link | | String -| **keyPassword** (security) | The PKCS8 private key file password | | String -| **keyResource** (security) | The PKCS8 private key file resource in PEM format link | | String -| **negotiationType** (security) | Identifies the security negotiation type used for HTTP/2 communication | PLAINTEXT | NegotiationType -| **serviceAccountResource** (security) | Service Account key file in JSON format resource link supported by the Google Cloud SDK | | String -| **trustCertCollectionResource** (security) | The trusted certificates collection file resource in PEM format for verifying the remote endpoint's certificate | | String -|======================================================================= +| *flowControlWindow* (common) | The HTTP/2 flow control window size (MiB) | 1048576 | int +| *maxMessageSize* (common) | The maximum message size allowed to be received/sent (MiB) | 4194304 | int +| *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 +| *consumerStrategy* (consumer) | This option specifies the top-level strategy for processing service requests and responses in streaming mode. If an aggregation strategy is selected all requests will be accumulated in the list then transferred to the flow and the accumulated responses will be sent to the sender. If a propagation strategy is selected request is sent to the stream and the response will be immediately sent back to the sender. | PROPAGATION | GrpcConsumerStrategy +| *forwardOnCompleted* (consumer) | Determines if onCompleted events should be pushed to the Camel route. | false | boolean +| *forwardOnError* (consumer) | Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body. | false | boolean +| *maxConcurrentCallsPer Connection* (consumer) | The maximum number of concurrent calls permitted for each incoming server connection | 2147483647 | int +| *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 +| *method* (producer) | gRPC method name | | String +| *producerStrategy* (producer) | The mode used to communicate with a remote gRPC server. In SIMPLE mode a single exchange is translated into a remote procedure call. In STREAMING mode all exchanges will be sent within the same request (input and output of the recipient gRPC service must be of type 'stream'). | SIMPLE | GrpcProducerStrategy +| *streamRepliesTo* (producer) | When using STREAMING client mode it indicates the endpoint where responses should be forwarded. | | String +| *userAgent* (producer) | The user agent header passed to the server | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *authenticationType* (security) | Authentication method type in advance to the SSL/TLS negotiation | NONE | GrpcAuthType +| *jwtIssuer* (security) | JSON Web Token issuer | | String +| *jwtSecret* (security) | JSON Web Token secret | | String +| *jwtSubject* (security) | JSON Web Token subject | | String +| *keyCertChainResource* (security) | The X.509 certificate chain file resource in PEM format link | | String +| *keyPassword* (security) | The PKCS8 private key file password | | String +| *keyResource* (security) | The PKCS8 private key file resource in PEM format link | | String +| *negotiationType* (security) | Identifies the security negotiation type used for HTTP/2 communication | PLAINTEXT | NegotiationType +| *serviceAccountResource* (security) | Service Account key file in JSON format resource link supported by the Google Cloud SDK | | String +| *trustCertCollectionResource* (security) | The trusted certificates collection file resource in PEM format for verifying the remote endpoint's certificate | | String +|=== // endpoint options: END ### Transport security and authentication support (available from *Camel 2.20*) @@ -257,4 +259,3 @@ https://www.xolstice.org/protobuf-maven-plugin[Maven Protocol Buffers Plugin] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:protobuf.html[Protocol Buffers Data Format] - http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-gson/src/main/docs/json-gson-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-gson/src/main/docs/json-gson-dataformat.adoc b/components/camel-gson/src/main/docs/json-gson-dataformat.adoc index f241a47..7a302c7 100644 --- a/components/camel-gson/src/main/docs/json-gson-dataformat.adoc +++ b/components/camel-gson/src/main/docs/json-gson-dataformat.adoc @@ -1,4 +1,4 @@ -## JSon GSon DataFormat +== JSon GSon DataFormat *Available as of Camel version 2.10* @@ -21,7 +21,7 @@ The JSon GSon dataformat supports 17 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | objectMapper | | String | Lookup and use the existing ObjectMapper with the given id when using Jackson. | prettyPrint | false | Boolean | To enable pretty printing output nicely formatted. Is by default false. @@ -40,7 +40,7 @@ The JSon GSon dataformat supports 17 options which are listed below. | permissions | | String | Adds permissions that controls which Java packages and classes XStream is allowed to use during unmarshal from xml/json to Java beans. A permission must be configured either here or globally using a JVM system property. The permission can be specified in a syntax where a plus sign is allow and minus sign is deny. Wildcards is supported by using . as prefix. For example to allow com.foo and all subpackages then specfy com.foo.. Multiple permissions can be configured separated by comma such as com.foo.-com.foo.bar.MySecretBean. The following default permission is always included: -java.lang.java.util. unless its overridden by specifying a JVM system property with they key org.apache.camel.xstream.permissions. | allowUnmarshallType | false | Boolean | If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used. | 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-guava-eventbus/src/main/docs/guava-eventbus-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc index 0926d61..cf0c3d5 100644 --- a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc +++ b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc @@ -1,4 +1,4 @@ -## Guava EventBus Component +== Guava EventBus Component *Available as of Camel version 2.10* @@ -52,12 +52,12 @@ The Guava EventBus component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **eventBus** (common) | To use the given Guava EventBus instance | | EventBus -| **listenerInterface** (common) | The interface with method(s) marked with the Subscribe annotation. Dynamic proxy will be created over the interface so it could be registered as the EventBus listener. Particularly useful when creating multi-event listeners and for handling DeadEvent properly. This option cannot be used together with eventClass option. | | Class<?> -| **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 -|======================================================================= +| *eventBus* (common) | To use the given Guava EventBus instance | | EventBus +| *listenerInterface* (common) | The interface with method(s) marked with the Subscribe annotation. Dynamic proxy will be created over the interface so it could be registered as the EventBus listener. Particularly useful when creating multi-event listeners and for handling DeadEvent properly. This option cannot be used together with eventClass option. | | Class<?> +| *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 @@ -67,30 +67,32 @@ The Guava EventBus component supports 3 options which are listed below. // endpoint options: START The Guava EventBus endpoint is configured using URI syntax: - guava-eventbus:eventBusRef +---- +guava-eventbus:eventBusRef +---- 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 -| **eventBusRef** | To lookup the Guava EventBus from the registry with the given name | | String -|======================================================================= +| *eventBusRef* | To lookup the Guava EventBus from the registry with the given name | | String +|=== -#### Query Parameters (6 parameters): +==== Query Parameters (6 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **eventClass** (common) | If used on the consumer side of the route will filter events received from the EventBus to the instances of the class and superclasses of eventClass. Null value of this option is equal to setting it to the java.lang.Object i.e. the consumer will capture all messages incoming to the event bus. This option cannot be used together with listenerInterface option. | | Class<?> -| **listenerInterface** (common) | The interface with method(s) marked with the Subscribe annotation. Dynamic proxy will be created over the interface so it could be registered as the EventBus listener. Particularly useful when creating multi-event listeners and for handling DeadEvent properly. This option cannot be used together with eventClass option. | | Class<?> -| **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 -|======================================================================= +| *eventClass* (common) | If used on the consumer side of the route will filter events received from the EventBus to the instances of the class and superclasses of eventClass. Null value of this option is equal to setting it to the java.lang.Object i.e. the consumer will capture all messages incoming to the event bus. This option cannot be used together with listenerInterface option. | | Class<?> +| *listenerInterface* (common) | The interface with method(s) marked with the Subscribe annotation. Dynamic proxy will be created over the interface so it could be registered as the EventBus listener. Particularly useful when creating multi-event listeners and for handling DeadEvent properly. This option cannot be used together with eventClass option. | | Class<?> +| *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-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc index 99d6c39..e255b16 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc @@ -1,4 +1,4 @@ -## Hazelcast Atomic Number Component +== Hazelcast Atomic Number Component *Available as of Camel version 2.7* @@ -16,45 +16,47 @@ The Hazelcast Atomic Number component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hazelcastInstance** (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance -| **hazelcastMode** (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 -|======================================================================= +| *hazelcastInstance* (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance +| *hazelcastMode* (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 Hazelcast Atomic Number endpoint is configured using URI syntax: - hazelcast-atomicvalue:cacheName +---- +hazelcast-atomicvalue:cacheName +---- 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 -| **cacheName** | *Required* The name of the cache | | String -|======================================================================= +| *cacheName* | *Required* The name of the cache | | String +|=== -#### Query Parameters (10 parameters): +==== Query Parameters (10 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **reliable** (common) | Define if the endpoint will use a reliable Topic struct or not. | false | boolean -| **defaultOperation** (producer) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation -| **hazelcastInstance** (producer) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance -| **hazelcastInstanceName** (producer) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **concurrentConsumers** (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int -| **onErrorDelay** (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int -| **pollTimeout** (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int -| **transacted** (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean -| **transferExchange** (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean -|======================================================================= +| *reliable* (common) | Define if the endpoint will use a reliable Topic struct or not. | false | boolean +| *defaultOperation* (producer) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation +| *hazelcastInstance* (producer) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance +| *hazelcastInstanceName* (producer) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *concurrentConsumers* (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int +| *onErrorDelay* (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int +| *pollTimeout* (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int +| *transacted* (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean +| *transferExchange* (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc index e18cdb4..c8ac7fe 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc @@ -1,4 +1,4 @@ -## Hazelcast Instance Component +== Hazelcast Instance Component *Available as of Camel version 2.7* @@ -16,50 +16,52 @@ The Hazelcast Instance component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hazelcastInstance** (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance -| **hazelcastMode** (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 -|======================================================================= +| *hazelcastInstance* (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance +| *hazelcastMode* (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 Hazelcast Instance endpoint is configured using URI syntax: - hazelcast-instance:cacheName +---- +hazelcast-instance:cacheName +---- 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 -| **cacheName** | *Required* The name of the cache | | String -|======================================================================= +| *cacheName* | *Required* The name of the cache | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **reliable** (common) | Define if the endpoint will use a reliable Topic struct 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 -| **defaultOperation** (consumer) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation -| **hazelcastInstance** (consumer) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance -| **hazelcastInstanceName** (consumer) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String -| **pollingTimeout** (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long -| **poolSize** (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int -| **queueConsumerMode** (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode -| **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 -| **concurrentConsumers** (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int -| **onErrorDelay** (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int -| **pollTimeout** (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int -| **transacted** (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean -| **transferExchange** (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean -|======================================================================= +| *reliable* (common) | Define if the endpoint will use a reliable Topic struct 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 +| *defaultOperation* (consumer) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation +| *hazelcastInstance* (consumer) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance +| *hazelcastInstanceName* (consumer) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String +| *pollingTimeout* (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long +| *poolSize* (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int +| *queueConsumerMode* (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode +| *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 +| *concurrentConsumers* (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int +| *onErrorDelay* (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int +| *pollTimeout* (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int +| *transacted* (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean +| *transferExchange* (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc index 2b0989f..944ab31 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc @@ -1,4 +1,4 @@ -## Hazelcast List Component +== Hazelcast List Component *Available as of Camel version 2.7* @@ -12,50 +12,52 @@ The Hazelcast List component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hazelcastInstance** (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance -| **hazelcastMode** (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 -|======================================================================= +| *hazelcastInstance* (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance +| *hazelcastMode* (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 Hazelcast List endpoint is configured using URI syntax: - hazelcast-list:cacheName +---- +hazelcast-list:cacheName +---- 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 -| **cacheName** | *Required* The name of the cache | | String -|======================================================================= +| *cacheName* | *Required* The name of the cache | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultOperation** (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation -| **hazelcastInstance** (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance -| **hazelcastInstanceName** (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String -| **reliable** (common) | Define if the endpoint will use a reliable Topic struct 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 -| **pollingTimeout** (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long -| **poolSize** (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int -| **queueConsumerMode** (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode -| **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 -| **concurrentConsumers** (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int -| **onErrorDelay** (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int -| **pollTimeout** (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int -| **transacted** (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean -| **transferExchange** (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean -|======================================================================= +| *defaultOperation* (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation +| *hazelcastInstance* (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance +| *hazelcastInstanceName* (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String +| *reliable* (common) | Define if the endpoint will use a reliable Topic struct 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 +| *pollingTimeout* (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long +| *poolSize* (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int +| *queueConsumerMode* (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode +| *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 +| *concurrentConsumers* (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int +| *onErrorDelay* (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int +| *pollTimeout* (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int +| *transacted* (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean +| *transferExchange* (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean +|=== // endpoint options: END
