This is an automated email from the ASF dual-hosted git repository. nfilotto pushed a commit to branch CAMEL-17792/doc-message-headers in repository https://gitbox.apache.org/repos/asf/camel.git
commit 4f4c001f7fb9df2ed38a752e972bbf04486d16c0 Author: Nicolas Filotto <[email protected]> AuthorDate: Wed Mar 16 19:32:28 2022 +0100 CAMEL-17792: Add doc about the message headers of camel-azure-storage-datalake --- .../storage/datalake/azure-storage-datalake.json | 63 +++++++++++ .../docs/azure-storage-datalake-component.adoc | 80 +------------ .../azure/storage/datalake/DataLakeConstants.java | 124 +++++++++++++++++++++ .../azure/storage/datalake/DataLakeEndpoint.java | 2 +- 4 files changed, 192 insertions(+), 77 deletions(-) diff --git a/components/camel-azure/camel-azure-storage-datalake/src/generated/resources/org/apache/camel/component/azure/storage/datalake/azure-storage-datalake.json b/components/camel-azure/camel-azure-storage-datalake/src/generated/resources/org/apache/camel/component/azure/storage/datalake/azure-storage-datalake.json index b960f95..51d6eca 100644 --- a/components/camel-azure/camel-azure-storage-datalake/src/generated/resources/org/apache/camel/component/azure/storage/datalake/azure-storage-datalake.json +++ b/components/camel-azure/camel-azure-storage-datalake/src/generated/resources/org/apache/camel/component/azure/storage/datalake/azure-storage-datalake.json @@ -56,6 +56,69 @@ "operation": { "kind": "property", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "org.apache.camel.component.azure.storage.datalake.DataLakeOperationsDefinition", "enum": [ "listFileSystem", "listFiles" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "listFileSystem", "configurationClass": "org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration", "configurationField" [...] "autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "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 t [...] }, + "headers": { + "CamelAzureStorageDataLakeListFileSystemsOptions": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "ListFileSystemsOptions", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Defines options available to configure the behavior of a call to listFileSystemsSegment on a DataLakeServiceAsyncClient object. Null may be passed." }, + "CamelAzureStorageDataLakeTimeout": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Duration", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "An optional timeout value beyond which a RuntimeException will be raised." }, + "CamelAzureStorageDataLakeOperation": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "org.apache.camel.component.azure.storage.datalake.DataLakeOperationsDefinition", "enum": [ "listFileSystem", "createFileSystem", "deleteFileSystem", "listPaths", "getFile", "downloadToFile", "downloadLink", "deleteFile", "appendToFile", "flushToFile", "uploadFromFile", "upload", "openQueryInputStream", "createFile", "deleteDirectory" [...] + "CamelAzureStorageDataLakeFileSystemName": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Name of the file system in azure datalake on which operation is to be performed. Please make sure that filesystem name is all lowercase." }, + "CamelAzureStorageDataLakeDirectoryName": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Name of the directory in azure datalake on which operation is to be performed." }, + "CamelAzureStorageDataLakeFileName": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Name of the file in azure datalake on which operation is to be performed." }, + "CamelAzureStorageDataLakeMetadata": { "kind": "header", "displayName": "", "group": "from both", "label": "from both", "required": false, "javaType": "Map<String, String>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The metadata to associate with the file." }, + "CamelAzureStorageDataLakePublicAccessType": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "PublicAccessType", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Defines options available to configure the behavior of a call to listFileSystemsSegment on a DataLakeServiceAsyncClient object." }, + "CamelAzureStorageDataLakeRawHttpHeaders": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "HttpHeaders", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Non parsed http headers that can be used by the user." }, + "CamelAzureStorageDataLakeRequestCondition": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "DataLakeRequestConditions", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "This contains values which will restrict the successful operation of a variety of requests to the conditions present. These conditions are entirely optional." }, + "CamelAzureStorageDataLakeListPathOptions": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "ListPathOptions", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Defines options available to configure the behavior of a call to listContainersSegment on a DataLakeFileSystemClient object. Null may be passed." }, + "CamelAzureStorageDataLakePath": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Path of the file to be used for upload operations." }, + "CamelAzureStorageDataLakeRecursive": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Specifies if the call to listContainersSegment should recursively include all paths." }, + "CamelAzureStorageDataLakeMaxResults": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Specifies the maximum number of blobs to return, including all BlobPrefix elements." }, + "CamelAzureStorageDataLakeUserPrincipalNameReturned": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Specifies if the name of the user principal should be returned." }, + "CamelAzureStorageDataLakeRegex": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Filter the results to return only those files with match the specified regular expression." }, + "CamelAzureStorageDataLakeFileDir": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Directory in which the file is to be downloaded." }, + "CamelAzureStorageDataLakeAccessTier": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "AccessTier", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Access tier of file." }, + "CamelAzureStorageDataLakeContentMD5": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "byte[]", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "An MD5 hash of the content. The hash is used to verify the integrity of the file during transport." }, + "CamelAzureStorageDataLakeFileRange": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "FileRange", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "This is a representation of a range of bytes on a file, typically used during a download operation. Passing null as a FileRange value will default to the entire range of the file." }, + "CamelAzureStorageDataLakeParallelTransferOptions": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "ParallelTransferOptions", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The configuration used to parallelize data transfer operations." }, + "CamelAzureStorageDataLakeOpenOptions": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Set<OpenOption>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Set of OpenOption used to configure how to open or create a file." }, + "CamelAzureStorageDataLakeAccessTierChangeTime": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "OffsetDateTime", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Datetime when the access tier of the blob last changed." }, + "CamelAzureStorageDataLakeArchiveStatus": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "ArchiveStatus", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Archive status of file." }, + "CamelAzureStorageDataLakeCacheControl": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Cache control specified for the file." }, + "CamelAzureStorageDataLakeContentDisposition": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Content disposition specified for the file." }, + "CamelAzureStorageDataLakeContentEncoding": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Content encoding specified for the file." }, + "CamelAzureStorageDataLakeContentLanguage": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Content language specified for the file." }, + "CamelAzureStorageDataLakeContentType": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Content type specified for the file." }, + "CamelAzureStorageDataLakeCopyCompletionTime": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "OffsetDateTime", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Conclusion time of the last attempted Copy Blob operation where this file was the destination file." }, + "CamelAzureStorageDataLakeCopyId": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "String identifier for this copy operation." }, + "CamelAzureStorageDataLakeCopyProgress": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this file was the destination file." }, + "CamelAzureStorageDataLakeCopySource": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file." }, + "CamelAzureStorageDataLakeCopyStatus": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "com.azure.storage.file.datalake.models.CopyStatusType", "enum": [ "pending", "success", "aborted", "failed" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Status of the last copy operation performed on the file." }, + "CamelAzureStorageDataLakeCopyStatusDescription": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The description of the copy's status" }, + "CamelAzureStorageDataLakeCreationTime": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "OffsetDateTime", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Creation time of the file." }, + "CamelAzureStorageDataLakeEncryptionKeySha256": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The SHA-256 hash of the encryption key used to encrypt the file." }, + "CamelAzureStorageDataLakeETag": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The E Tag of the file." }, + "CamelAzureStorageDataLakeFileSize": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "Long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Size of the file." }, + "CamelAzureStorageDataLakeLastModified": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "OffsetDateTime", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Datetime when the file was last modified." }, + "CamelAzureStorageDataLakeLeaseDuration": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "com.azure.storage.file.datalake.models.LeaseDurationType", "enum": [ "infinite", "fixed" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Type of lease on the file." }, + "CamelAzureStorageDataLakeLeaseState": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "com.azure.storage.file.datalake.models.LeaseStateType", "enum": [ "available", "leased", "expired", "breaking", "broken" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "State of the lease on the file." }, + "CamelAzureStorageDataLakeLeaseStatus": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "com.azure.storage.file.datalake.models.LeaseStatusType", "enum": [ "locked", "unlocked" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Status of the lease on the file." }, + "CamelAzureStorageDataLakeIncrementalCopy": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Flag indicating if the file was incrementally copied." }, + "CamelAzureStorageDataLakeServerEncrypted": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Flag indicating if the file's content is encrypted on the server." }, + "CamelAzureStorageDataLakeDownloadLinkExpiration": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Set the Expiration time of the download link." }, + "CamelAzureStorageDataLakeDownloadLink": { "kind": "header", "displayName": "", "group": "from component", "label": "from component", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The link that can be used to download the file from datalake." }, + "CamelAzureStorageDataLakeFileOffset": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The position where the data is to be appended." }, + "CamelAzureStorageDataLakeLeaseId": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "By setting lease id, requests will fail if the provided lease does not match the active lease on the file." }, + "CamelAzureStorageDataLakePathHttpHeaders": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "PathHttpHeaders", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Additional parameters for a set of operations." }, + "CamelAzureStorageDataLakeRetainCommitedData": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Determines Whether or not uncommitted data is to be retained after the operation." }, + "CamelAzureStorageDataLakeClose": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Whether or not a file changed event raised indicates completion (true) or modification (false)." }, + "CamelAzureStorageDataLakePosition": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The length of the file after all data has been written." }, + "CamelAzureStorageDataLakeExpression": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The query expression on the file." }, + "CamelAzureStorageDataLakeInputSerialization": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "FileQuerySerialization", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Defines the input serialization for a file query request. either FileQueryJsonSerialization or FileQueryDelimitedSerialization" }, + "CamelAzureStorageDataLakeOutputSerialization": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "FileQuerySerialization", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Defines the output serialization for a file query request. either FileQueryJsonSerialization or FileQueryDelimitedSerialization" }, + "CamelAzureStorageDataLakeErrorConsumer": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Consumer<FileQueryError>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Sets error consumer for file query" }, + "CamelAzureStorageDataLakeProgressConsumer": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "Consumer<FileQueryProgress>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Sets progress consumer for file query" }, + "CamelAzureStorageDataLakeQueryOptions": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "FileQueryOptions", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Optional parameters for File Query." }, + "CamelAzureStorageDataLakePermission": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Sets the permission for file." }, + "CamelAzureStorageDataLakeUmask": { "kind": "header", "displayName": "", "group": "from user", "label": "from user", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Sets the umask for file." } + }, "properties": { "accountName": { "kind": "path", "displayName": "Account Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration", "configurationField": "configuration", "description": "name of the azure account" }, "fileSystemName": { "kind": "path", "displayName": "File System Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration", "configurationField": "configuration", "description": "name of filesystem to be used" }, diff --git a/components/camel-azure/camel-azure-storage-datalake/src/main/docs/azure-storage-datalake-component.adoc b/components/camel-azure/camel-azure-storage-datalake/src/main/docs/azure-storage-datalake-component.adoc index 0f88b49..fcfc635 100644 --- a/components/camel-azure/camel-azure-storage-datalake/src/main/docs/azure-storage-datalake-component.adoc +++ b/components/camel-azure/camel-azure-storage-datalake/src/main/docs/azure-storage-datalake-component.adoc @@ -79,87 +79,15 @@ from("azure-storage-datalake:camelTesting/filesystem?fileName=test.txt&accountKe to("file://fileDirectory"); ---- -=== Message Headers specified by user - -[width="100%",cols="10%,10%,10%,70%",options="header",] -|=== -|Header |Variable Name |Type |Description -|`CamelAzureStorageDataLakeListFileSystemsOptions` |`DataLakeConstants.LIST_FILESYSTEMS_OPTIONS` | `ListFileSystemsOptions` | Defines options available to configure the behavior of a call to listFileSystemsSegment on a DataLakeServiceAsyncClient object. Null may be passed. -|`CamelAzureStorageDataLakeTimeout` |`DataLakeConstants.TIMEOUT` |`Duration` | An optional timeout value beyond which a RuntimeException will be raised. -|`CamelAzureStorageDataLakeOperation` |`DataLakeConstants.DATALAKE_OPERATION` |`DataLakeOperationsDefinition` | Specify the producer operation to execute. Different operations allowed are shown below. -|`CamelAzureStorageDataLakeFileSystemName` |`DataLakeConstants.FILESYSTEM_NAME` |`String` | Name of the file system in azure datalake on which operation is to be performed. Please make sure that filesystem name is all lowercase. -|`CamelAzureStorageDataLakeDirectoryName` |`DataLakeConstants.DIRECTORY_NAME` |`String` | Name of the directory in azure datalake on which operation is to be performed. -|`CamelAzureStorageDataLakeFileName` |`DataLakeConstants.FILE_NAME` |`String` | Name of the file in azure datalake on which operation is to be performed. -|`CamelAzureStorageDataLakeMetadata` |`DataLakeConstants.METADATA` |`Map<String,String>` | The metadata to associate with the file. -|`CamelAzureStorageDataLakePublicAccessType` |`DataLakeConstants.PUBLIC_ACCESS_TYPE` |`PublicAccessType` | -|`CamelAzureStorageDataLakeRequestCondition` |`DataLakeConstants.DATALAKE_REQUEST_CONDITION` |`DataLakeRequestConditions` | This contains values which will restrict the successful operation of a variety of requests to the conditions present. These conditions are entirely optional. -|`CamelAzureStorageDataLakeListPathOptions` |`DataLakeConstants.LIST_PATH_OPTIONS` |`ListPathOptions` | Defines options available to configure the behavior of a call to listContainersSegment on a DataLakeFileSystemClient object. Null may be passed. -|`CamelAzureStorageDataLakePath` |`DataLakeConstants.PATH` |`String` | Path of the file to be used for upload operations. -|`CamelAzureStorageDataLakeRecursive` |`DataLakeConstants.RECURSIVE` |`Boolean` | Specifies if the call to listContainersSegment should recursively include all paths. -|`CamelAzureStorageDataLakeMaxResults` |`DataLakeConstants.MAX_RESULTS` |`Integer` | Specifies the maximum number of blobs to return, including all BlobPrefix elements. -|`CamelAzureStorageDataLakeUserPrincipalNameReturned` |`DataLakeConstants.USER_PRINCIPAL_NAME_RETURNED` |`Boolean` | -|`CamelAzureStorageDataLakeRegex` |`DataLakeConstants.REGEX` |`String` | Filter the results to return only those files with match the specified regular expression. -|`CamelAzureStorageDataLakeFileDir` |`DataLakeConstants.FILE_DIR` |`String` | Directory in which the file is to be downloaded. -|`CamelAzureStorageDataLakeContentMD5` |`DataLakeConstants.CONTENT_MD5` |`byte[]` | An MD5 hash of the content. The hash is used to verify the intergity of the file during transport. -|`CamelAzureStorageDataLakeFileRange` |`DataLakeConstants.FILE_RANGE` |`FileRange` | This is a representation of a range of bytes on a file, typically used during a download operation. Passing null as a FileRange value will default to the entire range of the file. -|`CamelAzureStorageDataLakeParallelTransferOptions` |`DataLakeConstants.PARALLEL_TRANSFER_OPTIONS` | `ParallelTransferOptions` | -|`CamelAzureStorageDataLakeOpenOptions` |`DataLakeConstants.OPEN_OPTIONS` |`Set<OpenOption>` | Set of OpenOption used to configure how to open or create a file. -|`CamelAzureStorageDataLakeIncrementalCopy` |`DataLakeConstants.INCREMENTAL_COPY` |`Boolean` | Flag indicating if the file was incrementally copied. -|`CamelAzureStorageDataLakeDownloadLinkExpiration` |`DataLakeConstants.DOWNLOAD_LINK_EXPIRATION` |`Long` | Set the Expiration time of the download link. -|`CamelAzureStorageDataLakeFileOffset` |`DataLakeConstants.FILE_OFFSET` |`Long` | The position where the data is to be appended. -|`CamelAzureStorageDataLakeLeaseId` |`DataLakeConstants.LEASE_ID` |`String` | By setting lease id, requests will fail if the provided lease does not match the active lease on the file. -|`CamelAzureStorageDataLakePathHttpHeaders` |`DataLakeConstants.PATH_HTTP_HEADERS` |`PathHttpHeaders` | Additional parameters for a set of operations. -|`CamelAzureStorageDataLakeRetainCommitedData` |`DataLakeConstants.RETAIN_UNCOMMITED_DATA` |`Boolean` | Determines Whether or not uncommitted data is to be retained after the operation. -|`CamelAzureStorageDataLakeClose` |`DataLakeConstants.CLOSE` |`Boolean` | Whether or not a file changed event raised indicates completion (true) or modification (false). -|`CamelAzureStorageDataLakePosition` |`DataLakeConstants.POSITION` |`Long` | The length of the file after all data has been written. -|`CamelAzureStorageDataLakeExpression` |`DataLakeConstants.EXPRESSION` |`String` | The query expression on the file. -|`CamelAzureStorageDataLakeInputSerialization` |`DataLakeConstants.INPUT_SERIALIZATION` |`FileQuerySerialization` | Defines the input serialization for a file query request. either FileQueryJsonSerialization or FileQueryDelimitedSerialization -|`CamelAzureStorageDataLakeOutputSerialization` |`DataLakeConstants.OUTPUT_SERIALIZATION` |`FileQuerySerialization` | Defines the output serialization for a file query request. either FileQueryJsonSerialization or FileQueryDelimitedSerialization -|`CamelAzureStorageDataLakeErrorConsumer` |`DataLakeConstants.ERROR_CONSUMER` |`Consumer<FileQueryError>` | Sets error consumer for file query -|`CamelAzureStorageDataLakeProgressConsumer` |`DataLakeConstants.PROGRESS_CONSUMER` |`Consumer<FileQueryProgress>` | Sets progress consumer for file query -|`CamelAzureStorageDataLakeQueryOptions` |`DataLakeConstants.QUERY_OPTIONS` |`FileQueryOptions` | Optional parameters for File Query. -|`CamelAzureStorageDataLakePermission` |`DataLakeConstants.PERMISSION` |`String` | Sets the permission for file. -|`CamelAzureStorageDataLakeUmask` |`DataLakeConstants.UMASK` |`String` | Sets the umask for file. -|=== - -=== Message headers set by the component - -[width="100%",cols="10%,10%,10%,70%",options="header",] -|=== -|Header |Variable Name |Type |Description -|`CamelAzureStorageDataLakeMetadata` |`DataLakeConstants.METADATA` |`Map<String,String>` | The metadata to associate with the file. -|`CamelAzureStorageDataLakeRawHttpHeaders` |`DataLakeConstants.RAW_HTTP_HEADERS` |`HttpHeaders` | Non parsed http headers that can be used by the user. -|`CamelAzureStorageDataLakeAccessTier` |`DataLakeConstants.ACCESS_TIER` |`AccessTier` | Access tier of file. -|`CamelAzureStorageDataLakeAccessTierChangeTime` |`DataLakeConstants.ACCESS_TIER_CHANGE_TIME` |`OffsetDateTime` | Datetime when the access tier of the blob last changed. -|`CamelAzureStorageDataLakeArchiveStatus` |`DataLakeConstants.ARCHIVE_STATUS` |`ArchiveStatus` | Archive status of file. -|`CamelAzureStorageDataLakeCacheControl` |`DataLakeConstants.CACHE_CONTROL` |`String` | Cache control specified for the file. -|`CamelAzureStorageDataLakeContentDisposition` |`DataLakeConstants.CONTENT_DISPOSITION` |`String` | Content disposition specified for the file. -|`CamelAzureStorageDataLakeContentEncoding` |`DataLakeConstants.CONTENT_ENCODING` |`String` | Content encoding specified for the file. -|`CamelAzureStorageDataLakeContentLanguage` |`DataLakeConstants.CONTENT_LANGUAGE` |`String` | Content language specified for the file. -|`CamelAzureStorageDataLakeContentType` |`DataLakeConstants.CONTENT_TYPE` |`String` | Content type specified for the file. -|`CamelAzureStorageDataLakeCopyCompletionTime` |`DataLakeConstants.COPY_COMPLETION_TIME` |`OffsetDateTime` | Conclusion time of the last attempted Copy Blob operation where this file was the destination file. -|`CamelAzureStorageDataLakeCopyId` |`DataLakeConstants.COPY_ID` |`String` | String identifier for this copy operation. -|`CamelAzureStorageDataLakeCopyProgress` |`DataLakeConstants.COPY_PROGRESS` |`String` | Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this file was the destination file. -|`CamelAzureStorageDataLakeCopySource` |`DataLakeConstants.COPY_SOURCE` |`String` | URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file. -|`CamelAzureStorageDataLakeCopyStatus` |`DataLakeConstants.COPY_STATUS` |`CopyStatusType` | Status of the last copy operation performed on the file. -|`CamelAzureStorageDataLakeCopyStatusDescription` |`DataLakeConstants.COPY_STATUS_DESCRIPTION` |`String` | -|`CamelAzureStorageDataLakeCreationTime` |`DataLakeConstants.CREATION_TIME` |`OffsetDateTime` | Creation time of the file. -|`CamelAzureStorageDataLakeEncryptionKeySha256` |`DataLakeConstants.ENCRYPTION_KEY_SHA_256` |`String` | The SHA-256 hash of the encryption key used to encrypt the file. -|`CamelAzureStorageDataLakeServerEncrypted` |`DataLakeConstants.SERVER_ENCRYPTED` |`Boolean` | Flag indicating if the file's content is encrypted on the server. -|`CamelAzureStorageDataLakeETag` |`DataLakeConstants.E_TAG` |`String` | The E Tag of the file. -|`CamelAzureStorageDataLakeFileSize` |`DataLakeConstants.FILE_SIZE` |`Long` | Size of the file. -|`CamelAzureStorageDataLakeLastModified` |`DataLakeConstants.LAST_MODIFIED` |`OffsetDateTime` | Datetime when the file was last modified. -|`CamelAzureStorageDataLakeLeaseDuration` |`DataLakeConstants.LEASE_DURATION` |`LeaseDurationType` | Type of lease on the file. -|`CamelAzureStorageDataLakeLeaseState` |`DataLakeConstants.LEASE_STATE` |`LeaseStateType` | State of the lease on the file. -|`CamelAzureStorageDataLakeLeaseStatus` |`DataLakeConstants.LEASE_STATUS` |`LeaseStatusType` | Status of the lease on the file. -|`CamelAzureStorageDataLakeDownloadLink` |`DataLakeConstants.DOWNLOAD_LINK` |`String` | The link that can be used to download the file from datalake. -|=== +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END === Automatic detection of service client The component is capable of automatically detecting the presence of a DataLakeServiceClient bean in the registry. Hence, if your registry has only one instance of type DataLakeServiceClient, it will be automatically used as the default client. -You won't have to explicitly define it as an uri paramater. +You won't have to explicitly define it as an uri parameter. === Azure Storage DataLake Producer Operations diff --git a/components/camel-azure/camel-azure-storage-datalake/src/main/java/org/apache/camel/component/azure/storage/datalake/DataLakeConstants.java b/components/camel-azure/camel-azure-storage-datalake/src/main/java/org/apache/camel/component/azure/storage/datalake/DataLakeConstants.java index 31b8cf7..2d29ee6 100644 --- a/components/camel-azure/camel-azure-storage-datalake/src/main/java/org/apache/camel/component/azure/storage/datalake/DataLakeConstants.java +++ b/components/camel-azure/camel-azure-storage-datalake/src/main/java/org/apache/camel/component/azure/storage/datalake/DataLakeConstants.java @@ -16,69 +16,193 @@ */ package org.apache.camel.component.azure.storage.datalake; +import org.apache.camel.spi.Metadata; + public final class DataLakeConstants { private static final String HEADER_PREFIX = "CamelAzureStorageDataLake"; + @Metadata(label = "from user", + description = "Defines options available to configure the behavior of a call to listFileSystemsSegment on a DataLakeServiceAsyncClient object. Null may be passed.", + javaType = "ListFileSystemsOptions") public static final String LIST_FILESYSTEMS_OPTIONS = HEADER_PREFIX + "ListFileSystemsOptions"; + @Metadata(label = "from user", description = "An optional timeout value beyond which a RuntimeException will be raised.", + javaType = "Duration") public static final String TIMEOUT = HEADER_PREFIX + "Timeout"; + @Metadata(label = "from user", + description = "Specify the producer operation to execute. Different operations allowed are shown below.", + javaType = "org.apache.camel.component.azure.storage.datalake.DataLakeOperationsDefinition") public static final String DATALAKE_OPERATION = HEADER_PREFIX + "Operation"; + @Metadata(label = "from user", + description = "Name of the file system in azure datalake on which operation is to be performed. Please make sure that filesystem name is all lowercase.", + javaType = "String") public static final String FILESYSTEM_NAME = HEADER_PREFIX + "FileSystemName"; + @Metadata(label = "from user", + description = "Name of the directory in azure datalake on which operation is to be performed.", + javaType = "String") public static final String DIRECTORY_NAME = HEADER_PREFIX + "DirectoryName"; + @Metadata(label = "from user", description = "Name of the file in azure datalake on which operation is to be performed.", + javaType = "String") public static final String FILE_NAME = HEADER_PREFIX + "FileName"; + @Metadata(label = "from both", description = "The metadata to associate with the file.", + javaType = "Map<String, String>") public static final String METADATA = HEADER_PREFIX + "Metadata"; + @Metadata(label = "from user", + description = "Defines options available to configure the behavior of a call to listFileSystemsSegment on a DataLakeServiceAsyncClient object.", + javaType = "PublicAccessType") public static final String PUBLIC_ACCESS_TYPE = HEADER_PREFIX + "PublicAccessType"; + @Metadata(label = "from component", description = "Non parsed http headers that can be used by the user.", + javaType = "HttpHeaders") public static final String RAW_HTTP_HEADERS = HEADER_PREFIX + "RawHttpHeaders"; + @Metadata(label = "from user", + description = "This contains values which will restrict the successful operation of a variety of requests to the conditions present. These conditions are entirely optional.", + javaType = "DataLakeRequestConditions") public static final String DATALAKE_REQUEST_CONDITION = HEADER_PREFIX + "RequestCondition"; + @Metadata(label = "from user", + description = "Defines options available to configure the behavior of a call to listContainersSegment on a DataLakeFileSystemClient object. Null may be passed.", + javaType = "ListPathOptions") public static final String LIST_PATH_OPTIONS = HEADER_PREFIX + "ListPathOptions"; + @Metadata(label = "from user", description = "Path of the file to be used for upload operations.", javaType = "String") public static final String PATH = HEADER_PREFIX + "Path"; + @Metadata(label = "from user", + description = "Specifies if the call to listContainersSegment should recursively include all paths.", + javaType = "Boolean") public static final String RECURSIVE = HEADER_PREFIX + "Recursive"; + @Metadata(label = "from user", + description = "Specifies the maximum number of blobs to return, including all BlobPrefix elements.", + javaType = "Integer") public static final String MAX_RESULTS = HEADER_PREFIX + "MaxResults"; + @Metadata(label = "from user", description = "Specifies if the name of the user principal should be returned.", + javaType = "Boolean") public static final String USER_PRINCIPAL_NAME_RETURNED = HEADER_PREFIX + "UserPrincipalNameReturned"; + @Metadata(label = "from user", + description = "Filter the results to return only those files with match the specified regular expression.", + javaType = "String") public static final String REGEX = HEADER_PREFIX + "Regex"; + @Metadata(label = "from user", description = "Directory in which the file is to be downloaded.", javaType = "String") public static final String FILE_DIR = HEADER_PREFIX + "FileDir"; + @Metadata(label = "from component", description = "Access tier of file.", javaType = "AccessTier") public static final String ACCESS_TIER = HEADER_PREFIX + "AccessTier"; + @Metadata(label = "from user", + description = "An MD5 hash of the content. The hash is used to verify the integrity of the file during transport.", + javaType = "byte[]") public static final String CONTENT_MD5 = HEADER_PREFIX + "ContentMD5"; + @Metadata(label = "from user", + description = "This is a representation of a range of bytes on a file, typically used during a download operation. " + + + "Passing null as a FileRange value will default to the entire range of the file.", + javaType = "FileRange") public static final String FILE_RANGE = HEADER_PREFIX + "FileRange"; + @Metadata(label = "from user", description = "The configuration used to parallelize data transfer operations.", + javaType = "ParallelTransferOptions") public static final String PARALLEL_TRANSFER_OPTIONS = HEADER_PREFIX + "ParallelTransferOptions"; + @Metadata(label = "from user", description = "Set of OpenOption used to configure how to open or create a file.", + javaType = "Set<OpenOption>") public static final String OPEN_OPTIONS = HEADER_PREFIX + "OpenOptions"; + @Metadata(label = "from component", description = "Datetime when the access tier of the blob last changed.", + javaType = "OffsetDateTime") public static final String ACCESS_TIER_CHANGE_TIME = HEADER_PREFIX + "AccessTierChangeTime"; + @Metadata(label = "from component", description = "Archive status of file.", javaType = "ArchiveStatus") public static final String ARCHIVE_STATUS = HEADER_PREFIX + "ArchiveStatus"; + @Metadata(label = "from component", description = "Cache control specified for the file.", javaType = "String") public static final String CACHE_CONTROL = HEADER_PREFIX + "CacheControl"; + @Metadata(label = "from component", description = "Content disposition specified for the file.", javaType = "String") public static final String CONTENT_DISPOSITION = HEADER_PREFIX + "ContentDisposition"; + @Metadata(label = "from component", description = "Content encoding specified for the file.", javaType = "String") public static final String CONTENT_ENCODING = HEADER_PREFIX + "ContentEncoding"; + @Metadata(label = "from component", description = "Content language specified for the file.", javaType = "String") public static final String CONTENT_LANGUAGE = HEADER_PREFIX + "ContentLanguage"; + @Metadata(label = "from component", description = "Content type specified for the file.", javaType = "String") public static final String CONTENT_TYPE = HEADER_PREFIX + "ContentType"; + @Metadata(label = "from component", + description = "Conclusion time of the last attempted Copy Blob operation where this file was the destination file.", + javaType = "OffsetDateTime") public static final String COPY_COMPLETION_TIME = HEADER_PREFIX + "CopyCompletionTime"; + @Metadata(label = "from component", description = "String identifier for this copy operation.", javaType = "String") public static final String COPY_ID = HEADER_PREFIX + "CopyId"; + @Metadata(label = "from component", + description = "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this file was the destination file.", + javaType = "String") public static final String COPY_PROGRESS = HEADER_PREFIX + "CopyProgress"; + @Metadata(label = "from component", + description = "URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file.", + javaType = "String") public static final String COPY_SOURCE = HEADER_PREFIX + "CopySource"; + @Metadata(label = "from component", description = "Status of the last copy operation performed on the file.", + javaType = "com.azure.storage.file.datalake.models.CopyStatusType") public static final String COPY_STATUS = HEADER_PREFIX + "CopyStatus"; + @Metadata(label = "from component", description = "The description of the copy's status", javaType = "String") public static final String COPY_STATUS_DESCRIPTION = HEADER_PREFIX + "CopyStatusDescription"; + @Metadata(label = "from component", description = "Creation time of the file.", javaType = "OffsetDateTime") public static final String CREATION_TIME = HEADER_PREFIX + "CreationTime"; + @Metadata(label = "from component", description = "The SHA-256 hash of the encryption key used to encrypt the file.", + javaType = "String") public static final String ENCRYPTION_KEY_SHA_256 = HEADER_PREFIX + "EncryptionKeySha256"; + @Metadata(label = "from component", description = "The E Tag of the file.", javaType = "String") public static final String E_TAG = HEADER_PREFIX + "ETag"; + @Metadata(label = "from component", description = "Size of the file.", javaType = "Long") public static final String FILE_SIZE = HEADER_PREFIX + "FileSize"; + @Metadata(label = "from component", description = "Datetime when the file was last modified.", + javaType = "OffsetDateTime") public static final String LAST_MODIFIED = HEADER_PREFIX + "LastModified"; + @Metadata(label = "from component", description = "Type of lease on the file.", + javaType = "com.azure.storage.file.datalake.models.LeaseDurationType") public static final String LEASE_DURATION = HEADER_PREFIX + "LeaseDuration"; + @Metadata(label = "from component", description = "State of the lease on the file.", + javaType = "com.azure.storage.file.datalake.models.LeaseStateType") public static final String LEASE_STATE = HEADER_PREFIX + "LeaseState"; + @Metadata(label = "from component", description = "Status of the lease on the file.", + javaType = "com.azure.storage.file.datalake.models.LeaseStatusType") public static final String LEASE_STATUS = HEADER_PREFIX + "LeaseStatus"; + @Metadata(label = "from user", description = "Flag indicating if the file was incrementally copied.", + javaType = "Boolean") public static final String INCREMENTAL_COPY = HEADER_PREFIX + "IncrementalCopy"; + @Metadata(label = "from component", description = "Flag indicating if the file's content is encrypted on the server.", + javaType = "Boolean") public static final String SERVER_ENCRYPTED = HEADER_PREFIX + "ServerEncrypted"; + @Metadata(label = "from user", description = "Set the Expiration time of the download link.", javaType = "Long") public static final String DOWNLOAD_LINK_EXPIRATION = HEADER_PREFIX + "DownloadLinkExpiration"; + @Metadata(label = "from component", description = "The link that can be used to download the file from datalake.", + javaType = "String") public static final String DOWNLOAD_LINK = HEADER_PREFIX + "DownloadLink"; + @Metadata(label = "from user", description = "The position where the data is to be appended.", javaType = "Long") public static final String FILE_OFFSET = HEADER_PREFIX + "FileOffset"; + @Metadata(label = "from user", + description = "By setting lease id, requests will fail if the provided lease does not match the active lease on the file.", + javaType = "String") public static final String LEASE_ID = HEADER_PREFIX + "LeaseId"; + @Metadata(label = "from user", description = "Additional parameters for a set of operations.", + javaType = "PathHttpHeaders") public static final String PATH_HTTP_HEADERS = HEADER_PREFIX + "PathHttpHeaders"; + @Metadata(label = "from user", + description = "Determines Whether or not uncommitted data is to be retained after the operation.", + javaType = "Boolean") public static final String RETAIN_UNCOMMITED_DATA = HEADER_PREFIX + "RetainCommitedData"; + @Metadata(label = "from user", + description = "Whether or not a file changed event raised indicates completion (true) or modification (false).", + javaType = "Boolean") public static final String CLOSE = HEADER_PREFIX + "Close"; + @Metadata(label = "from user", description = "The length of the file after all data has been written.", javaType = "Long") public static final String POSITION = HEADER_PREFIX + "Position"; + @Metadata(label = "from user", description = "The query expression on the file.", javaType = "String") public static final String EXPRESSION = HEADER_PREFIX + "Expression"; + @Metadata(label = "from user", + description = "Defines the input serialization for a file query request. either FileQueryJsonSerialization or FileQueryDelimitedSerialization", + javaType = "FileQuerySerialization") public static final String INPUT_SERIALIZATION = HEADER_PREFIX + "InputSerialization"; + @Metadata(label = "from user", + description = "Defines the output serialization for a file query request. either FileQueryJsonSerialization or FileQueryDelimitedSerialization", + javaType = "FileQuerySerialization") public static final String OUTPUT_SERIALIZATION = HEADER_PREFIX + "OutputSerialization"; + @Metadata(label = "from user", description = "Sets error consumer for file query", javaType = "Consumer<FileQueryError>") public static final String ERROR_CONSUMER = HEADER_PREFIX + "ErrorConsumer"; + @Metadata(label = "from user", description = "Sets progress consumer for file query", + javaType = "Consumer<FileQueryProgress>") public static final String PROGRESS_CONSUMER = HEADER_PREFIX + "ProgressConsumer"; + @Metadata(label = "from user", description = "Optional parameters for File Query.", javaType = "FileQueryOptions") public static final String QUERY_OPTIONS = HEADER_PREFIX + "QueryOptions"; + @Metadata(label = "from user", description = "Sets the permission for file.", javaType = "String") public static final String PERMISSION = HEADER_PREFIX + "Permission"; + @Metadata(label = "from user", description = "Sets the umask for file.", javaType = "String") public static final String UMASK = HEADER_PREFIX + "Umask"; private DataLakeConstants() { diff --git a/components/camel-azure/camel-azure-storage-datalake/src/main/java/org/apache/camel/component/azure/storage/datalake/DataLakeEndpoint.java b/components/camel-azure/camel-azure-storage-datalake/src/main/java/org/apache/camel/component/azure/storage/datalake/DataLakeEndpoint.java index 5c22fdc..da2cc05 100644 --- a/components/camel-azure/camel-azure-storage-datalake/src/main/java/org/apache/camel/component/azure/storage/datalake/DataLakeEndpoint.java +++ b/components/camel-azure/camel-azure-storage-datalake/src/main/java/org/apache/camel/component/azure/storage/datalake/DataLakeEndpoint.java @@ -35,7 +35,7 @@ import org.apache.camel.support.ScheduledPollEndpoint; */ @UriEndpoint(firstVersion = "3.8.0", scheme = "azure-storage-datalake", title = "Azure Storage Datalake Service", syntax = "azure-storage-datalake:accountName/fileSystemName", - category = { Category.CLOUD, Category.FILE, Category.BIGDATA }) + category = { Category.CLOUD, Category.FILE, Category.BIGDATA }, headersClass = DataLakeConstants.class) public class DataLakeEndpoint extends ScheduledPollEndpoint { @UriParam(description = "service client of datalake")
