http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-atom/src/main/docs/atom-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atom/src/main/docs/atom-component.adoc b/components/camel-atom/src/main/docs/atom-component.adoc index 6b3f7fc..7afb95e 100644 --- a/components/camel-atom/src/main/docs/atom-component.adoc +++ b/components/camel-atom/src/main/docs/atom-component.adoc @@ -40,13 +40,26 @@ The Atom component has no options. // endpoint options: START -The Atom component supports 28 endpoint options which are listed below: +The Atom component is configured using the URI syntax with the following path and query parameters: + + atom:feedUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| feedUri | | String | *Required* The URI to the feed to poll. +|======================================================================= +{% endraw %} + +#### 27 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| feedUri | consumer | | String | *Required* The URI to the feed to poll. | bridgeErrorHandler | consumer | false | boolean | 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. | feedHeader | consumer | true | boolean | Sets whether to add the feed object as a header | filter | consumer | true | boolean | Sets whether to use filtering or not of the entries.
http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-avro/src/main/docs/avro-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-avro/src/main/docs/avro-component.adoc b/components/camel-avro/src/main/docs/avro-component.adoc index 243dcb7..e547b65 100644 --- a/components/camel-avro/src/main/docs/avro-component.adoc +++ b/components/camel-avro/src/main/docs/avro-component.adoc @@ -191,16 +191,29 @@ The Avro component supports 2 options which are listed below. // endpoint options: START -The Avro component supports 14 endpoint options which are listed below: +The Avro component is configured using the URI syntax with the following path and query parameters: + + avro:transport:host:port/messageName + +#### 4 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| transport | | AvroTransport | *Required* Transport to use +| port | | int | *Required* Port number to use +| host | | String | *Required* Hostname to use +| messageName | | String | The name of the message to send. +|======================================================================= +{% endraw %} + +#### 10 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| transport | common | | AvroTransport | *Required* Transport to use -| port | common | | int | *Required* Port number to use -| host | common | | String | *Required* Hostname to use -| messageName | common | | String | The name of the message to send. | protocol | common | | Protocol | Avro protocol to use | protocolClassName | common | | String | Avro protocol to use defined by the FQN class name | protocolLocation | common | | String | Avro protocol location http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-aws/src/main/docs/aws-cw-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-cw-component.adoc b/components/camel-aws/src/main/docs/aws-cw-component.adoc index 2365474..c369608 100644 --- a/components/camel-aws/src/main/docs/aws-cw-component.adoc +++ b/components/camel-aws/src/main/docs/aws-cw-component.adoc @@ -35,13 +35,26 @@ The AWS CloudWatch component has no options. // endpoint options: START -The AWS CloudWatch component supports 12 endpoint options which are listed below: +The AWS CloudWatch component is configured using the URI syntax with the following path and query parameters: + + aws-cw:namespace + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| namespace | | String | *Required* The metric namespace +|======================================================================= +{% endraw %} + +#### 11 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| namespace | producer | | String | *Required* The metric namespace | accessKey | producer | | String | Amazon AWS Access Key | amazonCwClient | producer | | AmazonCloudWatch | To use the AmazonCloudWatch as the client | amazonCwEndpoint | producer | | String | The region with which the AWS-CW client wants to work with. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-aws/src/main/docs/aws-ddb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-ddb-component.adoc b/components/camel-aws/src/main/docs/aws-ddb-component.adoc index c559156..8d6ab25 100644 --- a/components/camel-aws/src/main/docs/aws-ddb-component.adoc +++ b/components/camel-aws/src/main/docs/aws-ddb-component.adoc @@ -32,13 +32,26 @@ The AWS DynamoDB component has no options. // endpoint options: START -The AWS DynamoDB component supports 14 endpoint options which are listed below: +The AWS DynamoDB component is configured using the URI syntax with the following path and query parameters: + + aws-ddb:tableName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| tableName | | String | *Required* The name of the table currently worked with. +|======================================================================= +{% endraw %} + +#### 13 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| tableName | producer | | String | *Required* The name of the table currently worked with. | accessKey | producer | | String | Amazon AWS Access Key | amazonDDBClient | producer | | AmazonDynamoDB | To use the AmazonDynamoDB as the client | amazonDdbEndpoint | producer | | String | The region with which the AWS-DDB client wants to work with. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc b/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc index cef8944..a81420d 100644 --- a/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc +++ b/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc @@ -35,13 +35,26 @@ The AWS DynamoDB Streams component has no options. // endpoint options: START -The AWS DynamoDB Streams component supports 24 endpoint options which are listed below: +The AWS DynamoDB Streams component is configured using the URI syntax with the following path and query parameters: + + aws-ddbstream:tableName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| tableName | | String | *Required* Name of the dynamodb table +|======================================================================= +{% endraw %} + +#### 23 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| tableName | consumer | | String | *Required* Name of the dynamodb table | amazonDynamoDbStreamsClient | consumer | | AmazonDynamoDBStreams | *Required* Amazon DynamoDB client to use for all requests for this endpoint | bridgeErrorHandler | consumer | false | boolean | 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. | iteratorType | consumer | LATEST | ShardIteratorType | Defines where in the DynaboDB stream to start getting records. Note that using TRIM_HORIZON can cause a significant delay before the stream has caught up to real-time. if ATAFTER_SEQUENCE_NUMBER are used then a sequenceNumberProvider MUST be supplied. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-aws/src/main/docs/aws-ec2-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-ec2-component.adoc b/components/camel-aws/src/main/docs/aws-ec2-component.adoc index 4565f01..c86fbad 100644 --- a/components/camel-aws/src/main/docs/aws-ec2-component.adoc +++ b/components/camel-aws/src/main/docs/aws-ec2-component.adoc @@ -32,13 +32,26 @@ The AWS EC2 component has no options. // endpoint options: START -The AWS EC2 component supports 9 endpoint options which are listed below: +The AWS EC2 component is configured using the URI syntax with the following path and query parameters: + + aws-ec2:label + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| label | | String | *Required* Logical name +|======================================================================= +{% endraw %} + +#### 8 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| label | producer | | String | *Required* Logical name | accessKey | producer | | String | Amazon AWS Access Key | amazonEc2Client | producer | | AmazonEC2Client | To use a existing configured AmazonEC2Client as client | amazonEc2Endpoint | producer | | String | The region with which the AWS-EC2 client wants to work with. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-aws/src/main/docs/aws-kinesis-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-kinesis-component.adoc b/components/camel-aws/src/main/docs/aws-kinesis-component.adoc index e0e4ee1..1b82fb5 100644 --- a/components/camel-aws/src/main/docs/aws-kinesis-component.adoc +++ b/components/camel-aws/src/main/docs/aws-kinesis-component.adoc @@ -36,13 +36,26 @@ The AWS Kinesis component has no options. // endpoint options: START -The AWS Kinesis component supports 25 endpoint options which are listed below: +The AWS Kinesis component is configured using the URI syntax with the following path and query parameters: + + aws-kinesis:streamName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| streamName | | String | *Required* Name of the stream +|======================================================================= +{% endraw %} + +#### 24 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| streamName | common | | String | *Required* Name of the stream | amazonKinesisClient | common | | AmazonKinesis | *Required* Amazon Kinesis client to use for all requests for this endpoint | bridgeErrorHandler | consumer | false | boolean | 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. | iteratorType | consumer | TRIM_HORIZON | ShardIteratorType | Defines where in the Kinesis stream to start getting records http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-aws/src/main/docs/aws-s3-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-s3-component.adoc b/components/camel-aws/src/main/docs/aws-s3-component.adoc index be9a3a2..4695a2a 100644 --- a/components/camel-aws/src/main/docs/aws-s3-component.adoc +++ b/components/camel-aws/src/main/docs/aws-s3-component.adoc @@ -49,13 +49,26 @@ The AWS S3 Storage Service component has no options. // endpoint options: START -The AWS S3 Storage Service component supports 41 endpoint options which are listed below: +The AWS S3 Storage Service component is configured using the URI syntax with the following path and query parameters: + + aws-s3:bucketNameOrArn + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| bucketNameOrArn | | String | *Required* Bucket name or ARN +|======================================================================= +{% endraw %} + +#### 40 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| bucketNameOrArn | common | | String | *Required* Bucket name or ARN | accessKey | common | | String | Amazon AWS Access Key | amazonS3Client | common | | AmazonS3 | Reference to a com.amazonaws.services.sqs.AmazonS3 in the link:registry.htmlRegistry. | amazonS3Endpoint | common | | String | The region with which the AWS-S3 client wants to work with. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-aws/src/main/docs/aws-sdb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-sdb-component.adoc b/components/camel-aws/src/main/docs/aws-sdb-component.adoc index 8ef45b4..c0ff794 100644 --- a/components/camel-aws/src/main/docs/aws-sdb-component.adoc +++ b/components/camel-aws/src/main/docs/aws-sdb-component.adoc @@ -32,13 +32,26 @@ The AWS SimpleDB component has no options. // endpoint options: START -The AWS SimpleDB component supports 11 endpoint options which are listed below: +The AWS SimpleDB component is configured using the URI syntax with the following path and query parameters: + + aws-sdb:domainName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| domainName | | String | *Required* The name of the domain currently worked with. +|======================================================================= +{% endraw %} + +#### 10 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| domainName | producer | | String | *Required* The name of the domain currently worked with. | accessKey | producer | | String | Amazon AWS Access Key | amazonSDBClient | producer | | AmazonSimpleDB | To use the AmazonSimpleDB as the client | amazonSdbEndpoint | producer | | String | The region with which the AWS-SDB client wants to work with. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-aws/src/main/docs/aws-ses-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-ses-component.adoc b/components/camel-aws/src/main/docs/aws-ses-component.adoc index c5556ea..6630926 100644 --- a/components/camel-aws/src/main/docs/aws-ses-component.adoc +++ b/components/camel-aws/src/main/docs/aws-ses-component.adoc @@ -32,13 +32,26 @@ The AWS Simple Email Service component has no options. // endpoint options: START -The AWS Simple Email Service component supports 12 endpoint options which are listed below: +The AWS Simple Email Service component is configured using the URI syntax with the following path and query parameters: + + aws-ses:from + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| from | | String | *Required* The sender's email address. +|======================================================================= +{% endraw %} + +#### 11 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| from | producer | | String | *Required* The sender's email address. | accessKey | producer | | String | Amazon AWS Access Key | amazonSESClient | producer | | AmazonSimpleEmailService | To use the AmazonSimpleEmailService as the client | amazonSESEndpoint | producer | | String | The region with which the AWS-SES client wants to work with. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-aws/src/main/docs/aws-sns-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-sns-component.adoc b/components/camel-aws/src/main/docs/aws-sns-component.adoc index 5677bc0..0782b58 100644 --- a/components/camel-aws/src/main/docs/aws-sns-component.adoc +++ b/components/camel-aws/src/main/docs/aws-sns-component.adoc @@ -36,13 +36,26 @@ The AWS Simple Notification System component has no options. // endpoint options: START -The AWS Simple Notification System component supports 11 endpoint options which are listed below: +The AWS Simple Notification System component is configured using the URI syntax with the following path and query parameters: + + aws-sns:topicNameOrArn + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| topicNameOrArn | | String | *Required* Topic name or ARN +|======================================================================= +{% endraw %} + +#### 10 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| topicNameOrArn | producer | | String | *Required* Topic name or ARN | accessKey | producer | | String | Amazon AWS Access Key | amazonSNSClient | producer | | AmazonSNS | To use the AmazonSNS as the client | amazonSNSEndpoint | producer | | String | The region with which the AWS-SNS client wants to work with. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-aws/src/main/docs/aws-sqs-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-sqs-component.adoc b/components/camel-aws/src/main/docs/aws-sqs-component.adoc index 642f0ca..b7acbb8 100644 --- a/components/camel-aws/src/main/docs/aws-sqs-component.adoc +++ b/components/camel-aws/src/main/docs/aws-sqs-component.adoc @@ -37,13 +37,26 @@ The AWS Simple Queue Service component has no options. // endpoint options: START -The AWS Simple Queue Service component supports 45 endpoint options which are listed below: +The AWS Simple Queue Service component is configured using the URI syntax with the following path and query parameters: + + aws-sqs:queueNameOrArn + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| queueNameOrArn | | String | *Required* Queue name or ARN +|======================================================================= +{% endraw %} + +#### 44 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| queueNameOrArn | common | | String | *Required* Queue name or ARN | accessKey | common | | String | Amazon AWS Access Key | amazonSQSClient | common | | AmazonSQS | To use the AmazonSQS as client | amazonSQSEndpoint | common | | String | The region with which the AWS-SQS client wants to work with. Only works if Camel creates the AWS-SQS client i.e. if you explicitly set amazonSQSClient then this setting will have no effect. You would have to set it on the client you create directly http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-aws/src/main/docs/aws-swf-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-swf-component.adoc b/components/camel-aws/src/main/docs/aws-swf-component.adoc index d315c3d..0052bf6 100644 --- a/components/camel-aws/src/main/docs/aws-swf-component.adoc +++ b/components/camel-aws/src/main/docs/aws-swf-component.adoc @@ -32,13 +32,26 @@ The AWS Simple Workflow component has no options. // endpoint options: START -The AWS Simple Workflow component supports 30 endpoint options which are listed below: +The AWS Simple Workflow component is configured using the URI syntax with the following path and query parameters: + + aws-swf:type + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| type | | String | *Required* Activity or workflow +|======================================================================= +{% endraw %} + +#### 29 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| type | common | | String | *Required* Activity or workflow | accessKey | common | | String | Amazon AWS Access Key. | amazonSWClient | common | | AmazonSimpleWorkflowClient | To use the given AmazonSimpleWorkflowClient as client | dataConverter | common | | DataConverter | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-azure/src/main/docs/azure-blob-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-azure/src/main/docs/azure-blob-component.adoc b/components/camel-azure/src/main/docs/azure-blob-component.adoc index 765e25e..1e4b785 100644 --- a/components/camel-azure/src/main/docs/azure-blob-component.adoc +++ b/components/camel-azure/src/main/docs/azure-blob-component.adoc @@ -48,13 +48,26 @@ The Azure Storage Blob Service component has no options. // endpoint options: START -The Azure Storage Blob Service component supports 20 endpoint options which are listed below: +The Azure Storage Blob Service component is configured using the URI syntax with the following path and query parameters: + + azure-blob:containerOrBlobUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| containerOrBlobUri | | String | *Required* Container or Blob compact Uri +|======================================================================= +{% endraw %} + +#### 19 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| containerOrBlobUri | common | | String | *Required* Container or Blob compact Uri | azureBlobClient | common | | CloudBlob | The blob service client | blobOffset | common | 0 | Long | Set the blob offset for the upload or download operations default is 0 | blobType | common | blockblob | BlobType | Set a blob type 'blockblob' is default http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-azure/src/main/docs/azure-queue-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-azure/src/main/docs/azure-queue-component.adoc b/components/camel-azure/src/main/docs/azure-queue-component.adoc index c50f454..329b1ae 100644 --- a/components/camel-azure/src/main/docs/azure-queue-component.adoc +++ b/components/camel-azure/src/main/docs/azure-queue-component.adoc @@ -48,13 +48,26 @@ The Azure Storage Queue Service component has no options. // endpoint options: START -The Azure Storage Queue Service component supports 11 endpoint options which are listed below: +The Azure Storage Queue Service component is configured using the URI syntax with the following path and query parameters: + + azure-queue:containerAndQueueUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| containerAndQueueUri | | String | *Required* Container Queue compact Uri +|======================================================================= +{% endraw %} + +#### 10 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| containerAndQueueUri | common | | String | *Required* Container Queue compact Uri | azureQueueClient | common | | CloudQueue | The queue service client | credentials | common | | StorageCredentials | Set the storage credentials required in most cases | bridgeErrorHandler | consumer | false | boolean | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc b/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc index f09f110..f7ec473 100644 --- a/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc +++ b/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc @@ -50,13 +50,26 @@ The Bean Validator component has no options. // endpoint options: START -The Bean Validator component supports 7 endpoint options which are listed below: +The Bean Validator component is configured using the URI syntax with the following path and query parameters: + + bean-validator:label + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| label | | String | *Required* Where label is an arbitrary text value describing the endpoint +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| label | producer | | String | *Required* Where label is an arbitrary text value describing the endpoint | constraintValidatorFactory | producer | | ConstraintValidatorFactory | To use a custom ConstraintValidatorFactory | group | producer | javax.validation.groups.Default | String | To use a custom validation group | messageInterpolator | producer | | MessageInterpolator | To use a custom MessageInterpolator http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc index 2b44beb..7d8f151 100644 --- a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc +++ b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc @@ -75,13 +75,26 @@ The Beanstalk component supports 2 options which are listed below. // endpoint options: START -The Beanstalk component supports 27 endpoint options which are listed below: +The Beanstalk component is configured using the URI syntax with the following path and query parameters: + + beanstalk:connectionSettings + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| connectionSettings | | String | Connection settings host:port/tube +|======================================================================= +{% endraw %} + +#### 26 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| connectionSettings | common | | String | Connection settings host:port/tube | command | common | | BeanstalkCommand | put means to put the job into Beanstalk. Job body is specified in the Camel message body. Job ID will be returned in beanstalk.jobId message header. delete release touch or bury expect Job ID in the message header beanstalk.jobId. Result of the operation is returned in beanstalk.result message header kick expects the number of jobs to kick in the message body and returns the number of jobs actually kicked out in the message header beanstalk.result. | jobDelay | common | 0 | int | Job delay in seconds. | jobPriority | common | 1000 | long | Job priority. (0 is the highest see Beanstalk protocol) http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-bonita/src/main/docs/bonita-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-bonita/src/main/docs/bonita-component.adoc b/components/camel-bonita/src/main/docs/bonita-component.adoc index 13a6fd3..e936c22 100644 --- a/components/camel-bonita/src/main/docs/bonita-component.adoc +++ b/components/camel-bonita/src/main/docs/bonita-component.adoc @@ -21,13 +21,26 @@ The Bonita component has no options. // endpoint options: START -The Bonita component supports 10 endpoint options which are listed below: +The Bonita component is configured using the URI syntax with the following path and query parameters: + + bonita:operation + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| operation | | BonitaOperation | *Required* Operation to use +|======================================================================= +{% endraw %} + +#### 9 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| operation | consumer | | BonitaOperation | *Required* Operation to use | bridgeErrorHandler | consumer | false | boolean | 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. | hostname | consumer | localhost | String | Hostname where Bonita engine runs | port | consumer | 8080 | String | Port of the server hosting Bonita engine http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-box/src/main/docs/box-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-box/src/main/docs/box-component.adoc b/components/camel-box/src/main/docs/box-component.adoc index 0d43f7e..8d78681 100644 --- a/components/camel-box/src/main/docs/box-component.adoc +++ b/components/camel-box/src/main/docs/box-component.adoc @@ -59,14 +59,27 @@ The Box component supports 2 options which are listed below. // endpoint options: START -The Box component supports 21 endpoint options which are listed below: +The Box component is configured using the URI syntax with the following path and query parameters: + + box:apiName/methodName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| apiName | | BoxApiName | *Required* What kind of operation to perform +| methodName | | String | *Required* What sub operation to use for the selected operation +|======================================================================= +{% endraw %} + +#### 19 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| apiName | common | | BoxApiName | *Required* What kind of operation to perform -| methodName | common | | String | *Required* What sub operation to use for the selected operation | clientId | common | | String | Box application client ID | inBody | common | | String | Sets the name of a parameter to be passed in the exchange In Body | loginTimeout | common | 30 | int | Amount of time the component will wait for a response from Box.com default is 30 seconds http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-braintree/src/main/docs/braintree-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-braintree/src/main/docs/braintree-component.adoc b/components/camel-braintree/src/main/docs/braintree-component.adoc index 6563e27..6109a9b 100644 --- a/components/camel-braintree/src/main/docs/braintree-component.adoc +++ b/components/camel-braintree/src/main/docs/braintree-component.adoc @@ -54,14 +54,27 @@ The Braintree component supports 2 options which are listed below. // endpoint options: START -The Braintree component supports 15 endpoint options which are listed below: +The Braintree component is configured using the URI syntax with the following path and query parameters: + + braintree:apiName/methodName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| apiName | | BraintreeApiName | *Required* What kind of operation to perform +| methodName | | String | What sub operation to use for the selected operation +|======================================================================= +{% endraw %} + +#### 13 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| apiName | common | | BraintreeApiName | *Required* What kind of operation to perform -| methodName | common | | String | What sub operation to use for the selected operation | environment | common | | String | *Required* The environment Either SANDBOX or PRODUCTION | inBody | common | | String | Sets the name of a parameter to be passed in the exchange In Body | merchantId | common | | String | *Required* The merchant id provided by Braintree. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-cache/src/main/docs/cache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cache/src/main/docs/cache-component.adoc b/components/camel-cache/src/main/docs/cache-component.adoc index 5c61f79..71c6735 100644 --- a/components/camel-cache/src/main/docs/cache-component.adoc +++ b/components/camel-cache/src/main/docs/cache-component.adoc @@ -66,13 +66,26 @@ The EHCache component supports 4 options which are listed below. // endpoint options: START -The EHCache component supports 20 endpoint options which are listed below: +The EHCache component is configured using the URI syntax with the following path and query parameters: + + cache:cacheName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| cacheName | | String | *Required* Name of the cache +|======================================================================= +{% endraw %} + +#### 19 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| cacheName | common | | String | *Required* Name of the cache | diskExpiryThreadIntervalSeconds | common | | long | The number of seconds between runs of the disk expiry thread. | diskPersistent | common | false | boolean | Whether the disk store persists between restarts of the application. | diskStorePath | common | | String | This parameter is ignored. CacheManager sets it using setter injection. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-cassandraql/src/main/docs/cql-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cassandraql/src/main/docs/cql-component.adoc b/components/camel-cassandraql/src/main/docs/cql-component.adoc index 9ad6233..f074cfb 100644 --- a/components/camel-cassandraql/src/main/docs/cql-component.adoc +++ b/components/camel-cassandraql/src/main/docs/cql-component.adoc @@ -60,16 +60,29 @@ The Cassandra CQL component has no options. // endpoint options: START -The Cassandra CQL component supports 18 endpoint options which are listed below: +The Cassandra CQL component is configured using the URI syntax with the following path and query parameters: + + cql:beanRef:hosts:port/keyspace + +#### 4 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| beanRef | | String | beanRef is defined using bean:id +| hosts | | String | Hostname(s) cassansdra server(s). Multiple hosts can be separated by comma. +| port | | Integer | Port number of cassansdra server(s) +| keyspace | | String | Keyspace to use +|======================================================================= +{% endraw %} + +#### 14 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| beanRef | common | | String | beanRef is defined using bean:id -| hosts | common | | String | Hostname(s) cassansdra server(s). Multiple hosts can be separated by comma. -| port | common | | Integer | Port number of cassansdra server(s) -| keyspace | common | | String | Keyspace to use | cluster | common | | Cluster | To use the Cluster instance (you would normally not use this option) | clusterName | common | | String | Cluster name | consistencyLevel | common | | ConsistencyLevel | Consistency level to use http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc b/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc index b99f9a0..66c5bf5 100644 --- a/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc +++ b/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc @@ -9,14 +9,27 @@ The Chronicle Engine component has no options. // endpoint options: START -The Chronicle Engine component supports 14 endpoint options which are listed below: +The Chronicle Engine component is configured using the URI syntax with the following path and query parameters: + + chronicle-engine:addresses/path + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| addresses | | String | *Required* Engine addresses. Multiple addresses can be separated by comman. +| path | | String | *Required* Engine path +|======================================================================= +{% endraw %} + +#### 12 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| addresses | common | | String | *Required* Engine addresses. Multiple addresses can be separated by comman. -| path | common | | String | *Required* Engine path | action | common | | String | The default action to perform valid values are: - PUBLISH - PPUBLISH_AND_INDEX - PPUT - PGET_AND_PUT - PPUT_ALL - PPUT_IF_ABSENT - PGET - PGET_AND_REMOVE - PREMOVE - PIS_EMPTY - PSIZE | clusterName | common | | String | Cluster name for queue | filteredMapEvents | common | | String | A comma separated list of Map event type to filer valid values are: INSERT UPDATE REMOVE. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-chunk/src/main/docs/chunk-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-chunk/src/main/docs/chunk-component.adoc b/components/camel-chunk/src/main/docs/chunk-component.adoc index 9211e62..1986cb0 100644 --- a/components/camel-chunk/src/main/docs/chunk-component.adoc +++ b/components/camel-chunk/src/main/docs/chunk-component.adoc @@ -42,13 +42,26 @@ The Chunk component has no options. // endpoint options: START -The Chunk component supports 8 endpoint options which are listed below: +The Chunk component is configured using the URI syntax with the following path and query parameters: + + chunk:resourceUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| resourceUri | | String | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. +|======================================================================= +{% endraw %} + +#### 7 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| resourceUri | producer | | String | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | contentCache | producer | false | boolean | Sets whether to use resource content cache or not | encoding | producer | | String | Define the encoding of the body | extension | producer | | String | Define the file extension of the template http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc b/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc index 76e8f07..ff0db8f 100644 --- a/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc +++ b/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc @@ -37,13 +37,26 @@ The CM SMS Gateway component has no options. // endpoint options: START -The CM SMS Gateway component supports 6 endpoint options which are listed below: +The CM SMS Gateway component is configured using the URI syntax with the following path and query parameters: + + cm-sms:host + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* SMS Provider HOST with scheme +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | producer | | String | *Required* SMS Provider HOST with scheme | defaultFrom | producer | | String | This is the sender name. The maximum length is 11 characters. | defaultMaxNumberOfParts | producer | 8 | int | If it is a multipart message forces the max number. Message can be truncated. Technically the gateway will first check if a message is larger than 160 characters if so the message will be cut into multiple 153 characters parts limited by these parameters. | productToken | producer | | String | *Required* The unique token to use http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-cmis/src/main/docs/cmis-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cmis/src/main/docs/cmis-component.adoc b/components/camel-cmis/src/main/docs/cmis-component.adoc index c1839ce..5f9a4d3 100644 --- a/components/camel-cmis/src/main/docs/cmis-component.adoc +++ b/components/camel-cmis/src/main/docs/cmis-component.adoc @@ -38,13 +38,26 @@ The CMIS component supports 2 options which are listed below. // endpoint options: START -The CMIS component supports 14 endpoint options which are listed below: +The CMIS component is configured using the URI syntax with the following path and query parameters: + + cmis:cmsUrl + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| cmsUrl | | String | *Required* URL to the cmis repository +|======================================================================= +{% endraw %} + +#### 13 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| cmsUrl | common | | String | *Required* URL to the cmis repository | pageSize | common | 100 | int | Number of nodes to retrieve per page | readContent | common | false | boolean | If set to true the content of document node will be retrieved in addition to the properties | readCount | common | | int | Max number of nodes to read http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-coap/src/main/docs/coap-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-coap/src/main/docs/coap-component.adoc b/components/camel-coap/src/main/docs/coap-component.adoc index c4850c0..be5ce52 100644 --- a/components/camel-coap/src/main/docs/coap-component.adoc +++ b/components/camel-coap/src/main/docs/coap-component.adoc @@ -31,13 +31,26 @@ The CoAP component has no options. // endpoint options: START -The CoAP component supports 6 endpoint options which are listed below: +The CoAP component is configured using the URI syntax with the following path and query parameters: + + coap:uri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| uri | | URI | The URI for the CoAP endpoint +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| uri | common | | URI | The URI for the CoAP endpoint | coapMethod | common | * | String | The CoAP method this endpoint binds to. Default is to bind to all () but can be restricted to GET POST PUT DELETE PING | bridgeErrorHandler | consumer | false | boolean | 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. | exceptionHandler | consumer (advanced) | | ExceptionHandler | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-cometd/src/main/docs/cometd-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cometd/src/main/docs/cometd-component.adoc b/components/camel-cometd/src/main/docs/cometd-component.adoc index df42284..9913959 100644 --- a/components/camel-cometd/src/main/docs/cometd-component.adoc +++ b/components/camel-cometd/src/main/docs/cometd-component.adoc @@ -73,15 +73,28 @@ The CometD component supports 7 options which are listed below. // endpoint options: START -The CometD component supports 19 endpoint options which are listed below: +The CometD component is configured using the URI syntax with the following path and query parameters: + + cometd:host:port/channelName + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* Hostname +| port | | int | *Required* Host port number +| channelName | | String | *Required* The channelName represents a topic that can be subscribed to by the Camel endpoints. +|======================================================================= +{% endraw %} + +#### 16 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | | String | *Required* Hostname -| port | common | | int | *Required* Host port number -| channelName | common | | String | *Required* The channelName represents a topic that can be subscribed to by the Camel endpoints. | allowedOrigins | common | * | String | The origins domain that support to cross if the crosssOriginFilterOn is true | baseResource | common | | String | The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar | crossOriginFilterOn | common | false | boolean | If true the server will support for cross-domain filtering http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-consul/src/main/docs/consul-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-consul/src/main/docs/consul-component.adoc b/components/camel-consul/src/main/docs/consul-component.adoc index 1f0ca2b..44a0f21 100644 --- a/components/camel-consul/src/main/docs/consul-component.adoc +++ b/components/camel-consul/src/main/docs/consul-component.adoc @@ -44,13 +44,26 @@ The Consul component has no options. // endpoint options: START -The Consul component supports 22 endpoint options which are listed below: +The Consul component is configured using the URI syntax with the following path and query parameters: + + consul:apiEndpoint + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| apiEndpoint | | String | *Required* The API endpoint +|======================================================================= +{% endraw %} + +#### 21 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| apiEndpoint | common | | String | *Required* The API endpoint | connectTimeoutMillis | common | | Long | Connect timeout for OkHttpClient | dc | common | | String | The data center | key | common | | String | The default key. Can be overridden by CamelConsulKey http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-context/src/main/docs/context-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-context/src/main/docs/context-component.adoc b/components/camel-context/src/main/docs/context-component.adoc index 56b1379..80f1d3c 100644 --- a/components/camel-context/src/main/docs/context-component.adoc +++ b/components/camel-context/src/main/docs/context-component.adoc @@ -48,14 +48,27 @@ The Camel Context component has no options. // endpoint options: START -The Camel Context component supports 6 endpoint options which are listed below: +The Camel Context component is configured using the URI syntax with the following path and query parameters: + + context:contextId:localEndpointUrl + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| contextId | | String | *Required* Is the ID you used to register the CamelContext into the Registry. +| localEndpointUrl | | String | *Required* Can be a valid Camel URI evaluated within the black box CamelContext. Or it can be a logical name which is mapped to any local endpoints. For example if you locally have endpoints like direct:invoices and seda:purchaseOrders inside a CamelContext of id supplyChain then you can just use the URIs supplyChain:invoices or supplyChain:purchaseOrders to omit the physical endpoint kind and use pure logical URIs. +|======================================================================= +{% endraw %} + +#### 4 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| contextId | common | | String | *Required* Is the ID you used to register the CamelContext into the Registry. -| localEndpointUrl | common | | String | *Required* Can be a valid Camel URI evaluated within the black box CamelContext. Or it can be a logical name which is mapped to any local endpoints. For example if you locally have endpoints like direct:invoices and seda:purchaseOrders inside a CamelContext of id supplyChain then you can just use the URIs supplyChain:invoices or supplyChain:purchaseOrders to omit the physical endpoint kind and use pure logical URIs. | bridgeErrorHandler | consumer | false | boolean | 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. | exceptionHandler | consumer (advanced) | | ExceptionHandler | 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. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-couchbase/src/main/docs/couchbase-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-couchbase/src/main/docs/couchbase-component.adoc b/components/camel-couchbase/src/main/docs/couchbase-component.adoc index ae7aace..572df2d 100644 --- a/components/camel-couchbase/src/main/docs/couchbase-component.adoc +++ b/components/camel-couchbase/src/main/docs/couchbase-component.adoc @@ -33,14 +33,27 @@ The Couchbase component has no options. // component options: END // endpoint options: START -The Couchbase component supports 50 endpoint options which are listed below: +The Couchbase component is configured using the URI syntax with the following path and query parameters: + + couchbase:url + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| protocol | | String | *Required* The protocol to use +| hostname | | String | *Required* The hostname to use +|======================================================================= +{% endraw %} + +#### 48 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| protocol | common | | String | *Required* The protocol to use -| hostname | common | | String | *Required* The hostname to use | bucket | common | | String | The bucket to use | key | common | | String | The key to use | port | common | 8091 | int | The port number to use http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-couchdb/src/main/docs/couchdb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-couchdb/src/main/docs/couchdb-component.adoc b/components/camel-couchdb/src/main/docs/couchdb-component.adoc index 1b33695..7582ae2 100644 --- a/components/camel-couchdb/src/main/docs/couchdb-component.adoc +++ b/components/camel-couchdb/src/main/docs/couchdb-component.adoc @@ -48,16 +48,29 @@ The CouchDB component has no options. // component options: END // endpoint options: START -The CouchDB component supports 16 endpoint options which are listed below: +The CouchDB component is configured using the URI syntax with the following path and query parameters: + + couchdb:protocol:hostname:port/database + +#### 4 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| protocol | | String | *Required* The protocol to use for communicating with the database. +| hostname | | String | *Required* Hostname of the running couchdb instance +| port | 5984 | int | Port number for the running couchdb instance +| database | | String | *Required* Name of the database to use +|======================================================================= +{% endraw %} + +#### 12 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| protocol | common | | String | *Required* The protocol to use for communicating with the database. -| hostname | common | | String | *Required* Hostname of the running couchdb instance -| port | common | 5984 | int | Port number for the running couchdb instance -| database | common | | String | *Required* Name of the database to use | createDatabase | common | false | boolean | Creates the database if it does not already exist | bridgeErrorHandler | consumer | false | boolean | 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. | deletes | consumer | true | boolean | Document deletes are published as events http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-crypto/src/main/docs/crypto-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-crypto/src/main/docs/crypto-component.adoc b/components/camel-crypto/src/main/docs/crypto-component.adoc index 3e2323c..eb0084c 100644 --- a/components/camel-crypto/src/main/docs/crypto-component.adoc +++ b/components/camel-crypto/src/main/docs/crypto-component.adoc @@ -95,14 +95,27 @@ The Crypto (JCE) component supports 2 options which are listed below. // component options: END // endpoint options: START -The Crypto (JCE) component supports 21 endpoint options which are listed below: +The Crypto (JCE) component is configured using the URI syntax with the following path and query parameters: + + crypto:cryptoOperation:name + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| cryptoOperation | | CryptoOperation | *Required* Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation. +| name | | String | *Required* The logical name of this operation. +|======================================================================= +{% endraw %} + +#### 19 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| cryptoOperation | producer | | CryptoOperation | *Required* Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation. -| name | producer | | String | *Required* The logical name of this operation. | algorithm | producer | SHA1WithDSA | String | Sets the JCE name of the Algorithm that should be used for the signer. | alias | producer | | String | Sets the alias used to query the KeyStore for keys and link java.security.cert.Certificate Certificates to be used in signing and verifying exchanges. This value can be provided at runtime via the message header link org.apache.camel.component.crypto.DigitalSignatureConstantsKEYSTORE_ALIAS | certificateName | producer | | String | Sets the reference name for a PrivateKey that can be fond in the registry. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-cxf/src/main/docs/cxf-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cxf/src/main/docs/cxf-component.adoc b/components/camel-cxf/src/main/docs/cxf-component.adoc index a3b2c45..a9938fc 100644 --- a/components/camel-cxf/src/main/docs/cxf-component.adoc +++ b/components/camel-cxf/src/main/docs/cxf-component.adoc @@ -132,14 +132,27 @@ The CXF component supports 3 options which are listed below. // endpoint options: START -The CXF component supports 36 endpoint options which are listed below: +The CXF component is configured using the URI syntax with the following path and query parameters: + + cxf:beanId:address + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| beanId | | String | To lookup an existing configured CxfEndpoint. Must used bean: as prefix. +| address | | String | The service publish address. +|======================================================================= +{% endraw %} + +#### 34 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| beanId | common | | String | To lookup an existing configured CxfEndpoint. Must used bean: as prefix. -| address | service | | String | The service publish address. | dataFormat | common | POJO | DataFormat | The data type messages supported by the CXF endpoint. | wrappedStyle | common | | Boolean | The WSDL style that describes how parameters are represented in the SOAP body. If the value is false CXF will chose the document-literal unwrapped style If the value is true CXF will chose the document-literal wrapped style | bridgeErrorHandler | consumer | false | boolean | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-cxf/src/main/docs/cxfrs-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cxf/src/main/docs/cxfrs-component.adoc b/components/camel-cxf/src/main/docs/cxfrs-component.adoc index 3e2baf7..ff9085a 100644 --- a/components/camel-cxf/src/main/docs/cxfrs-component.adoc +++ b/components/camel-cxf/src/main/docs/cxfrs-component.adoc @@ -72,14 +72,27 @@ The CXF-RS component supports 2 options which are listed below. // endpoint options: START -The CXF-RS component supports 31 endpoint options which are listed below: +The CXF-RS component is configured using the URI syntax with the following path and query parameters: + + cxfrs:beanId:address + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| beanId | | String | To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix. +| address | | String | The service publish address. +|======================================================================= +{% endraw %} + +#### 29 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| beanId | common | | String | To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix. -| address | common | | String | The service publish address. | features | common | | List | Set the feature list to the CxfRs endpoint. | loggingFeatureEnabled | common | false | boolean | This option enables CXF Logging Feature which writes inbound and outbound REST messages to log. | loggingSizeLimit | common | | int | To limit the total size of number of bytes the logger will output when logging feature has been enabled. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-disruptor/src/main/docs/disruptor-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-disruptor/src/main/docs/disruptor-component.adoc b/components/camel-disruptor/src/main/docs/disruptor-component.adoc index d9ec845..37e8fbf 100644 --- a/components/camel-disruptor/src/main/docs/disruptor-component.adoc +++ b/components/camel-disruptor/src/main/docs/disruptor-component.adoc @@ -118,13 +118,26 @@ The Disruptor component supports 8 options which are listed below. // endpoint options: START -The Disruptor component supports 13 endpoint options which are listed below: +The Disruptor component is configured using the URI syntax with the following path and query parameters: + + disruptor:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Name of queue +|======================================================================= +{% endraw %} + +#### 12 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* Name of queue | size | common | 1024 | int | The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option then its the first endpoint being created with the queue name that determines the size. To make sure all endpoints use same size then configure the size option on all of them or the first endpoint being created. | bridgeErrorHandler | consumer | false | boolean | 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. | concurrentConsumers | consumer | 1 | int | Number of concurrent threads processing exchanges. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-dns/src/main/docs/dns-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dns/src/main/docs/dns-component.adoc b/components/camel-dns/src/main/docs/dns-component.adoc index 2c3a7b3..92a40d8 100644 --- a/components/camel-dns/src/main/docs/dns-component.adoc +++ b/components/camel-dns/src/main/docs/dns-component.adoc @@ -52,13 +52,26 @@ The DNS component has no options. // endpoint options: START -The DNS component supports 2 endpoint options which are listed below: +The DNS component is configured using the URI syntax with the following path and query parameters: + + dns:dnsType + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| dnsType | | DnsType | *Required* The type of the lookup. +|======================================================================= +{% endraw %} + +#### 1 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| dnsType | producer | | DnsType | *Required* The type of the lookup. | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= {% endraw %} http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-docker/src/main/docs/docker-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-docker/src/main/docs/docker-component.adoc b/components/camel-docker/src/main/docs/docker-component.adoc index 6bee91b..b684d7a 100644 --- a/components/camel-docker/src/main/docs/docker-component.adoc +++ b/components/camel-docker/src/main/docs/docker-component.adoc @@ -38,13 +38,26 @@ The Docker component supports 2 options which are listed below. // endpoint options: START -The Docker component supports 20 endpoint options which are listed below: +The Docker component is configured using the URI syntax with the following path and query parameters: + + docker:operation + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| operation | | DockerOperation | *Required* Which operation to use +|======================================================================= +{% endraw %} + +#### 19 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| operation | common | | DockerOperation | *Required* Which operation to use | email | common | | String | Email address associated with the user | host | common | localhost | String | *Required* Docker host | port | common | 2375 | Integer | *Required* Docker port http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-dozer/src/main/docs/dozer-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dozer/src/main/docs/dozer-component.adoc b/components/camel-dozer/src/main/docs/dozer-component.adoc index 2c3fc0c..684b87c 100644 --- a/components/camel-dozer/src/main/docs/dozer-component.adoc +++ b/components/camel-dozer/src/main/docs/dozer-component.adoc @@ -60,13 +60,26 @@ The Dozer component has no options. // component options: END // endpoint options: START -The Dozer component supports 8 endpoint options which are listed below: +The Dozer component is configured using the URI syntax with the following path and query parameters: + + dozer:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* A human readable name of the mapping. +|======================================================================= +{% endraw %} + +#### 7 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | producer | | String | *Required* A human readable name of the mapping. | mappingConfiguration | producer | | DozerBeanMapperConfiguration | The name of a DozerBeanMapperConfiguration bean in the Camel registry which should be used for configuring the Dozer mapping. This is an alternative to the mappingFile option that can be used for fine-grained control over how Dozer is configured. Remember to use a prefix in the value to indicate that the bean is in the Camel registry (e.g. myDozerConfig). | mappingFile | producer | dozerBeanMapping.xml | String | The location of a Dozer configuration file. The file is loaded from the classpath by default but you can use file: classpath: or http: to load the configuration from a specific location. | marshalId | producer | | String | The id of a dataFormat defined within the Camel Context to use for marshalling the mapping output to a non-Java type. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-drill/src/main/docs/drill-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-drill/src/main/docs/drill-component.adoc b/components/camel-drill/src/main/docs/drill-component.adoc index 2ff2557..2d154e6 100644 --- a/components/camel-drill/src/main/docs/drill-component.adoc +++ b/components/camel-drill/src/main/docs/drill-component.adoc @@ -42,13 +42,26 @@ The Drill component has no options. // endpoint options: START -The Drill component supports 6 endpoint options which are listed below: +The Drill component is configured using the URI syntax with the following path and query parameters: + + drill:host + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* ZooKeeper host name or IP address. Use local instead of a host name or IP address to connect to the local Drillbit +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | producer | | String | *Required* ZooKeeper host name or IP address. Use local instead of a host name or IP address to connect to the local Drillbit | clusterId | producer | | String | Cluster ID https://drill.apache.org/docs/using-the-jdbc-driver/determining-the-cluster-id | directory | producer | | String | Drill directory in ZooKeeper | mode | producer | ZK | DrillConnectionMode | Connection mode: zk: Zookeeper drillbit: Drillbit direct connection https://drill.apache.org/docs/using-the-jdbc-driver/ http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-dropbox/src/main/docs/dropbox-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dropbox/src/main/docs/dropbox-component.adoc b/components/camel-dropbox/src/main/docs/dropbox-component.adoc index a99cf3d..718fe56 100644 --- a/components/camel-dropbox/src/main/docs/dropbox-component.adoc +++ b/components/camel-dropbox/src/main/docs/dropbox-component.adoc @@ -69,13 +69,26 @@ The Dropbox component has no options. // component options: END // endpoint options: START -The Dropbox component supports 13 endpoint options which are listed below: +The Dropbox component is configured using the URI syntax with the following path and query parameters: + + dropbox:operation + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| operation | | DropboxOperation | *Required* The specific action (typically is a CRUD action) to perform on Dropbox remote folder. +|======================================================================= +{% endraw %} + +#### 12 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| operation | common | | DropboxOperation | *Required* The specific action (typically is a CRUD action) to perform on Dropbox remote folder. | accessToken | common | | String | *Required* The access token to make API requests for a specific Dropbox user | client | common | | DbxClient | To use an existing DbxClient instance as DropBox client. | clientIdentifier | common | | String | *Required* Name of the app registered to make API requests http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-ehcache/src/main/docs/ehcache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ehcache/src/main/docs/ehcache-component.adoc b/components/camel-ehcache/src/main/docs/ehcache-component.adoc index 97e6353..87ef8f9 100644 --- a/components/camel-ehcache/src/main/docs/ehcache-component.adoc +++ b/components/camel-ehcache/src/main/docs/ehcache-component.adoc @@ -43,13 +43,26 @@ The Ehcache component has no options. // endpoint options: START -The Ehcache component supports 16 endpoint options which are listed below: +The Ehcache component is configured using the URI syntax with the following path and query parameters: + + ehcache:cacheName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| cacheName | | String | *Required* the cache name +|======================================================================= +{% endraw %} + +#### 15 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| cacheName | common | | String | *Required* the cache name | cacheManager | common | | CacheManager | The cache manager | configUri | common | | String | URI pointing to the Ehcache XML configuration file's location | createCacheIfNotExist | common | true | boolean | Configure if a cache need to be created if it does exist or can't be pre-configured. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-ejb/src/main/docs/ejb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ejb/src/main/docs/ejb-component.adoc b/components/camel-ejb/src/main/docs/ejb-component.adoc index 41264dd..30ab342 100644 --- a/components/camel-ejb/src/main/docs/ejb-component.adoc +++ b/components/camel-ejb/src/main/docs/ejb-component.adoc @@ -51,13 +51,26 @@ The EJB component supports 3 options which are listed below. // endpoint options: START -The EJB component supports 6 endpoint options which are listed below: +The EJB component is configured using the URI syntax with the following path and query parameters: + + ejb:beanName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| beanName | | String | *Required* Sets the name of the bean to invoke +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| beanName | producer | | String | *Required* Sets the name of the bean to invoke | method | producer | | String | Sets the name of the method to invoke on the bean | cache | advanced | false | boolean | If enabled Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope. | multiParameterArray | advanced | false | boolean | How to treat the parameters which are passed from the message body.true means the message body should be an array of parameters. Note: This option is used internally by Camel and is not intended for end users to use. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc index 333778d..26121d6 100644 --- a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc +++ b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc @@ -50,13 +50,26 @@ The Elasticsearch component supports 2 options which are listed below. // endpoint options: START -The Elasticsearch component supports 12 endpoint options which are listed below: +The Elasticsearch component is configured using the URI syntax with the following path and query parameters: + + elasticsearch:clusterName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| clusterName | | String | *Required* Name of cluster or use local for local mode +|======================================================================= +{% endraw %} + +#### 11 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| clusterName | producer | | String | *Required* Name of cluster or use local for local mode | clientTransportSniff | producer | true | Boolean | Is the client allowed to sniff the rest of the cluster or not (default true). This setting map to the client.transport.sniff setting. | consistencyLevel | producer | DEFAULT | WriteConsistencyLevel | The write consistency level to use with INDEX and BULK operations (can be any of ONE QUORUM ALL or DEFAULT) | data | producer | | Boolean | Is the node going to be allowed to allocate data (shards) to it or not. This setting map to the node.data setting.
