Package org.apache.camel.builder.endpoint.dsl

Class BlobEndpointBuilderFactory.BlobHeaderNameBuilder

  • Enclosing interface:
    BlobEndpointBuilderFactory
    public static class BlobEndpointBuilderFactory.BlobHeaderNameBuilder
extends Object
    The builder of headers' name for the Azure Storage Blob Service component.

    • Constructor Detail

      • BlobHeaderNameBuilder

        public BlobHeaderNameBuilder()

    • Method Detail

      • azureStorageBlobOperation

        public String azureStorageBlobOperation()
        (All) Specify the producer operation to execute, please see the doc on this page related to producer operation. The option is a: org.apache.camel.component.azure.storage.blob.BlobOperationsDefinition type. Group: producer
        Returns:
        the name of the header AzureStorageBlobOperation.

      • azureStorageBlobHttpHeaders

        public String azureStorageBlobHttpHeaders()
        (uploadBlockBlob, commitBlobBlockList, createAppendBlob, createPageBlob) Additional parameters for a set of operations. The option is a: BlobHttpHeaders type. Group: producer
        Returns:
        the name of the header AzureStorageBlobHttpHeaders.

      • azureStorageBlobETag

        public String azureStorageBlobETag()
        The E Tag of the blob. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobETag.

      • azureStorageBlobCreationTime

        public String azureStorageBlobCreationTime()
        Creation time of the blob. The option is a: OffsetDateTime type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobCreationTime.

      • azureStorageBlobLastModified

        public String azureStorageBlobLastModified()
        Datetime when the blob was last modified. The option is a: OffsetDateTime type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobLastModified.

      • azureStorageBlobContentType

        public String azureStorageBlobContentType()
        Content type specified for the blob. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobContentType.

      • azureStorageBlobContentMD5

        public String azureStorageBlobContentMD5()
        (producer) (Most operations related to upload blob) Most operations related to upload blobAn MD5 hash of the block content. This hash is used to verify the integrity of the block during transport. When this header is specified, the storage service compares the hash of the content that has arrived with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the operation will fail. (consumer) Content MD5 specified for the blob. The option is a: byte[] type. Group: common
        Returns:
        the name of the header AzureStorageBlobContentMD5.

      • azureStorageBlobContentEncoding

        public String azureStorageBlobContentEncoding()
        Content encoding specified for the blob. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobContentEncoding.

      • azureStorageBlobContentDisposition

        public String azureStorageBlobContentDisposition()
        Content disposition specified for the blob. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobContentDisposition.

      • azureStorageBlobContentLanguage

        public String azureStorageBlobContentLanguage()
        Content language specified for the blob. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobContentLanguage.

      • azureStorageBlobCacheControl

        public String azureStorageBlobCacheControl()
        Cache control specified for the blob. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobCacheControl.

      • azureStorageBlobBlobSize

        public String azureStorageBlobBlobSize()
        The size of the blob. The option is a: long type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobBlobSize.

      • azureStorageBlobBlobUploadSize

        public String azureStorageBlobBlobUploadSize()
        When uploading a blob with the uploadBlockBlob-operation this can be used to tell the client what the length of an InputStream is. The option is a: long type. Group: producer
        Returns:
        the name of the header AzureStorageBlobBlobUploadSize.

      • azureStorageBlobSequenceNumber

        public String azureStorageBlobSequenceNumber()
        (producer) (createPageBlob) A user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 263 - 1. The default value is 0. (consumer) The current sequence number for a page blob. The option is a: Long type. Group: common
        Returns:
        the name of the header AzureStorageBlobSequenceNumber.

      • azureStorageBlobBlobType

        public String azureStorageBlobBlobType()
        The type of the blob. The option is a: org.apache.camel.component.azure.storage.blob.BlobType type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobBlobType.

      • azureStorageBlobLeaseStatus

        public String azureStorageBlobLeaseStatus()
        Status of the lease on the blob. The option is a: com.azure.storage.blob.models.LeaseStatusType type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobLeaseStatus.

      • azureStorageBlobLeaseState

        public String azureStorageBlobLeaseState()
        State of the lease on the blob. The option is a: com.azure.storage.blob.models.LeaseStateType type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobLeaseState.

      • azureStorageBlobLeaseDuration

        public String azureStorageBlobLeaseDuration()
        Type of lease on the blob. The option is a: com.azure.storage.blob.models.LeaseDurationType type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobLeaseDuration.

      • azureStorageBlobCopyId

        public String azureStorageBlobCopyId()
        Identifier of the last copy operation performed on the blob. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobCopyId.

      • azureStorageBlobCopyStatus

        public String azureStorageBlobCopyStatus()
        Status of the last copy operation performed on the blob. The option is a: com.azure.storage.blob.models.CopyStatusType type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobCopyStatus.

      • azureStorageBlobCopySource

        public String azureStorageBlobCopySource()
        Source of the last copy operation performed on the blob. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobCopySource.

      • azureStorageBlobCopyProgress

        public String azureStorageBlobCopyProgress()
        Progress of the last copy operation performed on the blob. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobCopyProgress.

      • azureStorageBlobCopyCompletionTime

        public String azureStorageBlobCopyCompletionTime()
        Datetime when the last copy operation on the blob completed. The option is a: OffsetDateTime type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobCopyCompletionTime.

      • azureStorageBlobCopyStatusDescription

        public String azureStorageBlobCopyStatusDescription()
        Description of the last copy operation on the blob. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobCopyStatusDescription.

      • azureStorageBlobCopyDestinationSnapshot

        public String azureStorageBlobCopyDestinationSnapshot()
        Snapshot identifier of the last incremental copy snapshot for the blob. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobCopyDestinationSnapshot.

      • azureStorageBlobIsServerEncrypted

        public String azureStorageBlobIsServerEncrypted()
        Flag indicating if the blob's content is encrypted on the server. The option is a: boolean type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobIsServerEncrypted.

      • azureStorageBlobIsIncrementalCopy

        public String azureStorageBlobIsIncrementalCopy()
        Flag indicating if the blob was incrementally copied. The option is a: boolean type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobIsIncrementalCopy.

      • azureStorageBlobAccessTier

        public String azureStorageBlobAccessTier()
        (producer) (uploadBlockBlob, commitBlobBlockList) Defines values for AccessTier. (consumer) Access tier of the blob. The option is a: AccessTier type. Group: common
        Returns:
        the name of the header AzureStorageBlobAccessTier.

      • azureStorageBlobIsAccessTierInferred

        public String azureStorageBlobIsAccessTierInferred()
        Flag indicating if the access tier of the blob was inferred from properties of the blob. The option is a: boolean type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobIsAccessTierInferred.

      • azureStorageBlobArchiveStatus

        public String azureStorageBlobArchiveStatus()
        Archive status of the blob. The option is a: ArchiveStatus type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobArchiveStatus.

      • azureStorageBlobaccessTierChangeTime

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

      • azureStorageBlobMetadata

        public String azureStorageBlobMetadata()
        (producer) (Operations related to container and blob) Operations related to container and blob Metadata to associate with the container or blob. (consumer) Additional metadata associated with the blob. The option is a: Map<String,String> type. Group: common
        Returns:
        the name of the header AzureStorageBlobMetadata.

      • azureStorageBlobCommittedBlockCount

        public String azureStorageBlobCommittedBlockCount()
        Number of blocks committed to an append blob. The option is a: Integer type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobCommittedBlockCount.

      • azureStorageBlobAppendOffset

        public String azureStorageBlobAppendOffset()
        The offset at which the block was committed to the block blob. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobAppendOffset.

      • azureStorageBlobRawHttpHeaders

        public String azureStorageBlobRawHttpHeaders()
        Returns non-parsed httpHeaders that can be used by the user. The option is a: HttpHeaders type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobRawHttpHeaders.

      • azureStorageBlobFileName

        public String azureStorageBlobFileName()
        The downloaded filename from the operation downloadBlobToFile. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobFileName.

      • azureStorageBlobDownloadLink

        public String azureStorageBlobDownloadLink()
        The download link generated by downloadLink operation. The option is a: String type. Group: consumer
        Returns:
        the name of the header AzureStorageBlobDownloadLink.

      • azureStorageBlobListBlobOptions

        public String azureStorageBlobListBlobOptions()
        (listBlobs) Defines options available to configure the behavior of a call to listBlobsFlatSegment on a BlobContainerClient object. The option is a: ListBlobsOptions type. Group: producer
        Returns:
        the name of the header AzureStorageBlobListBlobOptions.

      • azureStorageBlobListDetails

        public String azureStorageBlobListDetails()
        (listBlobs) The details for listing specific blobs. The option is a: BlobListDetails type. Group: producer
        Returns:
        the name of the header AzureStorageBlobListDetails.

      • azureStorageBlobPrefix

        public String azureStorageBlobPrefix()
        (listBlobs,getBlob) Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs. The option is a: String type. Group: producer
        Returns:
        the name of the header AzureStorageBlobPrefix.

      • azureStorageBlobRegex

        public String azureStorageBlobRegex()
        (listBlobs,getBlob) Filters the results to return only blobs whose names match the specified regular expression. May be null to return all. If both prefix and regex are set, regex takes the priority and prefix is ignored. The option is a: String type. Group: producer
        Returns:
        the name of the header AzureStorageBlobRegex.

      • azureStorageBlobMaxResultsPerPage

        public String azureStorageBlobMaxResultsPerPage()
        (listBlobs) Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items. The option is a: Integer type. Group: producer
        Returns:
        the name of the header AzureStorageBlobMaxResultsPerPage.

      • azureStorageBlobTimeout

        public String azureStorageBlobTimeout()
        (All) 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 AzureStorageBlobTimeout.

      • azureStorageBlobPublicAccessType

        public String azureStorageBlobPublicAccessType()
        (createContainer) Specifies how the data in this container is available to the public. Pass null for no public access. The option is a: PublicAccessType type. Group: producer
        Returns:
        the name of the header AzureStorageBlobPublicAccessType.

      • azureStorageBlobRequestCondition

        public String azureStorageBlobRequestCondition()
        (Operations related to container and blob) 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: BlobRequestConditions type. Group: producer
        Returns:
        the name of the header AzureStorageBlobRequestCondition.

      • azureStorageBlobBlobContainerName

        public String azureStorageBlobBlobContainerName()
        (Operations related to container and blob) Override/set the container name on the exchange headers. The option is a: String type. Group: producer
        Returns:
        the name of the header AzureStorageBlobBlobContainerName.

      • azureStorageBlobBlobName

        public String azureStorageBlobBlobName()
        (Operations related to blob) Override/set the blob name on the exchange headers. The option is a: String type. Group: producer
        Returns:
        the name of the header AzureStorageBlobBlobName.

      • azureStorageBlobFileDir

        public String azureStorageBlobFileDir()
        (downloadBlobToFile) The file directory where the downloaded blobs will be saved to. The option is a: String type. Group: producer
        Returns:
        the name of the header AzureStorageBlobFileDir.

      • azureStorageBlobPageBlobRange

        public String azureStorageBlobPageBlobRange()
        (Operations related to page blob) A PageRange object. Given that pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the end offset must be a modulus of 512 - 1. Examples of valid byte ranges are 0-511, 512-1023, etc. The option is a: PageRange type. Group: producer
        Returns:
        the name of the header AzureStorageBlobPageBlobRange.

      • azureStorageBlobPageBlobSize

        public String azureStorageBlobPageBlobSize()
        (createPageBlob, resizePageBlob) Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary. The option is a: Long type. Group: producer
        Returns:
        the name of the header AzureStorageBlobPageBlobSize.

      • azureStorageBlobCommitBlobBlockListLater

        public String azureStorageBlobCommitBlobBlockListLater()
        (stageBlockBlobList) When is set to true, the staged blocks will not be committed directly. The option is a: boolean type. Group: producer
        Returns:
        the name of the header AzureStorageBlobCommitBlobBlockListLater.

      • azureStorageBlobBlockListType

        public String azureStorageBlobBlockListType()
        (getBlobBlockList) Specifies which type of blocks to return. The option is a: com.azure.storage.blob.models.BlockListType type. Group: producer
        Returns:
        the name of the header AzureStorageBlobBlockListType.

      • azureStorageBlobCreateAppendBlob

        public String azureStorageBlobCreateAppendBlob()
        (commitAppendBlob) When is set to true, the append blocks will be created when committing append blocks. The option is a: boolean type. Group: producer
        Returns:
        the name of the header AzureStorageBlobCreateAppendBlob.

      • azureStorageBlobCreatePageBlob

        public String azureStorageBlobCreatePageBlob()
        (uploadPageBlob) When is set to true, the page blob will be created when uploading page blob. The option is a: boolean type. Group: producer
        Returns:
        the name of the header AzureStorageBlobCreatePageBlob.

      • azureStorageBlobDeleteSnapshotsOptionType

        public String azureStorageBlobDeleteSnapshotsOptionType()
        (deleteBlob) Specifies the behavior for deleting the snapshots on this blob. Include will delete the base blob and all snapshots. Only will delete only the snapshots. If a snapshot is being deleted, you must pass null. The option is a: com.azure.storage.blob.models.DeleteSnapshotsOptionType type. Group: producer
        Returns:
        the name of the header AzureStorageBlobDeleteSnapshotsOptionType.

      • azureStorageBlobListBlobContainersOptions

        public String azureStorageBlobListBlobContainersOptions()
        (listBlobContainers) A ListBlobContainersOptions which specifies what data should be returned by the service. The option is a: ListBlobContainersOptions type. Group: producer
        Returns:
        the name of the header AzureStorageBlobListBlobContainersOptions.

      • azureStorageBlobParallelTransferOptions

        public String azureStorageBlobParallelTransferOptions()
        (downloadBlobToFile) ParallelTransferOptions to use to download to file. Number of parallel transfers parameter is ignored. The option is a: ParallelTransferOptions type. Group: producer
        Returns:
        the name of the header AzureStorageBlobParallelTransferOptions.

      • azureStorageBlobDownloadLinkExpiration

        public String azureStorageBlobDownloadLinkExpiration()
        (downloadLink) Override the default expiration (millis) of URL download link. The option is a: Long type. Group: producer
        Returns:
        the name of the header AzureStorageBlobDownloadLinkExpiration.

      • azureStorageBlobSourceBlobAccountName

        public String azureStorageBlobSourceBlobAccountName()
        (copyBlob) The source blob account name to be used as source account name in a copy blob operation. The option is a: String type. Group: producer
        Returns:
        the name of the header AzureStorageBlobSourceBlobAccountName.

      • azureStorageBlobSourceBlobContainerName

        public String azureStorageBlobSourceBlobContainerName()
        (copyBlob) The source blob container name to be used as source container name in a copy blob operation. The option is a: String type. Group: producer
        Returns:
        the name of the header AzureStorageBlobSourceBlobContainerName.

      • azureStorageBlobChangeFeedStartTime

        public String azureStorageBlobChangeFeedStartTime()
        (getChangeFeed) It filters the results to return events approximately after the start time. Note: A few events belonging to the previous hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the start time down by an hour. The option is a: OffsetDateTime type. Group: producer
        Returns:
        the name of the header AzureStorageBlobChangeFeedStartTime.

      • azureStorageBlobChangeFeedEndTime

        public String azureStorageBlobChangeFeedEndTime()
        (getChangeFeed) It filters the results to return events approximately before the end time. Note: A few events belonging to the next hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the end time up by an hour. The option is a: OffsetDateTime type. Group: producer
        Returns:
        the name of the header AzureStorageBlobChangeFeedEndTime.

      • azureStorageBlobContext

        public String azureStorageBlobContext()
        (getChangeFeed) This gives additional context that is passed through the Http pipeline during the service call. The option is a: Context type. Group: producer
        Returns:
        the name of the header AzureStorageBlobContext.