Class BlobConfiguration
java.lang.Object
org.apache.camel.component.azure.storage.blob.BlobConfiguration
- All Implemented Interfaces:
Cloneable
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
Access key for the associated azure account name to be used for authentication with azure blob servicesAzure account name to be used for authentication with azure blob servicesThe blob name, to consume specific blob from a container.long
Set the blob offset for the upload or download operations, default is 0A user-controlled value that you can use to track requests.The blob type in order to initiate the appropriate settings for each blob typecom.azure.storage.blob.models.BlockListType
Specifies which type of blocks to return.com.azure.core.util.Context
When using `getChangeFeed` producer operation, this gives additional context that is passed through the Http pipeline during the service call.When using `getChangeFeed` producer operation, this filters the results to return events approximately before the end time.When using `getChangeFeed` producer operation, this filters the results to return events approximately after the start time.The blob container namecom.azure.storage.common.StorageSharedKeyCredential
StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication informationHow many bytes to include in the range.Override the default expiration (millis) of URL download link.The file directory where the downloaded blobs will be saved to, this can be used in both, producer and consumerSpecifies the maximum number of blobs to return, including all BlobPrefix elements.int
Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a response body.The blob operation that can be used with this component on the producerSpecifies the maximum size for the page blob, up to 8 TB.Filters the results to return only blobs whose names begin with the specified prefix.getRegex()
Filters the results to return only blobs whose names match the specified regular expression.com.azure.storage.blob.BlobServiceClient
Client to a storage account.An optional timeout value beyond which aRuntimeException
will be raised.boolean
Close the stream after read or keep it open, default is trueboolean
Close the stream after write or keep it open, default is trueboolean
When is set to `true`, the staged blocks will not be committed directly.boolean
When is set to `true`, the append blocks will be created when committing append blocks.boolean
When is set to `true`, the page blob will be created when uploading page blob.void
setAccessKey
(String accessKey) void
setAccountName
(String accountName) void
setBlobName
(String blobName) void
setBlobOffset
(long blobOffset) void
setBlobSequenceNumber
(Long blobSequenceNumber) void
setBlobType
(BlobType blobType) void
setBlockListType
(com.azure.storage.blob.models.BlockListType blockListType) void
setChangeFeedContext
(com.azure.core.util.Context changeFeedContext) void
setChangeFeedEndTime
(OffsetDateTime changeFeedEndTime) void
setChangeFeedStartTime
(OffsetDateTime changeFeedStartTime) void
setCloseStreamAfterRead
(boolean closeStreamAfterRead) void
setCloseStreamAfterWrite
(boolean closeStreamAfterWrite) void
setCommitBlockListLater
(boolean commitBlockListLater) void
setContainerName
(String containerName) void
setCreateAppendBlob
(boolean createAppendBlob) void
setCreatePageBlob
(boolean createPageBlob) void
setCredentials
(com.azure.storage.common.StorageSharedKeyCredential credentials) void
setCredentialType
(CredentialType credentialType) Determines the credential strategy to adoptvoid
setDataCount
(Long dataCount) void
setDownloadLinkExpiration
(Long downloadLinkExpiration) void
setFileDir
(String fileDir) void
setMaxResultsPerPage
(Integer maxResultsPerPage) void
setMaxRetryRequests
(int maxRetryRequests) void
setOperation
(BlobOperationsDefinition operation) void
setPageBlobSize
(Long pageBlobSize) void
void
void
setServiceClient
(com.azure.storage.blob.BlobServiceClient serviceClient) void
setSourceBlobAccessKey
(String sourceBlobAccessKey) Source Blob Access Key: for copyblob operation, sadly, we need to have an accessKey for the source blob we want to copy Passing an accessKey as header, it's unsafe so we could set as key.void
setTimeout
(Duration timeout)
-
Constructor Details
-
BlobConfiguration
public BlobConfiguration()
-
-
Method Details
-
getAccountName
Azure account name to be used for authentication with azure blob services -
setAccountName
-
getContainerName
The blob container name -
setContainerName
-
getCredentials
public com.azure.storage.common.StorageSharedKeyCredential getCredentials()StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information -
getServiceClient
public com.azure.storage.blob.BlobServiceClient getServiceClient()Client to a storage account. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs and containers.This client contains operations on a service account. Operations on a container are available on
BlobContainerClient
throughBlobServiceClient.getBlobContainerClient(String)
, and operations on a blob are available onBlobClient
throughBlobContainerClient.getBlobClient(String)
. -
setServiceClient
public void setServiceClient(com.azure.storage.blob.BlobServiceClient serviceClient) -
getAccessKey
Access key for the associated azure account name to be used for authentication with azure blob services -
setAccessKey
-
getOperation
The blob operation that can be used with this component on the producer -
setOperation
-
getBlobName
The blob name, to consume specific blob from a container. However, on producer it is only required for the operations on the blob level -
setBlobName
-
getBlobType
The blob type in order to initiate the appropriate settings for each blob type -
setBlobType
-
getFileDir
The file directory where the downloaded blobs will be saved to, this can be used in both, producer and consumer -
setFileDir
-
getBlobOffset
public long getBlobOffset()Set the blob offset for the upload or download operations, default is 0 -
setBlobOffset
public void setBlobOffset(long blobOffset) -
getDataCount
How many bytes to include in the range. Must be greater than or equal to 0 if specified. -
setDataCount
-
getMaxRetryRequests
public int getMaxRetryRequests()Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a response body. -
setMaxRetryRequests
public void setMaxRetryRequests(int maxRetryRequests) -
getTimeout
An optional timeout value beyond which aRuntimeException
will be raised. -
setTimeout
-
getPrefix
Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs. -
setPrefix
-
getMaxResultsPerPage
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. -
setMaxResultsPerPage
-
isCloseStreamAfterRead
public boolean isCloseStreamAfterRead()Close the stream after read or keep it open, default is true -
setCloseStreamAfterRead
public void setCloseStreamAfterRead(boolean closeStreamAfterRead) -
isCloseStreamAfterWrite
public boolean isCloseStreamAfterWrite()Close the stream after write or keep it open, default is true -
setCloseStreamAfterWrite
public void setCloseStreamAfterWrite(boolean closeStreamAfterWrite) -
getPageBlobSize
Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary. -
setPageBlobSize
-
getDownloadLinkExpiration
Override the default expiration (millis) of URL download link. -
setDownloadLinkExpiration
-
isCommitBlockListLater
public boolean isCommitBlockListLater()When is set to `true`, the staged blocks will not be committed directly. -
setCommitBlockListLater
public void setCommitBlockListLater(boolean commitBlockListLater) -
isCreateAppendBlob
public boolean isCreateAppendBlob()When is set to `true`, the append blocks will be created when committing append blocks. -
setCreateAppendBlob
public void setCreateAppendBlob(boolean createAppendBlob) -
isCreatePageBlob
public boolean isCreatePageBlob()When is set to `true`, the page blob will be created when uploading page blob. -
setCreatePageBlob
public void setCreatePageBlob(boolean createPageBlob) -
getBlobSequenceNumber
A user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1.The default value is 0. -
setBlobSequenceNumber
-
getBlockListType
public com.azure.storage.blob.models.BlockListType getBlockListType()Specifies which type of blocks to return. -
setBlockListType
public void setBlockListType(com.azure.storage.blob.models.BlockListType blockListType) -
getChangeFeedStartTime
When using `getChangeFeed` producer operation, this 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. -
setChangeFeedStartTime
-
getChangeFeedEndTime
When using `getChangeFeed` producer operation, this 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. -
setChangeFeedEndTime
-
getChangeFeedContext
public com.azure.core.util.Context getChangeFeedContext()When using `getChangeFeed` producer operation, this gives additional context that is passed through the Http pipeline during the service call. -
setChangeFeedContext
public void setChangeFeedContext(com.azure.core.util.Context changeFeedContext) -
getRegex
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. -
setRegex
-
getSourceBlobAccessKey
-
getCredentialType
-
setCredentialType
Determines the credential strategy to adopt -
setSourceBlobAccessKey
Source Blob Access Key: for copyblob operation, sadly, we need to have an accessKey for the source blob we want to copy Passing an accessKey as header, it's unsafe so we could set as key. -
copy
-