http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc index cdcaf94..cb75867 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc @@ -1,4 +1,4 @@ -## Kubernetes ConfigMap Component +== Kubernetes ConfigMap Component *Available as of Camel version 2.17* @@ -18,41 +18,43 @@ The Kubernetes ConfigMap component has no options. // endpoint options: START The Kubernetes ConfigMap endpoint is configured using URI syntax: - kubernetes-config-maps:masterUrl +---- +kubernetes-config-maps:masterUrl +---- 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 -| **masterUrl** | *Required* Kubernetes Master url | | String -|======================================================================= +| *masterUrl* | *Required* Kubernetes Master url | | String +|=== -#### Query Parameters (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (producer) | The Kubernetes API Version to use | | String -| **dnsDomain** (producer) | The dns domain used for ServiceCall EIP | | String -| **kubernetesClient** (producer) | Default KubernetesClient to use if provided | | KubernetesClient -| **operation** (producer) | Producer operation to do on Kubernetes | | String -| **portName** (producer) | The port name used for ServiceCall EIP | | String -| **connectionTimeout** (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **caCertData** (security) | The CA Cert Data | | String -| **caCertFile** (security) | The CA Cert File | | String -| **clientCertData** (security) | The Client Cert Data | | String -| **clientCertFile** (security) | The Client Cert File | | String -| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String -| **clientKeyData** (security) | The Client Key data | | String -| **clientKeyFile** (security) | The Client Key file | | String -| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String -| **oauthToken** (security) | The Auth Token | | String -| **password** (security) | Password to connect to Kubernetes | | String -| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean -| **username** (security) | Username to connect to Kubernetes | | String -|======================================================================= +| *apiVersion* (producer) | The Kubernetes API Version to use | | String +| *dnsDomain* (producer) | The dns domain used for ServiceCall EIP | | String +| *kubernetesClient* (producer) | Default KubernetesClient to use if provided | | KubernetesClient +| *operation* (producer) | Producer operation to do on Kubernetes | | String +| *portName* (producer) | The port name used for ServiceCall EIP | | String +| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *caCertData* (security) | The CA Cert Data | | String +| *caCertFile* (security) | The CA Cert File | | String +| *clientCertData* (security) | The Client Cert Data | | String +| *clientCertFile* (security) | The Client Cert File | | String +| *clientKeyAlgo* (security) | The Key Algorithm used by the client | | String +| *clientKeyData* (security) | The Client Key data | | String +| *clientKeyFile* (security) | The Client Key file | | String +| *clientKeyPassphrase* (security) | The Client Key Passphrase | | String +| *oauthToken* (security) | The Auth Token | | String +| *password* (security) | Password to connect to Kubernetes | | String +| *trustCerts* (security) | Define if the certs we used are trusted anyway or not | | Boolean +| *username* (security) | Username to connect to Kubernetes | | String +|=== // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc index b3a2349..a2cdc16 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc @@ -1,4 +1,4 @@ -## Kubernetes Deployments Component +== Kubernetes Deployments Component *Available as of Camel version 2.20* @@ -19,49 +19,51 @@ The Kubernetes Deployments component has no options. // endpoint options: START The Kubernetes Deployments endpoint is configured using URI syntax: - kubernetes-deployments:masterUrl +---- +kubernetes-deployments:masterUrl +---- 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 -| **masterUrl** | *Required* Kubernetes Master url | | String -|======================================================================= +| *masterUrl* | *Required* Kubernetes Master url | | String +|=== -#### Query Parameters (27 parameters): +==== Query Parameters (27 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (common) | The Kubernetes API Version to use | | String -| **dnsDomain** (common) | The dns domain used for ServiceCall EIP | | String -| **kubernetesClient** (common) | Default KubernetesClient to use if provided | | KubernetesClient -| **portName** (common) | The port name used for ServiceCall EIP | | 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 -| **labelKey** (consumer) | The Consumer Label key when watching at some resources | | String -| **labelValue** (consumer) | The Consumer Label value when watching at some resources | | String -| **namespace** (consumer) | The namespace | | String -| **poolSize** (consumer) | The Consumer pool size | 1 | int -| **resourceName** (consumer) | The Consumer Resource Name we would like to watch | | 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 -| **operation** (producer) | Producer operation to do on Kubernetes | | String -| **connectionTimeout** (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **caCertData** (security) | The CA Cert Data | | String -| **caCertFile** (security) | The CA Cert File | | String -| **clientCertData** (security) | The Client Cert Data | | String -| **clientCertFile** (security) | The Client Cert File | | String -| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String -| **clientKeyData** (security) | The Client Key data | | String -| **clientKeyFile** (security) | The Client Key file | | String -| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String -| **oauthToken** (security) | The Auth Token | | String -| **password** (security) | Password to connect to Kubernetes | | String -| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean -| **username** (security) | Username to connect to Kubernetes | | String -|======================================================================= +| *apiVersion* (common) | The Kubernetes API Version to use | | String +| *dnsDomain* (common) | The dns domain used for ServiceCall EIP | | String +| *kubernetesClient* (common) | Default KubernetesClient to use if provided | | KubernetesClient +| *portName* (common) | The port name used for ServiceCall EIP | | 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 +| *labelKey* (consumer) | The Consumer Label key when watching at some resources | | String +| *labelValue* (consumer) | The Consumer Label value when watching at some resources | | String +| *namespace* (consumer) | The namespace | | String +| *poolSize* (consumer) | The Consumer pool size | 1 | int +| *resourceName* (consumer) | The Consumer Resource Name we would like to watch | | 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 +| *operation* (producer) | Producer operation to do on Kubernetes | | String +| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *caCertData* (security) | The CA Cert Data | | String +| *caCertFile* (security) | The CA Cert File | | String +| *clientCertData* (security) | The Client Cert Data | | String +| *clientCertFile* (security) | The Client Cert File | | String +| *clientKeyAlgo* (security) | The Key Algorithm used by the client | | String +| *clientKeyData* (security) | The Client Key data | | String +| *clientKeyFile* (security) | The Client Key file | | String +| *clientKeyPassphrase* (security) | The Client Key Passphrase | | String +| *oauthToken* (security) | The Auth Token | | String +| *password* (security) | Password to connect to Kubernetes | | String +| *trustCerts* (security) | Define if the certs we used are trusted anyway or not | | Boolean +| *username* (security) | Username to connect to Kubernetes | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc index ba4893f..307e5e9 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc @@ -1,4 +1,4 @@ -## Kubernetes Namespaces Component +== Kubernetes Namespaces Component *Available as of Camel version 2.17* @@ -20,49 +20,51 @@ The Kubernetes Namespaces component has no options. // endpoint options: START The Kubernetes Namespaces endpoint is configured using URI syntax: - kubernetes-namespaces:masterUrl +---- +kubernetes-namespaces:masterUrl +---- 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 -| **masterUrl** | *Required* Kubernetes Master url | | String -|======================================================================= +| *masterUrl* | *Required* Kubernetes Master url | | String +|=== -#### Query Parameters (27 parameters): +==== Query Parameters (27 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (common) | The Kubernetes API Version to use | | String -| **dnsDomain** (common) | The dns domain used for ServiceCall EIP | | String -| **kubernetesClient** (common) | Default KubernetesClient to use if provided | | KubernetesClient -| **portName** (common) | The port name used for ServiceCall EIP | | 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 -| **labelKey** (consumer) | The Consumer Label key when watching at some resources | | String -| **labelValue** (consumer) | The Consumer Label value when watching at some resources | | String -| **namespace** (consumer) | The namespace | | String -| **poolSize** (consumer) | The Consumer pool size | 1 | int -| **resourceName** (consumer) | The Consumer Resource Name we would like to watch | | 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 -| **operation** (producer) | Producer operation to do on Kubernetes | | String -| **connectionTimeout** (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **caCertData** (security) | The CA Cert Data | | String -| **caCertFile** (security) | The CA Cert File | | String -| **clientCertData** (security) | The Client Cert Data | | String -| **clientCertFile** (security) | The Client Cert File | | String -| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String -| **clientKeyData** (security) | The Client Key data | | String -| **clientKeyFile** (security) | The Client Key file | | String -| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String -| **oauthToken** (security) | The Auth Token | | String -| **password** (security) | Password to connect to Kubernetes | | String -| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean -| **username** (security) | Username to connect to Kubernetes | | String -|======================================================================= +| *apiVersion* (common) | The Kubernetes API Version to use | | String +| *dnsDomain* (common) | The dns domain used for ServiceCall EIP | | String +| *kubernetesClient* (common) | Default KubernetesClient to use if provided | | KubernetesClient +| *portName* (common) | The port name used for ServiceCall EIP | | 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 +| *labelKey* (consumer) | The Consumer Label key when watching at some resources | | String +| *labelValue* (consumer) | The Consumer Label value when watching at some resources | | String +| *namespace* (consumer) | The namespace | | String +| *poolSize* (consumer) | The Consumer pool size | 1 | int +| *resourceName* (consumer) | The Consumer Resource Name we would like to watch | | 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 +| *operation* (producer) | Producer operation to do on Kubernetes | | String +| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *caCertData* (security) | The CA Cert Data | | String +| *caCertFile* (security) | The CA Cert File | | String +| *clientCertData* (security) | The Client Cert Data | | String +| *clientCertFile* (security) | The Client Cert File | | String +| *clientKeyAlgo* (security) | The Key Algorithm used by the client | | String +| *clientKeyData* (security) | The Client Key data | | String +| *clientKeyFile* (security) | The Client Key file | | String +| *clientKeyPassphrase* (security) | The Client Key Passphrase | | String +| *oauthToken* (security) | The Auth Token | | String +| *password* (security) | Password to connect to Kubernetes | | String +| *trustCerts* (security) | Define if the certs we used are trusted anyway or not | | Boolean +| *username* (security) | Username to connect to Kubernetes | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc index cfc9ecc..abd19d8 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc @@ -1,4 +1,4 @@ -## Kubernetes Nodes Component +== Kubernetes Nodes Component *Available as of Camel version 2.17* @@ -20,49 +20,51 @@ The Kubernetes Nodes component has no options. // endpoint options: START The Kubernetes Nodes endpoint is configured using URI syntax: - kubernetes-nodes:masterUrl +---- +kubernetes-nodes:masterUrl +---- 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 -| **masterUrl** | *Required* Kubernetes Master url | | String -|======================================================================= +| *masterUrl* | *Required* Kubernetes Master url | | String +|=== -#### Query Parameters (27 parameters): +==== Query Parameters (27 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (common) | The Kubernetes API Version to use | | String -| **dnsDomain** (common) | The dns domain used for ServiceCall EIP | | String -| **kubernetesClient** (common) | Default KubernetesClient to use if provided | | KubernetesClient -| **portName** (common) | The port name used for ServiceCall EIP | | 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 -| **labelKey** (consumer) | The Consumer Label key when watching at some resources | | String -| **labelValue** (consumer) | The Consumer Label value when watching at some resources | | String -| **namespace** (consumer) | The namespace | | String -| **poolSize** (consumer) | The Consumer pool size | 1 | int -| **resourceName** (consumer) | The Consumer Resource Name we would like to watch | | 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 -| **operation** (producer) | Producer operation to do on Kubernetes | | String -| **connectionTimeout** (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **caCertData** (security) | The CA Cert Data | | String -| **caCertFile** (security) | The CA Cert File | | String -| **clientCertData** (security) | The Client Cert Data | | String -| **clientCertFile** (security) | The Client Cert File | | String -| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String -| **clientKeyData** (security) | The Client Key data | | String -| **clientKeyFile** (security) | The Client Key file | | String -| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String -| **oauthToken** (security) | The Auth Token | | String -| **password** (security) | Password to connect to Kubernetes | | String -| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean -| **username** (security) | Username to connect to Kubernetes | | String -|======================================================================= +| *apiVersion* (common) | The Kubernetes API Version to use | | String +| *dnsDomain* (common) | The dns domain used for ServiceCall EIP | | String +| *kubernetesClient* (common) | Default KubernetesClient to use if provided | | KubernetesClient +| *portName* (common) | The port name used for ServiceCall EIP | | 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 +| *labelKey* (consumer) | The Consumer Label key when watching at some resources | | String +| *labelValue* (consumer) | The Consumer Label value when watching at some resources | | String +| *namespace* (consumer) | The namespace | | String +| *poolSize* (consumer) | The Consumer pool size | 1 | int +| *resourceName* (consumer) | The Consumer Resource Name we would like to watch | | 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 +| *operation* (producer) | Producer operation to do on Kubernetes | | String +| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *caCertData* (security) | The CA Cert Data | | String +| *caCertFile* (security) | The CA Cert File | | String +| *clientCertData* (security) | The Client Cert Data | | String +| *clientCertFile* (security) | The Client Cert File | | String +| *clientKeyAlgo* (security) | The Key Algorithm used by the client | | String +| *clientKeyData* (security) | The Client Key data | | String +| *clientKeyFile* (security) | The Client Key file | | String +| *clientKeyPassphrase* (security) | The Client Key Passphrase | | String +| *oauthToken* (security) | The Auth Token | | String +| *password* (security) | Password to connect to Kubernetes | | String +| *trustCerts* (security) | Define if the certs we used are trusted anyway or not | | Boolean +| *username* (security) | Username to connect to Kubernetes | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc index 37343db..e739135 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc @@ -1,4 +1,4 @@ -## Kubernetes Persistent Volume Claim Component +== Kubernetes Persistent Volume Claim Component *Available as of Camel version 2.17* @@ -19,41 +19,43 @@ The Kubernetes Persistent Volume Claim component has no options. // endpoint options: START The Kubernetes Persistent Volume Claim endpoint is configured using URI syntax: - kubernetes-persistent-volumes-claims:masterUrl +---- +kubernetes-persistent-volumes-claims:masterUrl +---- 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 -| **masterUrl** | *Required* Kubernetes Master url | | String -|======================================================================= +| *masterUrl* | *Required* Kubernetes Master url | | String +|=== -#### Query Parameters (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (producer) | The Kubernetes API Version to use | | String -| **dnsDomain** (producer) | The dns domain used for ServiceCall EIP | | String -| **kubernetesClient** (producer) | Default KubernetesClient to use if provided | | KubernetesClient -| **operation** (producer) | Producer operation to do on Kubernetes | | String -| **portName** (producer) | The port name used for ServiceCall EIP | | String -| **connectionTimeout** (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **caCertData** (security) | The CA Cert Data | | String -| **caCertFile** (security) | The CA Cert File | | String -| **clientCertData** (security) | The Client Cert Data | | String -| **clientCertFile** (security) | The Client Cert File | | String -| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String -| **clientKeyData** (security) | The Client Key data | | String -| **clientKeyFile** (security) | The Client Key file | | String -| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String -| **oauthToken** (security) | The Auth Token | | String -| **password** (security) | Password to connect to Kubernetes | | String -| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean -| **username** (security) | Username to connect to Kubernetes | | String -|======================================================================= +| *apiVersion* (producer) | The Kubernetes API Version to use | | String +| *dnsDomain* (producer) | The dns domain used for ServiceCall EIP | | String +| *kubernetesClient* (producer) | Default KubernetesClient to use if provided | | KubernetesClient +| *operation* (producer) | Producer operation to do on Kubernetes | | String +| *portName* (producer) | The port name used for ServiceCall EIP | | String +| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *caCertData* (security) | The CA Cert Data | | String +| *caCertFile* (security) | The CA Cert File | | String +| *clientCertData* (security) | The Client Cert Data | | String +| *clientCertFile* (security) | The Client Cert File | | String +| *clientKeyAlgo* (security) | The Key Algorithm used by the client | | String +| *clientKeyData* (security) | The Client Key data | | String +| *clientKeyFile* (security) | The Client Key file | | String +| *clientKeyPassphrase* (security) | The Client Key Passphrase | | String +| *oauthToken* (security) | The Auth Token | | String +| *password* (security) | Password to connect to Kubernetes | | String +| *trustCerts* (security) | Define if the certs we used are trusted anyway or not | | Boolean +| *username* (security) | Username to connect to Kubernetes | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc index fbc18b7..b30feb2 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc @@ -1,4 +1,4 @@ -## Kubernetes Persistent Volume Component +== Kubernetes Persistent Volume Component *Available as of Camel version 2.17* @@ -19,41 +19,43 @@ The Kubernetes Persistent Volume component has no options. // endpoint options: START The Kubernetes Persistent Volume endpoint is configured using URI syntax: - kubernetes-persistent-volumes:masterUrl +---- +kubernetes-persistent-volumes:masterUrl +---- 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 -| **masterUrl** | *Required* Kubernetes Master url | | String -|======================================================================= +| *masterUrl* | *Required* Kubernetes Master url | | String +|=== -#### Query Parameters (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (producer) | The Kubernetes API Version to use | | String -| **dnsDomain** (producer) | The dns domain used for ServiceCall EIP | | String -| **kubernetesClient** (producer) | Default KubernetesClient to use if provided | | KubernetesClient -| **operation** (producer) | Producer operation to do on Kubernetes | | String -| **portName** (producer) | The port name used for ServiceCall EIP | | String -| **connectionTimeout** (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **caCertData** (security) | The CA Cert Data | | String -| **caCertFile** (security) | The CA Cert File | | String -| **clientCertData** (security) | The Client Cert Data | | String -| **clientCertFile** (security) | The Client Cert File | | String -| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String -| **clientKeyData** (security) | The Client Key data | | String -| **clientKeyFile** (security) | The Client Key file | | String -| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String -| **oauthToken** (security) | The Auth Token | | String -| **password** (security) | Password to connect to Kubernetes | | String -| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean -| **username** (security) | Username to connect to Kubernetes | | String -|======================================================================= +| *apiVersion* (producer) | The Kubernetes API Version to use | | String +| *dnsDomain* (producer) | The dns domain used for ServiceCall EIP | | String +| *kubernetesClient* (producer) | Default KubernetesClient to use if provided | | KubernetesClient +| *operation* (producer) | Producer operation to do on Kubernetes | | String +| *portName* (producer) | The port name used for ServiceCall EIP | | String +| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *caCertData* (security) | The CA Cert Data | | String +| *caCertFile* (security) | The CA Cert File | | String +| *clientCertData* (security) | The Client Cert Data | | String +| *clientCertFile* (security) | The Client Cert File | | String +| *clientKeyAlgo* (security) | The Key Algorithm used by the client | | String +| *clientKeyData* (security) | The Client Key data | | String +| *clientKeyFile* (security) | The Client Key file | | String +| *clientKeyPassphrase* (security) | The Client Key Passphrase | | String +| *oauthToken* (security) | The Auth Token | | String +| *password* (security) | Password to connect to Kubernetes | | String +| *trustCerts* (security) | Define if the certs we used are trusted anyway or not | | Boolean +| *username* (security) | Username to connect to Kubernetes | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc index 0a720fb..2a2fa8d 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc @@ -1,4 +1,4 @@ -## Kubernetes Pods Component +== Kubernetes Pods Component *Available as of Camel version 2.17* @@ -19,49 +19,51 @@ The Kubernetes Pods component has no options. // endpoint options: START The Kubernetes Pods endpoint is configured using URI syntax: - kubernetes-pods:masterUrl +---- +kubernetes-pods:masterUrl +---- 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 -| **masterUrl** | *Required* Kubernetes Master url | | String -|======================================================================= +| *masterUrl* | *Required* Kubernetes Master url | | String +|=== -#### Query Parameters (27 parameters): +==== Query Parameters (27 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (common) | The Kubernetes API Version to use | | String -| **dnsDomain** (common) | The dns domain used for ServiceCall EIP | | String -| **kubernetesClient** (common) | Default KubernetesClient to use if provided | | KubernetesClient -| **portName** (common) | The port name used for ServiceCall EIP | | 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 -| **labelKey** (consumer) | The Consumer Label key when watching at some resources | | String -| **labelValue** (consumer) | The Consumer Label value when watching at some resources | | String -| **namespace** (consumer) | The namespace | | String -| **poolSize** (consumer) | The Consumer pool size | 1 | int -| **resourceName** (consumer) | The Consumer Resource Name we would like to watch | | 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 -| **operation** (producer) | Producer operation to do on Kubernetes | | String -| **connectionTimeout** (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **caCertData** (security) | The CA Cert Data | | String -| **caCertFile** (security) | The CA Cert File | | String -| **clientCertData** (security) | The Client Cert Data | | String -| **clientCertFile** (security) | The Client Cert File | | String -| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String -| **clientKeyData** (security) | The Client Key data | | String -| **clientKeyFile** (security) | The Client Key file | | String -| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String -| **oauthToken** (security) | The Auth Token | | String -| **password** (security) | Password to connect to Kubernetes | | String -| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean -| **username** (security) | Username to connect to Kubernetes | | String -|======================================================================= +| *apiVersion* (common) | The Kubernetes API Version to use | | String +| *dnsDomain* (common) | The dns domain used for ServiceCall EIP | | String +| *kubernetesClient* (common) | Default KubernetesClient to use if provided | | KubernetesClient +| *portName* (common) | The port name used for ServiceCall EIP | | 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 +| *labelKey* (consumer) | The Consumer Label key when watching at some resources | | String +| *labelValue* (consumer) | The Consumer Label value when watching at some resources | | String +| *namespace* (consumer) | The namespace | | String +| *poolSize* (consumer) | The Consumer pool size | 1 | int +| *resourceName* (consumer) | The Consumer Resource Name we would like to watch | | 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 +| *operation* (producer) | Producer operation to do on Kubernetes | | String +| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *caCertData* (security) | The CA Cert Data | | String +| *caCertFile* (security) | The CA Cert File | | String +| *clientCertData* (security) | The Client Cert Data | | String +| *clientCertFile* (security) | The Client Cert File | | String +| *clientKeyAlgo* (security) | The Key Algorithm used by the client | | String +| *clientKeyData* (security) | The Client Key data | | String +| *clientKeyFile* (security) | The Client Key file | | String +| *clientKeyPassphrase* (security) | The Client Key Passphrase | | String +| *oauthToken* (security) | The Auth Token | | String +| *password* (security) | Password to connect to Kubernetes | | String +| *trustCerts* (security) | Define if the certs we used are trusted anyway or not | | Boolean +| *username* (security) | Username to connect to Kubernetes | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc index 05c725c..698aa9e 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc @@ -1,4 +1,4 @@ -## Kubernetes Replication Controller Component +== Kubernetes Replication Controller Component *Available as of Camel version 2.17* @@ -20,49 +20,51 @@ The Kubernetes Replication Controller component has no options. // endpoint options: START The Kubernetes Replication Controller endpoint is configured using URI syntax: - kubernetes-replication-controllers:masterUrl +---- +kubernetes-replication-controllers:masterUrl +---- 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 -| **masterUrl** | *Required* Kubernetes Master url | | String -|======================================================================= +| *masterUrl* | *Required* Kubernetes Master url | | String +|=== -#### Query Parameters (27 parameters): +==== Query Parameters (27 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (common) | The Kubernetes API Version to use | | String -| **dnsDomain** (common) | The dns domain used for ServiceCall EIP | | String -| **kubernetesClient** (common) | Default KubernetesClient to use if provided | | KubernetesClient -| **portName** (common) | The port name used for ServiceCall EIP | | 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 -| **labelKey** (consumer) | The Consumer Label key when watching at some resources | | String -| **labelValue** (consumer) | The Consumer Label value when watching at some resources | | String -| **namespace** (consumer) | The namespace | | String -| **poolSize** (consumer) | The Consumer pool size | 1 | int -| **resourceName** (consumer) | The Consumer Resource Name we would like to watch | | 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 -| **operation** (producer) | Producer operation to do on Kubernetes | | String -| **connectionTimeout** (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **caCertData** (security) | The CA Cert Data | | String -| **caCertFile** (security) | The CA Cert File | | String -| **clientCertData** (security) | The Client Cert Data | | String -| **clientCertFile** (security) | The Client Cert File | | String -| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String -| **clientKeyData** (security) | The Client Key data | | String -| **clientKeyFile** (security) | The Client Key file | | String -| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String -| **oauthToken** (security) | The Auth Token | | String -| **password** (security) | Password to connect to Kubernetes | | String -| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean -| **username** (security) | Username to connect to Kubernetes | | String -|======================================================================= +| *apiVersion* (common) | The Kubernetes API Version to use | | String +| *dnsDomain* (common) | The dns domain used for ServiceCall EIP | | String +| *kubernetesClient* (common) | Default KubernetesClient to use if provided | | KubernetesClient +| *portName* (common) | The port name used for ServiceCall EIP | | 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 +| *labelKey* (consumer) | The Consumer Label key when watching at some resources | | String +| *labelValue* (consumer) | The Consumer Label value when watching at some resources | | String +| *namespace* (consumer) | The namespace | | String +| *poolSize* (consumer) | The Consumer pool size | 1 | int +| *resourceName* (consumer) | The Consumer Resource Name we would like to watch | | 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 +| *operation* (producer) | Producer operation to do on Kubernetes | | String +| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *caCertData* (security) | The CA Cert Data | | String +| *caCertFile* (security) | The CA Cert File | | String +| *clientCertData* (security) | The Client Cert Data | | String +| *clientCertFile* (security) | The Client Cert File | | String +| *clientKeyAlgo* (security) | The Key Algorithm used by the client | | String +| *clientKeyData* (security) | The Client Key data | | String +| *clientKeyFile* (security) | The Client Key file | | String +| *clientKeyPassphrase* (security) | The Client Key Passphrase | | String +| *oauthToken* (security) | The Auth Token | | String +| *password* (security) | Password to connect to Kubernetes | | String +| *trustCerts* (security) | Define if the certs we used are trusted anyway or not | | Boolean +| *username* (security) | Username to connect to Kubernetes | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc index f0c5dde..ea43531 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc @@ -1,4 +1,4 @@ -## Kubernetes Resources Quota Component +== Kubernetes Resources Quota Component *Available as of Camel version 2.17* @@ -19,41 +19,43 @@ The Kubernetes Resources Quota component has no options. // endpoint options: START The Kubernetes Resources Quota endpoint is configured using URI syntax: - kubernetes-resources-quota:masterUrl +---- +kubernetes-resources-quota:masterUrl +---- 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 -| **masterUrl** | *Required* Kubernetes Master url | | String -|======================================================================= +| *masterUrl* | *Required* Kubernetes Master url | | String +|=== -#### Query Parameters (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (producer) | The Kubernetes API Version to use | | String -| **dnsDomain** (producer) | The dns domain used for ServiceCall EIP | | String -| **kubernetesClient** (producer) | Default KubernetesClient to use if provided | | KubernetesClient -| **operation** (producer) | Producer operation to do on Kubernetes | | String -| **portName** (producer) | The port name used for ServiceCall EIP | | String -| **connectionTimeout** (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **caCertData** (security) | The CA Cert Data | | String -| **caCertFile** (security) | The CA Cert File | | String -| **clientCertData** (security) | The Client Cert Data | | String -| **clientCertFile** (security) | The Client Cert File | | String -| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String -| **clientKeyData** (security) | The Client Key data | | String -| **clientKeyFile** (security) | The Client Key file | | String -| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String -| **oauthToken** (security) | The Auth Token | | String -| **password** (security) | Password to connect to Kubernetes | | String -| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean -| **username** (security) | Username to connect to Kubernetes | | String -|======================================================================= +| *apiVersion* (producer) | The Kubernetes API Version to use | | String +| *dnsDomain* (producer) | The dns domain used for ServiceCall EIP | | String +| *kubernetesClient* (producer) | Default KubernetesClient to use if provided | | KubernetesClient +| *operation* (producer) | Producer operation to do on Kubernetes | | String +| *portName* (producer) | The port name used for ServiceCall EIP | | String +| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *caCertData* (security) | The CA Cert Data | | String +| *caCertFile* (security) | The CA Cert File | | String +| *clientCertData* (security) | The Client Cert Data | | String +| *clientCertFile* (security) | The Client Cert File | | String +| *clientKeyAlgo* (security) | The Key Algorithm used by the client | | String +| *clientKeyData* (security) | The Client Key data | | String +| *clientKeyFile* (security) | The Client Key file | | String +| *clientKeyPassphrase* (security) | The Client Key Passphrase | | String +| *oauthToken* (security) | The Auth Token | | String +| *password* (security) | Password to connect to Kubernetes | | String +| *trustCerts* (security) | Define if the certs we used are trusted anyway or not | | Boolean +| *username* (security) | Username to connect to Kubernetes | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc index ed30fa2..c5bf42d 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc @@ -1,4 +1,4 @@ -## Kubernetes Secrets Component +== Kubernetes Secrets Component *Available as of Camel version 2.17* @@ -19,41 +19,43 @@ The Kubernetes Secrets component has no options. // endpoint options: START The Kubernetes Secrets endpoint is configured using URI syntax: - kubernetes-secrets:masterUrl +---- +kubernetes-secrets:masterUrl +---- 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 -| **masterUrl** | *Required* Kubernetes Master url | | String -|======================================================================= +| *masterUrl* | *Required* Kubernetes Master url | | String +|=== -#### Query Parameters (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (producer) | The Kubernetes API Version to use | | String -| **dnsDomain** (producer) | The dns domain used for ServiceCall EIP | | String -| **kubernetesClient** (producer) | Default KubernetesClient to use if provided | | KubernetesClient -| **operation** (producer) | Producer operation to do on Kubernetes | | String -| **portName** (producer) | The port name used for ServiceCall EIP | | String -| **connectionTimeout** (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **caCertData** (security) | The CA Cert Data | | String -| **caCertFile** (security) | The CA Cert File | | String -| **clientCertData** (security) | The Client Cert Data | | String -| **clientCertFile** (security) | The Client Cert File | | String -| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String -| **clientKeyData** (security) | The Client Key data | | String -| **clientKeyFile** (security) | The Client Key file | | String -| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String -| **oauthToken** (security) | The Auth Token | | String -| **password** (security) | Password to connect to Kubernetes | | String -| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean -| **username** (security) | Username to connect to Kubernetes | | String -|======================================================================= +| *apiVersion* (producer) | The Kubernetes API Version to use | | String +| *dnsDomain* (producer) | The dns domain used for ServiceCall EIP | | String +| *kubernetesClient* (producer) | Default KubernetesClient to use if provided | | KubernetesClient +| *operation* (producer) | Producer operation to do on Kubernetes | | String +| *portName* (producer) | The port name used for ServiceCall EIP | | String +| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *caCertData* (security) | The CA Cert Data | | String +| *caCertFile* (security) | The CA Cert File | | String +| *clientCertData* (security) | The Client Cert Data | | String +| *clientCertFile* (security) | The Client Cert File | | String +| *clientKeyAlgo* (security) | The Key Algorithm used by the client | | String +| *clientKeyData* (security) | The Client Key data | | String +| *clientKeyFile* (security) | The Client Key file | | String +| *clientKeyPassphrase* (security) | The Client Key Passphrase | | String +| *oauthToken* (security) | The Auth Token | | String +| *password* (security) | Password to connect to Kubernetes | | String +| *trustCerts* (security) | Define if the certs we used are trusted anyway or not | | Boolean +| *username* (security) | Username to connect to Kubernetes | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc index bcb26e8..c7a32c6 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc @@ -1,4 +1,4 @@ -## Kubernetes Service Account Component +== Kubernetes Service Account Component *Available as of Camel version 2.17* @@ -17,41 +17,43 @@ The Kubernetes Service Account component has no options. // endpoint options: START The Kubernetes Service Account endpoint is configured using URI syntax: - kubernetes-service-accounts:masterUrl +---- +kubernetes-service-accounts:masterUrl +---- 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 -| **masterUrl** | *Required* Kubernetes Master url | | String -|======================================================================= +| *masterUrl* | *Required* Kubernetes Master url | | String +|=== -#### Query Parameters (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (producer) | The Kubernetes API Version to use | | String -| **dnsDomain** (producer) | The dns domain used for ServiceCall EIP | | String -| **kubernetesClient** (producer) | Default KubernetesClient to use if provided | | KubernetesClient -| **operation** (producer) | Producer operation to do on Kubernetes | | String -| **portName** (producer) | The port name used for ServiceCall EIP | | String -| **connectionTimeout** (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **caCertData** (security) | The CA Cert Data | | String -| **caCertFile** (security) | The CA Cert File | | String -| **clientCertData** (security) | The Client Cert Data | | String -| **clientCertFile** (security) | The Client Cert File | | String -| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String -| **clientKeyData** (security) | The Client Key data | | String -| **clientKeyFile** (security) | The Client Key file | | String -| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String -| **oauthToken** (security) | The Auth Token | | String -| **password** (security) | Password to connect to Kubernetes | | String -| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean -| **username** (security) | Username to connect to Kubernetes | | String -|======================================================================= +| *apiVersion* (producer) | The Kubernetes API Version to use | | String +| *dnsDomain* (producer) | The dns domain used for ServiceCall EIP | | String +| *kubernetesClient* (producer) | Default KubernetesClient to use if provided | | KubernetesClient +| *operation* (producer) | Producer operation to do on Kubernetes | | String +| *portName* (producer) | The port name used for ServiceCall EIP | | String +| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *caCertData* (security) | The CA Cert Data | | String +| *caCertFile* (security) | The CA Cert File | | String +| *clientCertData* (security) | The Client Cert Data | | String +| *clientCertFile* (security) | The Client Cert File | | String +| *clientKeyAlgo* (security) | The Key Algorithm used by the client | | String +| *clientKeyData* (security) | The Client Key data | | String +| *clientKeyFile* (security) | The Client Key file | | String +| *clientKeyPassphrase* (security) | The Client Key Passphrase | | String +| *oauthToken* (security) | The Auth Token | | String +| *password* (security) | Password to connect to Kubernetes | | String +| *trustCerts* (security) | Define if the certs we used are trusted anyway or not | | Boolean +| *username* (security) | Username to connect to Kubernetes | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc index ec62207..4e126de 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc @@ -1,4 +1,4 @@ -## Kubernetes Services Component +== Kubernetes Services Component *Available as of Camel version 2.17* @@ -20,49 +20,51 @@ The Kubernetes Services component has no options. // endpoint options: START The Kubernetes Services endpoint is configured using URI syntax: - kubernetes-services:masterUrl +---- +kubernetes-services:masterUrl +---- 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 -| **masterUrl** | *Required* Kubernetes Master url | | String -|======================================================================= +| *masterUrl* | *Required* Kubernetes Master url | | String +|=== -#### Query Parameters (27 parameters): +==== Query Parameters (27 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (common) | The Kubernetes API Version to use | | String -| **dnsDomain** (common) | The dns domain used for ServiceCall EIP | | String -| **kubernetesClient** (common) | Default KubernetesClient to use if provided | | KubernetesClient -| **portName** (common) | The port name used for ServiceCall EIP | | 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 -| **labelKey** (consumer) | The Consumer Label key when watching at some resources | | String -| **labelValue** (consumer) | The Consumer Label value when watching at some resources | | String -| **namespace** (consumer) | The namespace | | String -| **poolSize** (consumer) | The Consumer pool size | 1 | int -| **resourceName** (consumer) | The Consumer Resource Name we would like to watch | | 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 -| **operation** (producer) | Producer operation to do on Kubernetes | | String -| **connectionTimeout** (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **caCertData** (security) | The CA Cert Data | | String -| **caCertFile** (security) | The CA Cert File | | String -| **clientCertData** (security) | The Client Cert Data | | String -| **clientCertFile** (security) | The Client Cert File | | String -| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String -| **clientKeyData** (security) | The Client Key data | | String -| **clientKeyFile** (security) | The Client Key file | | String -| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String -| **oauthToken** (security) | The Auth Token | | String -| **password** (security) | Password to connect to Kubernetes | | String -| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean -| **username** (security) | Username to connect to Kubernetes | | String -|======================================================================= +| *apiVersion* (common) | The Kubernetes API Version to use | | String +| *dnsDomain* (common) | The dns domain used for ServiceCall EIP | | String +| *kubernetesClient* (common) | Default KubernetesClient to use if provided | | KubernetesClient +| *portName* (common) | The port name used for ServiceCall EIP | | 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 +| *labelKey* (consumer) | The Consumer Label key when watching at some resources | | String +| *labelValue* (consumer) | The Consumer Label value when watching at some resources | | String +| *namespace* (consumer) | The namespace | | String +| *poolSize* (consumer) | The Consumer pool size | 1 | int +| *resourceName* (consumer) | The Consumer Resource Name we would like to watch | | 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 +| *operation* (producer) | Producer operation to do on Kubernetes | | String +| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *caCertData* (security) | The CA Cert Data | | String +| *caCertFile* (security) | The CA Cert File | | String +| *clientCertData* (security) | The Client Cert Data | | String +| *clientCertFile* (security) | The Client Cert File | | String +| *clientKeyAlgo* (security) | The Key Algorithm used by the client | | String +| *clientKeyData* (security) | The Client Key data | | String +| *clientKeyFile* (security) | The Client Key file | | String +| *clientKeyPassphrase* (security) | The Client Key Passphrase | | String +| *oauthToken* (security) | The Auth Token | | String +| *password* (security) | Password to connect to Kubernetes | | String +| *trustCerts* (security) | Define if the certs we used are trusted anyway or not | | Boolean +| *username* (security) | Username to connect to Kubernetes | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ldap/src/main/docs/ldap-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ldap/src/main/docs/ldap-component.adoc b/components/camel-ldap/src/main/docs/ldap-component.adoc index 51f7b91..05f3523 100644 --- a/components/camel-ldap/src/main/docs/ldap-component.adoc +++ b/components/camel-ldap/src/main/docs/ldap-component.adoc @@ -1,4 +1,4 @@ -## LDAP Component +== LDAP Component *Available as of Camel version 1.5* @@ -49,29 +49,31 @@ The LDAP component has no options. // endpoint options: START The LDAP endpoint is configured using URI syntax: - ldap:dirContextName +---- +ldap:dirContextName +---- 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 -| **dirContextName** | *Required* Name of either a javax.naming.directory.DirContext or java.util.Hashtable or Map bean to lookup in the registry. If the bean is either a Hashtable or Map then a new javax.naming.directory.DirContext instance is created for each use. If the bean is a javax.naming.directory.DirContext then the bean is used as given. The latter may not be possible in all situations where the javax.naming.directory.DirContext must not be shared and in those situations it can be better to use java.util.Hashtable or Map instead. | | String -|======================================================================= +| *dirContextName* | *Required* Name of either a javax.naming.directory.DirContext or java.util.Hashtable or Map bean to lookup in the registry. If the bean is either a Hashtable or Map then a new javax.naming.directory.DirContext instance is created for each use. If the bean is a javax.naming.directory.DirContext then the bean is used as given. The latter may not be possible in all situations where the javax.naming.directory.DirContext must not be shared and in those situations it can be better to use java.util.Hashtable or Map instead. | | String +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **base** (producer) | The base DN for searches. | ou=system | String -| **pageSize** (producer) | When specified the ldap module uses paging to retrieve all results (most LDAP Servers throw an exception when trying to retrieve more than 1000 entries in one query). To be able to use this a LdapContext (subclass of DirContext) has to be passed in as ldapServerBean (otherwise an exception is thrown) | | Integer -| **returnedAttributes** (producer) | Comma-separated list of attributes that should be set in each entry of the result | | String -| **scope** (producer) | Specifies how deeply to search the tree of entries starting at the base DN. | subtree | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *base* (producer) | The base DN for searches. | ou=system | String +| *pageSize* (producer) | When specified the ldap module uses paging to retrieve all results (most LDAP Servers throw an exception when trying to retrieve more than 1000 entries in one query). To be able to use this a LdapContext (subclass of DirContext) has to be passed in as ldapServerBean (otherwise an exception is thrown) | | Integer +| *returnedAttributes* (producer) | Comma-separated list of attributes that should be set in each entry of the result | | String +| *scope* (producer) | Specifies how deeply to search the tree of entries starting at the base DN. | subtree | 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-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc index 0ea6e9b..4e07723 100644 --- a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc +++ b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc @@ -1,4 +1,4 @@ -## Linkedin Component +== Linkedin Component *Available as of Camel version 2.14* @@ -57,11 +57,11 @@ The Linkedin component supports 2 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 | | LinkedInConfiguration -| **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 | | LinkedInConfiguration +| *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 @@ -71,39 +71,41 @@ The Linkedin component supports 2 options which are listed below. // endpoint options: START The Linkedin endpoint is configured using URI syntax: - linkedin:apiName/methodName +---- +linkedin: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 | | LinkedInApiName -| **methodName** | *Required* What sub operation to use for the selected operation | | String -|======================================================================= +| *apiName* | *Required* What kind of operation to perform | | LinkedInApiName +| *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 -| **clientId** (common) | LinkedIn application client ID | | String -| **clientSecret** (common) | LinkedIn application client secret | | String -| **httpParams** (common) | Custom HTTP params for example proxy host and port use constants from AllClientPNames | | Map -| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String -| **lazyAuth** (common) | Flag to enable/disable lazy OAuth default is true. when enabled OAuth token retrieval or generation is not done until the first REST call | true | boolean -| **redirectUri** (common) | Application redirect URI although the component never redirects to this page to avoid having to have a functioning redirect server. So for testing one could use https://localhost | | String -| **scopes** (common) | List of LinkedIn scopes as specified at https://developer.linkedin.com/documents/authenticationgranting | | OAuthScope[] -| **secureStorage** (common) | Callback interface for providing an OAuth token or to store the token generated by the component. The callback should return null on the first call and then save the created token in the saveToken() callback. If the callback returns null the first time a userPassword MUST be provided | | OAuthSecureStorage -| **userName** (common) | LinkedIn user account name MUST be provided | | String -| **userPassword** (common) | LinkedIn account 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 -|======================================================================= +| *clientId* (common) | LinkedIn application client ID | | String +| *clientSecret* (common) | LinkedIn application client secret | | String +| *httpParams* (common) | Custom HTTP params for example proxy host and port use constants from AllClientPNames | | Map +| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| *lazyAuth* (common) | Flag to enable/disable lazy OAuth default is true. when enabled OAuth token retrieval or generation is not done until the first REST call | true | boolean +| *redirectUri* (common) | Application redirect URI although the component never redirects to this page to avoid having to have a functioning redirect server. So for testing one could use https://localhost | | String +| *scopes* (common) | List of LinkedIn scopes as specified at https://developer.linkedin.com/documents/authenticationgranting | | OAuthScope[] +| *secureStorage* (common) | Callback interface for providing an OAuth token or to store the token generated by the component. The callback should return null on the first call and then save the created token in the saveToken() callback. If the callback returns null the first time a userPassword MUST be provided | | OAuthSecureStorage +| *userName* (common) | LinkedIn user account name MUST be provided | | String +| *userPassword* (common) | LinkedIn account 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
