Class DataLakeEndpointBuilderFactory.DataLakeHeaderNameBuilder

java.lang.Object
org.apache.camel.builder.endpoint.dsl.DataLakeEndpointBuilderFactory.DataLakeHeaderNameBuilder
Enclosing interface:
DataLakeEndpointBuilderFactory

public static class DataLakeEndpointBuilderFactory.DataLakeHeaderNameBuilder extends Object
The builder of headers' name for the Azure Storage Datalake Service component.
  • Constructor Details

    • DataLakeHeaderNameBuilder

      public DataLakeHeaderNameBuilder()
  • Method Details

    • azureStorageDataLakeListFileSystemsOptions

      public String azureStorageDataLakeListFileSystemsOptions()
      Defines options available to configure the behavior of a call to listFileSystemsSegment on a DataLakeServiceAsyncClient object. Null may be passed. The option is a: ListFileSystemsOptions type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeListFileSystemsOptions.
    • azureStorageDataLakeTimeout

      public String azureStorageDataLakeTimeout()
      An optional timeout value beyond which a RuntimeException will be raised. The option is a: Duration type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeTimeout.
    • azureStorageDataLakeOperation

      public String azureStorageDataLakeOperation()
      Specify the producer operation to execute. Different operations allowed are shown below. The option is a: org.apache.camel.component.azure.storage.datalake.DataLakeOperationsDefinition type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeOperation.
    • azureStorageDataLakeFileSystemName

      public String azureStorageDataLakeFileSystemName()
      Name of the file system in azure datalake on which operation is to be performed. Please make sure that filesystem name is all lowercase. The option is a: String type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeFileSystemName.
    • azureStorageDataLakeDirectoryName

      public String azureStorageDataLakeDirectoryName()
      Name of the directory in azure datalake on which operation is to be performed. The option is a: String type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeDirectoryName.
    • azureStorageDataLakeFileName

      public String azureStorageDataLakeFileName()
      Name of the file in azure datalake on which operation is to be performed. The option is a: String type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeFileName.
    • azureStorageDataLakeMetadata

      public String azureStorageDataLakeMetadata()
      The metadata to associate with the file. The option is a: Map<String, String> type. Group: from both
      Returns:
      the name of the header AzureStorageDataLakeMetadata.
    • azureStorageDataLakePublicAccessType

      public String azureStorageDataLakePublicAccessType()
      Defines options available to configure the behavior of a call to listFileSystemsSegment on a DataLakeServiceAsyncClient object. The option is a: PublicAccessType type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakePublicAccessType.
    • azureStorageDataLakeRawHttpHeaders

      public String azureStorageDataLakeRawHttpHeaders()
      Non parsed http headers that can be used by the user. The option is a: HttpHeaders type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeRawHttpHeaders.
    • azureStorageDataLakeRequestCondition

      public String azureStorageDataLakeRequestCondition()
      This contains values which will restrict the successful operation of a variety of requests to the conditions present. These conditions are entirely optional. The option is a: DataLakeRequestConditions type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeRequestCondition.
    • azureStorageDataLakeListPathOptions

      public String azureStorageDataLakeListPathOptions()
      Defines options available to configure the behavior of a call to listContainersSegment on a DataLakeFileSystemClient object. Null may be passed. The option is a: ListPathOptions type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeListPathOptions.
    • azureStorageDataLakePath

      public String azureStorageDataLakePath()
      Path of the file to be used for upload operations. The option is a: String type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakePath.
    • azureStorageDataLakeRecursive

      public String azureStorageDataLakeRecursive()
      Specifies if the call to listContainersSegment should recursively include all paths. The option is a: Boolean type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeRecursive.
    • azureStorageDataLakeMaxResults

      public String azureStorageDataLakeMaxResults()
      Specifies the maximum number of blobs to return, including all BlobPrefix elements. The option is a: Integer type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeMaxResults.
    • azureStorageDataLakeUserPrincipalNameReturned

      public String azureStorageDataLakeUserPrincipalNameReturned()
      Specifies if the name of the user principal should be returned. The option is a: Boolean type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeUserPrincipalNameReturned.
    • azureStorageDataLakeRegex

      public String azureStorageDataLakeRegex()
      Filter the results to return only those files with match the specified regular expression. The option is a: String type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeRegex.
    • azureStorageDataLakeFileDir

      public String azureStorageDataLakeFileDir()
      Directory in which the file is to be downloaded. The option is a: String type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeFileDir.
    • azureStorageDataLakeAccessTier

      public String azureStorageDataLakeAccessTier()
      Access tier of file. The option is a: AccessTier type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeAccessTier.
    • azureStorageDataLakeContentMD5

      public String azureStorageDataLakeContentMD5()
      An MD5 hash of the content. The hash is used to verify the integrity of the file during transport. The option is a: byte[] type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeContentMD5.
    • azureStorageDataLakeFileRange

      public String azureStorageDataLakeFileRange()
      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. The option is a: FileRange type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeFileRange.
    • azureStorageDataLakeParallelTransferOptions

      public String azureStorageDataLakeParallelTransferOptions()
      The configuration used to parallelize data transfer operations. The option is a: ParallelTransferOptions type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeParallelTransferOptions.
    • azureStorageDataLakeOpenOptions

      public String azureStorageDataLakeOpenOptions()
      Set of OpenOption used to configure how to open or create a file. The option is a: Set<OpenOption> type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeOpenOptions.
    • azureStorageDataLakeAccessTierChangeTime

      public String azureStorageDataLakeAccessTierChangeTime()
      Datetime when the access tier of the blob last changed. The option is a: OffsetDateTime type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeAccessTierChangeTime.
    • azureStorageDataLakeArchiveStatus

      public String azureStorageDataLakeArchiveStatus()
      Archive status of file. The option is a: ArchiveStatus type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeArchiveStatus.
    • azureStorageDataLakeCacheControl

      public String azureStorageDataLakeCacheControl()
      Cache control specified for the file. The option is a: String type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeCacheControl.
    • azureStorageDataLakeContentDisposition

      public String azureStorageDataLakeContentDisposition()
      Content disposition specified for the file. The option is a: String type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeContentDisposition.
    • azureStorageDataLakeContentEncoding

      public String azureStorageDataLakeContentEncoding()
      Content encoding specified for the file. The option is a: String type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeContentEncoding.
    • azureStorageDataLakeContentLanguage

      public String azureStorageDataLakeContentLanguage()
      Content language specified for the file. The option is a: String type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeContentLanguage.
    • azureStorageDataLakeContentType

      public String azureStorageDataLakeContentType()
      Content type specified for the file. The option is a: String type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeContentType.
    • azureStorageDataLakeCopyCompletionTime

      public String azureStorageDataLakeCopyCompletionTime()
      Conclusion time of the last attempted Copy Blob operation where this file was the destination file. The option is a: OffsetDateTime type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeCopyCompletionTime.
    • azureStorageDataLakeCopyId

      public String azureStorageDataLakeCopyId()
      String identifier for this copy operation. The option is a: String type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeCopyId.
    • azureStorageDataLakeCopyProgress

      public String azureStorageDataLakeCopyProgress()
      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. The option is a: String type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeCopyProgress.
    • azureStorageDataLakeCopySource

      public String azureStorageDataLakeCopySource()
      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. The option is a: String type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeCopySource.
    • azureStorageDataLakeCopyStatus

      public String azureStorageDataLakeCopyStatus()
      Status of the last copy operation performed on the file. The option is a: com.azure.storage.file.datalake.models.CopyStatusType type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeCopyStatus.
    • azureStorageDataLakeCopyStatusDescription

      public String azureStorageDataLakeCopyStatusDescription()
      The description of the copy's status. The option is a: String type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeCopyStatusDescription.
    • azureStorageDataLakeCreationTime

      public String azureStorageDataLakeCreationTime()
      Creation time of the file. The option is a: OffsetDateTime type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeCreationTime.
    • azureStorageDataLakeEncryptionKeySha256

      public String azureStorageDataLakeEncryptionKeySha256()
      The SHA-256 hash of the encryption key used to encrypt the file. The option is a: String type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeEncryptionKeySha256.
    • azureStorageDataLakeETag

      public String azureStorageDataLakeETag()
      The E Tag of the file. The option is a: String type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeETag.
    • azureStorageDataLakeFileSize

      public String azureStorageDataLakeFileSize()
      Size of the file. The option is a: Long type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeFileSize.
    • azureStorageDataLakeLastModified

      public String azureStorageDataLakeLastModified()
      Datetime when the file was last modified. The option is a: OffsetDateTime type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeLastModified.
    • azureStorageDataLakeLeaseDuration

      public String azureStorageDataLakeLeaseDuration()
      Type of lease on the file. The option is a: com.azure.storage.file.datalake.models.LeaseDurationType type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeLeaseDuration.
    • azureStorageDataLakeLeaseState

      public String azureStorageDataLakeLeaseState()
      State of the lease on the file. The option is a: com.azure.storage.file.datalake.models.LeaseStateType type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeLeaseState.
    • azureStorageDataLakeLeaseStatus

      public String azureStorageDataLakeLeaseStatus()
      Status of the lease on the file. The option is a: com.azure.storage.file.datalake.models.LeaseStatusType type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeLeaseStatus.
    • azureStorageDataLakeIncrementalCopy

      public String azureStorageDataLakeIncrementalCopy()
      Flag indicating if the file was incrementally copied. The option is a: Boolean type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeIncrementalCopy.
    • azureStorageDataLakeServerEncrypted

      public String azureStorageDataLakeServerEncrypted()
      Flag indicating if the file's content is encrypted on the server. The option is a: Boolean type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeServerEncrypted.
    • azureStorageDataLakeDownloadLinkExpiration

      public String azureStorageDataLakeDownloadLinkExpiration()
      Set the Expiration time of the download link. The option is a: Long type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeDownloadLinkExpiration.
    • azureStorageDataLakeDownloadLink

      public String azureStorageDataLakeDownloadLink()
      The link that can be used to download the file from datalake. The option is a: String type. Group: consumer
      Returns:
      the name of the header AzureStorageDataLakeDownloadLink.
    • azureStorageDataLakeFileOffset

      public String azureStorageDataLakeFileOffset()
      The position where the data is to be appended. The option is a: Long type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeFileOffset.
    • azureStorageDataLakeLeaseId

      public String azureStorageDataLakeLeaseId()
      By setting lease id, requests will fail if the provided lease does not match the active lease on the file. The option is a: String type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeLeaseId.
    • azureStorageDataLakePathHttpHeaders

      public String azureStorageDataLakePathHttpHeaders()
      Additional parameters for a set of operations. The option is a: PathHttpHeaders type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakePathHttpHeaders.
    • azureStorageDataLakeRetainCommitedData

      public String azureStorageDataLakeRetainCommitedData()
      Determines Whether or not uncommitted data is to be retained after the operation. The option is a: Boolean type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeRetainCommitedData.
    • azureStorageDataLakeClose

      public String azureStorageDataLakeClose()
      Whether or not a file changed event raised indicates completion (true) or modification (false). The option is a: Boolean type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeClose.
    • azureStorageDataLakePosition

      public String azureStorageDataLakePosition()
      The length of the file after all data has been written. The option is a: Long type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakePosition.
    • azureStorageDataLakeExpression

      public String azureStorageDataLakeExpression()
      The query expression on the file. The option is a: String type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeExpression.
    • azureStorageDataLakeInputSerialization

      public String azureStorageDataLakeInputSerialization()
      Defines the input serialization for a file query request. either FileQueryJsonSerialization or FileQueryDelimitedSerialization. The option is a: FileQuerySerialization type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeInputSerialization.
    • azureStorageDataLakeOutputSerialization

      public String azureStorageDataLakeOutputSerialization()
      Defines the output serialization for a file query request. either FileQueryJsonSerialization or FileQueryDelimitedSerialization. The option is a: FileQuerySerialization type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeOutputSerialization.
    • azureStorageDataLakeErrorConsumer

      public String azureStorageDataLakeErrorConsumer()
      Sets error consumer for file query. The option is a: Consumer<FileQueryError> type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeErrorConsumer.
    • azureStorageDataLakeProgressConsumer

      public String azureStorageDataLakeProgressConsumer()
      Sets progress consumer for file query. The option is a: Consumer<FileQueryProgress> type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeProgressConsumer.
    • azureStorageDataLakeQueryOptions

      public String azureStorageDataLakeQueryOptions()
      Optional parameters for File Query. The option is a: FileQueryOptions type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeQueryOptions.
    • azureStorageDataLakePermission

      public String azureStorageDataLakePermission()
      Sets the permission for file. The option is a: String type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakePermission.
    • azureStorageDataLakeUmask

      public String azureStorageDataLakeUmask()
      Sets the umask for file. The option is a: String type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeUmask.
    • azureStorageDataLakeFileClient

      public String azureStorageDataLakeFileClient()
      Sets the file client to use. The option is a: DataLakeFileClient type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeFileClient.
    • azureStorageDataLakeFlush

      public String azureStorageDataLakeFlush()
      Sets whether to flush on append. The option is a: Boolean type. Group: producer
      Returns:
      the name of the header AzureStorageDataLakeFlush.