connectors/camel-azure-eventhubs-kafka-connector/src/generated/resources/camel-azure-eventhubs-source.json

{
	"connector": {
		"class": "org.apache.camel.kafkaconnector.azureeventhubs.CamelAzureeventhubsSourceConnector",
		"artifactId": "camel-azure-eventhubs-kafka-connector",
		"groupId": "org.apache.camel.kafkaconnector",
		"id": "camel-azure-eventhubs-source",
		"type": "source",
		"version": "0.7.2",
		"description": "The azure-eventhubs component that integrates Azure Event Hubs using AMQP protocol. Azure EventHubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream them to multiple consumers."
	},
	"properties": {
		"camel.source.path.namespace": {
			"name": "camel.source.path.namespace",
			"description": "EventHubs namespace created in Azure Portal",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.path.eventHubName": {
			"name": "camel.source.path.eventHubName",
			"description": "EventHubs name under a specific namcespace",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.amqpRetryOptions": {
			"name": "camel.source.endpoint.amqpRetryOptions",
			"description": "Sets the retry policy for EventHubAsyncClient. If not specified, the default retry options are used.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.amqpTransportType": {
			"name": "camel.source.endpoint.amqpTransportType",
			"description": "Sets the transport type by which all the communication with Azure Event Hubs occurs. Default value is AmqpTransportType#AMQP. One of: [Amqp] [AmqpWebSockets]",
			"defaultValue": "\"AMQP\"",
			"priority": "MEDIUM",
			"required": "false",
			"enum": [
				"Amqp",
				"AmqpWebSockets"
			]
		},
		"camel.source.endpoint.autoDiscoverClient": {
			"name": "camel.source.endpoint.autoDiscoverClient",
			"description": "Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.",
			"defaultValue": "true",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.blobAccessKey": {
			"name": "camel.source.endpoint.blobAccessKey",
			"description": "In case you chose the default BlobCheckpointStore, this sets access key for the associated azure account name to be used for authentication with azure blob services",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.blobAccountName": {
			"name": "camel.source.endpoint.blobAccountName",
			"description": "In case you chose the default BlobCheckpointStore, this sets Azure account name to be used for authentication with azure blob services.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.blobContainerName": {
			"name": "camel.source.endpoint.blobContainerName",
			"description": "In case you chose the default BlobCheckpointStore, this sets the blob container that shall be used by the BlobCheckpointStore to store the checkpoint offsets",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.blobStorageSharedKeyCredential": {
			"name": "camel.source.endpoint.blobStorageSharedKeyCredential",
			"description": "In case you chose the default BlobCheckpointStore, StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.bridgeErrorHandler": {
			"name": "camel.source.endpoint.bridgeErrorHandler",
			"description": "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.",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.checkpointStore": {
			"name": "camel.source.endpoint.checkpointStore",
			"description": "Sets the CheckpointStore the EventProcessorClient will use for storing partition ownership and checkpoint information. Users can, optionally, provide their own implementation of CheckpointStore which will store ownership and checkpoint information. By default it set to use com.azure.messaging.eventhubs.checkpointstore.blob.BlobCheckpointStore which stores all checkpoint offsets into Azure Blob Storage",
			"defaultValue": "\"BlobCheckpointStore\"",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.consumerGroupName": {
			"name": "camel.source.endpoint.consumerGroupName",
			"description": "Sets the name of the consumer group this consumer is associated with. Events are read in the context of this group. The name of the consumer group that is created by default is {link #DEFAULT_CONSUMER_GROUP_NAME $Default}.",
			"defaultValue": "\"$Default\"",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.eventPosition": {
			"name": "camel.source.endpoint.eventPosition",
			"description": "Sets the map containing the event position to use for each partition if a checkpoint for the partition does not exist in CheckpointStore. This map is keyed off of the partition id. If there is no checkpoint in CheckpointStore and there is no entry in this map, the processing of the partition will start from {link EventPosition#latest() latest} position.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.prefetchCount": {
			"name": "camel.source.endpoint.prefetchCount",
			"description": "Sets the count used by the receiver to control the number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receive operation is currently active.",
			"defaultValue": "500",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.exceptionHandler": {
			"name": "camel.source.endpoint.exceptionHandler",
			"description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.exchangePattern": {
			"name": "camel.source.endpoint.exchangePattern",
			"description": "Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]",
			"priority": "MEDIUM",
			"required": "false",
			"enum": [
				"InOnly",
				"InOut",
				"InOptionalOut"
			]
		},
		"camel.source.endpoint.synchronous": {
			"name": "camel.source.endpoint.synchronous",
			"description": "Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.connectionString": {
			"name": "camel.source.endpoint.connectionString",
			"description": "Instead of supplying namespace, sharedAccessKey, sharedAccessName ... etc, you can just supply the connection string for your eventHub. The connection string for EventHubs already include all the necessary information to connection to your EventHub. To learn on how to generate the connection string, take a look at this documentation: https:\/\/docs.microsoft.com\/en-us\/azure\/event-hubs\/event-hubs-get-connection-string",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.sharedAccessKey": {
			"name": "camel.source.endpoint.sharedAccessKey",
			"description": "The generated value for the SharedAccessName",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.source.endpoint.sharedAccessName": {
			"name": "camel.source.endpoint.sharedAccessName",
			"description": "The name you chose for your EventHubs SAS keys",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.amqpRetryOptions": {
			"name": "camel.component.azure-eventhubs.amqpRetryOptions",
			"description": "Sets the retry policy for EventHubAsyncClient. If not specified, the default retry options are used.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.amqpTransportType": {
			"name": "camel.component.azure-eventhubs.amqpTransportType",
			"description": "Sets the transport type by which all the communication with Azure Event Hubs occurs. Default value is AmqpTransportType#AMQP. One of: [Amqp] [AmqpWebSockets]",
			"defaultValue": "\"AMQP\"",
			"priority": "MEDIUM",
			"required": "false",
			"enum": [
				"Amqp",
				"AmqpWebSockets"
			]
		},
		"camel.component.azure-eventhubs.autoDiscoverClient": {
			"name": "camel.component.azure-eventhubs.autoDiscoverClient",
			"description": "Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.",
			"defaultValue": "true",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.configuration": {
			"name": "camel.component.azure-eventhubs.configuration",
			"description": "The component configurations",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.blobAccessKey": {
			"name": "camel.component.azure-eventhubs.blobAccessKey",
			"description": "In case you chose the default BlobCheckpointStore, this sets access key for the associated azure account name to be used for authentication with azure blob services",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.blobAccountName": {
			"name": "camel.component.azure-eventhubs.blobAccountName",
			"description": "In case you chose the default BlobCheckpointStore, this sets Azure account name to be used for authentication with azure blob services.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.blobContainerName": {
			"name": "camel.component.azure-eventhubs.blobContainerName",
			"description": "In case you chose the default BlobCheckpointStore, this sets the blob container that shall be used by the BlobCheckpointStore to store the checkpoint offsets",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.blobStorageSharedKeyCredential": {
			"name": "camel.component.azure-eventhubs.blobStorageSharedKeyCredential",
			"description": "In case you chose the default BlobCheckpointStore, StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.bridgeErrorHandler": {
			"name": "camel.component.azure-eventhubs.bridgeErrorHandler",
			"description": "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.",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.checkpointStore": {
			"name": "camel.component.azure-eventhubs.checkpointStore",
			"description": "Sets the CheckpointStore the EventProcessorClient will use for storing partition ownership and checkpoint information. Users can, optionally, provide their own implementation of CheckpointStore which will store ownership and checkpoint information. By default it set to use com.azure.messaging.eventhubs.checkpointstore.blob.BlobCheckpointStore which stores all checkpoint offsets into Azure Blob Storage",
			"defaultValue": "\"BlobCheckpointStore\"",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.consumerGroupName": {
			"name": "camel.component.azure-eventhubs.consumerGroupName",
			"description": "Sets the name of the consumer group this consumer is associated with. Events are read in the context of this group. The name of the consumer group that is created by default is {link #DEFAULT_CONSUMER_GROUP_NAME $Default}.",
			"defaultValue": "\"$Default\"",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.eventPosition": {
			"name": "camel.component.azure-eventhubs.eventPosition",
			"description": "Sets the map containing the event position to use for each partition if a checkpoint for the partition does not exist in CheckpointStore. This map is keyed off of the partition id. If there is no checkpoint in CheckpointStore and there is no entry in this map, the processing of the partition will start from {link EventPosition#latest() latest} position.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.prefetchCount": {
			"name": "camel.component.azure-eventhubs.prefetchCount",
			"description": "Sets the count used by the receiver to control the number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receive operation is currently active.",
			"defaultValue": "500",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.autowiredEnabled": {
			"name": "camel.component.azure-eventhubs.autowiredEnabled",
			"description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.",
			"defaultValue": "true",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.connectionString": {
			"name": "camel.component.azure-eventhubs.connectionString",
			"description": "Instead of supplying namespace, sharedAccessKey, sharedAccessName ... etc, you can just supply the connection string for your eventHub. The connection string for EventHubs already include all the necessary information to connection to your EventHub. To learn on how to generate the connection string, take a look at this documentation: https:\/\/docs.microsoft.com\/en-us\/azure\/event-hubs\/event-hubs-get-connection-string",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.sharedAccessKey": {
			"name": "camel.component.azure-eventhubs.sharedAccessKey",
			"description": "The generated value for the SharedAccessName",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.azure-eventhubs.sharedAccessName": {
			"name": "camel.component.azure-eventhubs.sharedAccessName",
			"description": "The name you chose for your EventHubs SAS keys",
			"priority": "MEDIUM",
			"required": "false"
		}
	}
}