This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
commit ebd25fddcc156582815e3b30027ee03454a5cadb Author: MelissaFlinn <[email protected]> AuthorDate: Mon Jul 11 10:18:20 2022 -0400 doc-config-descriptions-edit azure --- kamelets/azure-eventhubs-sink.kamelet.yaml | 18 ++++++++---------- kamelets/azure-eventhubs-source.kamelet.yaml | 16 ++++++++-------- .../azure-storage-blob-changefeed-source.kamelet.yaml | 4 ++-- kamelets/azure-storage-blob-sink.kamelet.yaml | 8 ++------ kamelets/azure-storage-blob-source.kamelet.yaml | 6 +++--- kamelets/azure-storage-queue-sink.kamelet.yaml | 13 +++++-------- kamelets/azure-storage-queue-source.kamelet.yaml | 6 +++--- 7 files changed, 31 insertions(+), 40 deletions(-) diff --git a/kamelets/azure-eventhubs-sink.kamelet.yaml b/kamelets/azure-eventhubs-sink.kamelet.yaml index f64a5123..3ba7422a 100644 --- a/kamelets/azure-eventhubs-sink.kamelet.yaml +++ b/kamelets/azure-eventhubs-sink.kamelet.yaml @@ -31,13 +31,11 @@ spec: definition: title: "Azure Eventhubs Sink" description: |- - Send Events to Azure Eventhubs. + Send events to Azure Event Hubs. - The Kamelet is able to understand the following headers to be set: - - - `partition` / `ce-partition`: as the time to live of the message in the queue. - - If the header won't be set then the partition will be assigned by Eventhubs + The Kamelet checks for the `partition` / `ce-partition` header to determine how long an event remains in the Azure Storage queue. Use `PnDTnHnMn.nS.` format. For example, `PT20.345S` parses as 20.345 seconds and `P2D` parses as 2 days. + + A header is optional. If the header is not set, the partition is assigned by Event Hubs. required: - namespaceName - eventhubName @@ -47,21 +45,21 @@ spec: properties: namespaceName: title: Eventhubs Namespace - description: The eventhubs namespace + description: The Event Hubs namespace. type: string eventhubName: title: Eventhubs Name - description: The eventhub name + description: The Event Hub name type: string sharedAccessName: title: Share Access Name - description: EventHubs SAS key name + description: The Event Hubs SAS key name. type: string x-descriptors: - urn:camel:group:credentials sharedAccessKey: title: Share Access Key - description: The key for EventHubs SAS key name + description: The key for the Event Hubs SAS key name. type: string format: password x-descriptors: diff --git a/kamelets/azure-eventhubs-source.kamelet.yaml b/kamelets/azure-eventhubs-source.kamelet.yaml index 13ff4c4e..951046b2 100644 --- a/kamelets/azure-eventhubs-source.kamelet.yaml +++ b/kamelets/azure-eventhubs-source.kamelet.yaml @@ -31,7 +31,7 @@ spec: definition: title: "Azure Eventhubs Source" description: |- - Receive events from Azure Eventhubs. + Receive events from Azure Event Hubs. required: - namespaceName - eventhubName @@ -44,21 +44,21 @@ spec: properties: namespaceName: title: Eventhubs Namespace - description: The eventhubs namespace + description: The Event Hubs namespace. type: string eventhubName: title: Eventhubs Name - description: The eventhub name + description: The Event Hub name. type: string sharedAccessName: title: Share Access Name - description: EventHubs SAS key name + description: The Event Hubs SAS key name. type: string x-descriptors: - urn:camel:group:credentials sharedAccessKey: title: Share Access Key - description: The key for EventHubs SAS key name + description: The key for the Event Hubs SAS key name. type: string format: password x-descriptors: @@ -66,15 +66,15 @@ spec: - urn:camel:group:credentials blobAccountName: title: Azure Storage Blob Account Name - description: The name of the storage blob account to be use + description: The name of the Storage Blob account. type: string blobContainerName: title: Azure Storage Blob Container Name - description: The name of the storage blob container to be use + description: The name of the Storage Blob container. type: string blobAccessKey: title: Azure Storage Blob Access Key - description: The key for Azure Storage Blob service associated with the Blob account name + description: The key for the Azure Storage Blob service that is associated with the Storage Blob account name. type: string format: password x-descriptors: diff --git a/kamelets/azure-storage-blob-changefeed-source.kamelet.yaml b/kamelets/azure-storage-blob-changefeed-source.kamelet.yaml index 17e2bf9d..5dcf1d51 100644 --- a/kamelets/azure-storage-blob-changefeed-source.kamelet.yaml +++ b/kamelets/azure-storage-blob-changefeed-source.kamelet.yaml @@ -31,7 +31,7 @@ spec: definition: title: "Azure Storage Blob Changefeed Source" description: |- - Consume Events from Azure Storage Blob Change feed. + Consume events from an Azure Storage Blob change feed. required: - period - accountName @@ -40,7 +40,7 @@ spec: properties: period: title: Period between Polls - description: The interval between fetches to the Azure Storage Changefeed in milliseconds + description: The interval (in milliseconds) between fetches to the Azure Storage change feed. type: integer default: 10000 accountName: diff --git a/kamelets/azure-storage-blob-sink.kamelet.yaml b/kamelets/azure-storage-blob-sink.kamelet.yaml index 9421ab83..85df8d21 100644 --- a/kamelets/azure-storage-blob-sink.kamelet.yaml +++ b/kamelets/azure-storage-blob-sink.kamelet.yaml @@ -33,11 +33,7 @@ spec: description: |- Upload data to Azure Storage Blob. - The Kamelet expects the following headers to be set: - - - `file` / `ce-file`: as the file name to upload - - If the header won't be set the exchange ID will be used as file name. + The Kamelet expects the `file` / `ce-file` header to specify the file name to upload. If the header is not set, then the Kamelet uses the exchange ID as file name. required: - accountName - containerName @@ -56,7 +52,7 @@ spec: type: string accessKey: title: Access Key - description: The Azure Storage Blob access Key. + description: The Azure Storage Blob access key. type: string format: password x-descriptors: diff --git a/kamelets/azure-storage-blob-source.kamelet.yaml b/kamelets/azure-storage-blob-source.kamelet.yaml index 9c4717e2..8fcf7789 100644 --- a/kamelets/azure-storage-blob-source.kamelet.yaml +++ b/kamelets/azure-storage-blob-source.kamelet.yaml @@ -31,7 +31,7 @@ spec: definition: title: "Azure Storage Blob Source" description: |- - Consume Files from Azure Storage Blob. + Consume files from Azure Storage Blob. required: - period - accountName @@ -41,7 +41,7 @@ spec: properties: period: title: Period between Polls - description: The interval between fetches to the Azure Storage Container in milliseconds + description: The interval (in milliseconds) between fetches to the Azure Storage Container. type: integer default: 10000 accountName: @@ -56,7 +56,7 @@ spec: type: string accessKey: title: Access Key - description: The Azure Storage Blob access Key. + description: The Azure Storage Blob access key. type: string format: password x-descriptors: diff --git a/kamelets/azure-storage-queue-sink.kamelet.yaml b/kamelets/azure-storage-queue-sink.kamelet.yaml index 4dcb5b9e..c309fd79 100644 --- a/kamelets/azure-storage-queue-sink.kamelet.yaml +++ b/kamelets/azure-storage-queue-sink.kamelet.yaml @@ -31,15 +31,12 @@ spec: definition: title: "Azure Storage Queue Sink" description: |- - Send Messages to Azure Storage queues. + Send events to Azure Storage queues. - The Kamelet is able to understand the following headers to be set: + The Kamelet checks for the `partition` / `ce-partition` header to determine how long an event remains in the Azure Storage queue. + Use `PnDTnHnMn.nS.` format. For example, `PT20.345S` parses as 20.345 seconds and `P2D` parses as 2 days. - - `expiration` / `ce-expiration`: as the time to live of the message in the queue. - - If the header won't be set the default of 7 days will be used. - - The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S — parses as 20.345 seconds, P2D — parses as 2 days. + A header is optional. If the header is not set, the default of `P27D` (7 days) is used. required: - accountName - queueName @@ -58,7 +55,7 @@ spec: type: string accessKey: title: Access Key - description: The Azure Storage Queue access Key. + description: The Azure Storage Queue access key. type: string format: password x-descriptors: diff --git a/kamelets/azure-storage-queue-source.kamelet.yaml b/kamelets/azure-storage-queue-source.kamelet.yaml index 2b3bbb72..40a4bf6c 100644 --- a/kamelets/azure-storage-queue-source.kamelet.yaml +++ b/kamelets/azure-storage-queue-source.kamelet.yaml @@ -31,7 +31,7 @@ spec: definition: title: "Azure Storage Queue Source" description: |- - Receive Messages from Azure Storage queues. + Receive events from Azure Storage queues. required: - accountName - queueName @@ -50,7 +50,7 @@ spec: type: string accessKey: title: Access Key - description: The Azure Storage Queue access Key. + description: The Azure Storage Queue access key. type: string format: password x-descriptors: @@ -58,7 +58,7 @@ spec: - urn:camel:group:credentials maxMessages: title: Maximum Messages - description: Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. By default it will consider 1 message to be retrieved, the allowed range is 1 to 32 messages. + description: The maximum number of messages to get. You can specify a value between 1 and 32. The default is 1 (one message). If there are fewer than the maximum number of messages in the queue, then all the messages are returned. type: integer default: 1 dependencies:
