CloudBlockBlob Class

Definition

Represents a blob that is uploaded as a set of blocks.

public class CloudBlockBlob extends CloudBlob

Constructors

CloudBlockBlob(final CloudBlockBlob otherBlob)

Creates an instance of the class by copying values from another cloud block blob.

CloudBlockBlob(final StorageUri blobAbsoluteUri)

Creates an instance of the class using the specified absolute StorageUri.

CloudBlockBlob(final StorageUri blobAbsoluteUri, final StorageCredentials credentials)

Creates an instance of the class using the specified absolute StorageUri and credentials.

CloudBlockBlob(final StorageUri blobAbsoluteUri, final String snapshotID, final StorageCredentials credentials)

Creates an instance of the class using the specified absolute StorageUri, snapshot ID, and credentials.

CloudBlockBlob(final URI blobAbsoluteUri)

Creates an instance of the class using the specified absolute URI.

CloudBlockBlob(final URI blobAbsoluteUri, final StorageCredentials credentials)

Creates an instance of the class using the specified absolute URI and credentials.

CloudBlockBlob(final URI blobAbsoluteUri, final String snapshotID, final StorageCredentials credentials)

Creates an instance of the class using the specified absolute URI, snapshot ID, and credentials.

CloudBlockBlob(String blobName, String snapshotID, CloudBlobContainer container)

Creates an instance of the class using the specified type, name, snapshot ID, and container.

Methods

commitBlockList(final Iterable<BlockEntry> blockList)

Commits a block list to the storage service. In order to be written as part of a blob, a block must have been successfully written to the server in a prior uploadBlock operation.

commitBlockList(final Iterable<BlockEntry> blockList, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

Commits a block list to the storage service using the specified lease ID, request options, and operation context. In order to be written as part of a blob, a block must have been successfully written to the server in a prior uploadBlock operation.

commitBlockList(final Iterable<BlockEntry> blockList, StandardBlobTier standardBlobTier, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

Commits a block list to the storage service using the specified lease ID, request options, and operation context. In order to be written as part of a blob, a block must have been successfully written to the server in a prior uploadBlock operation.

createBlockFromURI(final String blockId, final URI copySource, final Long offset, final Long length)

Creates a block to be committed as part of the block blob, using the specified block ID and the source URL.

createBlockFromURI(final String blockId, final URI copySource, final Long offset, final Long length, String md5, final AccessCondition sourceAccessCondition, BlobRequestOptions options, OperationContext opContext)

Creates a block to be committed as part of the block blob, using the specified block ID, the specified source URL, the specified lease ID, request options, and operation context.

downloadBlockList()

Downloads the committed block list from the block blob.

The committed block list includes the list of blocks that have been successfully committed to the block blob. The list of committed blocks is returned in the same order that they were committed to the blob. No block may appear more than once in the committed block list.

downloadBlockList(final BlockListingFilter blockListingFilter, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

Downloads the block list from the block blob using the specified block listing filter, request options, and operation context.

The committed block list includes the list of blocks that have been successfully committed to the block blob. The list of committed blocks is returned in the same order that they were committed to the blob. No block may appear more than once in the committed block list.

downloadText()

Downloads a blob to a string using the platform's default encoding.

downloadText(final String charsetName, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

Downloads a blob to a string using the specified encoding.

isStreamWriteSizeModified()

Gets the flag that indicates whether the default streamWriteSize was modified.

openOutputStream()

Creates and opens an output stream to write data to the block blob. If the blob already exists on the service, it will be overwritten.

To avoid overwriting and instead throw an error, please use the openOutputStream(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) overload with the appropriate AccessCondition.

openOutputStream(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

Creates and opens an output stream to write data to the block blob using the specified request options and operation context. If the blob already exists on the service, it will be overwritten.

To avoid overwriting and instead throw an error, please pass in an AccessCondition generated using generateIfNotExistsCondition().

setStreamWriteSizeInBytes(final int streamWriteSizeInBytes)

Sets the number of bytes to buffer when writing to a BlobOutputStream.

startCopy(final CloudBlockBlob sourceBlob)

Requests the service to start copying a block blob's contents, properties, and metadata to a new block blob.

startCopy(final CloudBlockBlob sourceBlob, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, BlobRequestOptions options, OperationContext opContext)

Requests the service to start copying a block blob's contents, properties, and metadata to a new block blob, using the specified access conditions, lease ID, request options, and operation context.

startCopy(final CloudBlockBlob sourceBlob, String contentMd5, boolean syncCopy, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, BlobRequestOptions options, OperationContext opContext)

Requests the service to start copying a block blob's contents, properties, and metadata to a new block blob, using the specified access conditions, lease ID, request options, and operation context.

startCopy(final CloudBlockBlob sourceBlob, String contentMd5, boolean syncCopy, final StandardBlobTier standardBlobTier, RehydratePriority rehydratePriority, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, BlobRequestOptions options, OperationContext opContext)

Requests the service to start copying a block blob's contents, properties, and metadata to a new block blob, using the blob tier, rehydrate priority, specified access conditions, lease ID, request options, operation context.

startCopy(final CloudFile sourceFile)

Requests the service to start copying a file's contents, properties, and metadata to a new block blob.

startCopy(final CloudFile sourceFile, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, BlobRequestOptions options, OperationContext opContext)

Requests the service to start copying a file's contents, properties, and metadata to a new block blob, using the specified access conditions, lease ID, request options, and operation context.

upload(final InputStream sourceStream, final long length)

Uploads the source stream data to the block blob. If the blob already exists on the service, it will be overwritten.

upload(final InputStream sourceStream, final long length, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

Uploads the source stream data to the blob, using the specified lease ID, request options, and operation context. If the blob already exists on the service, it will be overwritten.

upload(final InputStream sourceStream, final long length, final StandardBlobTier standardBlobTier, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

Uploads the source stream data to the blob, using the specified lease ID, request options, and operation context. If the blob already exists on the service, it will be overwritten.

uploadBlock(final String blockId, final InputStream sourceStream, final long length)

Uploads a block to be committed as part of the block blob, using the specified block ID.

uploadBlock(final String blockId, final InputStream sourceStream, final long length, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

Uploads a block to be committed as part of the block blob, using the specified block ID, the specified lease ID, request options, and operation context.

uploadFromByteArray(final byte[] buffer, final int offset, final int length, final StandardBlobTier standardBlobTier, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

Uploads a blob from data in a byte array. If the blob already exists on the service, it will be overwritten.

uploadFullBlob(final InputStream sourceStream, final long length, final StandardBlobTier standardBlobTier, final AccessCondition accessCondition, final BlobRequestOptions options, final OperationContext opContext)

Uploads a blob in a single operation.

uploadStandardBlobTier(final StandardBlobTier standardBlobTier)

Sets the blob tier on a block blob on a standard storage account.

uploadStandardBlobTier(final StandardBlobTier standardBlobTier, BlobRequestOptions options, OperationContext opContext)

Sets the tier on a block blob on a standard storage account.

uploadStandardBlobTier(final StandardBlobTier standardBlobTier, RehydratePriority rehydratePriority, BlobRequestOptions options, OperationContext opContext)

Sets the tier on a block blob on a standard storage account.

uploadText(final String content)

Uploads a blob from a string using the platform's default encoding. If the blob already exists on the service, it will be overwritten.

uploadText(final String content, final String charsetName, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

Uploads a blob from a string using the specified encoding. If the blob already exists on the service, it will be overwritten.

uploadText(final String content, final String charsetName, final StandardBlobTier standardBlobTier, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

Uploads a blob from a string using the specified encoding. If the blob already exists on the service, it will be overwritten.

Inherited Members

CloudBlob.abortCopy(final String copyId) CloudBlob.abortCopy(final String copyId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.acquireLease() CloudBlob.acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId) CloudBlob.acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.assertCorrectBlobType() CloudBlob.assertNoWriteOperationForSnapshot() CloudBlob.blobServiceClient CloudBlob.breakLease(final Integer breakPeriodInSeconds) CloudBlob.breakLease(final Integer breakPeriodInSeconds, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.changeLease(final String proposedLeaseId, final AccessCondition accessCondition) CloudBlob.changeLease(final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.CloudBlob(final BlobType type, String blobName, String snapshotID, CloudBlobContainer container) CloudBlob.CloudBlob(final BlobType type, final StorageUri uri, final String snapshotID, final StorageCredentials credentials) CloudBlob.CloudBlob(final CloudBlob otherBlob) CloudBlob.createSnapshot() CloudBlob.createSnapshot(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.createSnapshot(final HashMap<String, String> metadata, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.delete() CloudBlob.delete(final DeleteSnapshotsOption deleteSnapshotsOption, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.deleteIfExists() CloudBlob.deleteIfExists(final DeleteSnapshotsOption deleteSnapshotsOption, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.download(final OutputStream outStream) CloudBlob.download(final OutputStream outStream, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.downloadAccountInfo() CloudBlob.downloadAccountInfo(BlobRequestOptions options, OperationContext opContext) CloudBlob.downloadAccountInformationImpl(final RequestOptions options) CloudBlob.downloadAttributes() CloudBlob.downloadAttributes(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.downloadRange(final long offset, final Long length, final OutputStream outStream) CloudBlob.downloadRange(final long offset, final Long length, final OutputStream outStream, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.downloadRangeInternal(final long blobOffset, final Long length, final byte[] buffer, final int bufferOffset, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.downloadRangeToByteArray(final long offset, final Long length, final byte[] buffer, final int bufferOffset) CloudBlob.downloadRangeToByteArray(final long offset, final Long length, final byte[] buffer, final int bufferOffset, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.downloadToByteArray(final byte[] buffer, final int bufferOffset) CloudBlob.downloadToByteArray(final byte[] buffer, final int bufferOffset, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.downloadToFile(final String path) CloudBlob.downloadToFile(final String path, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.exists() CloudBlob.exists(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier) CloudBlob.generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final SharedAccessBlobHeaders headers, final String groupPolicyIdentifier) CloudBlob.generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final SharedAccessBlobHeaders headers, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols) CloudBlob.generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final SharedAccessBlobHeaders headers, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols, boolean skipDecoding) CloudBlob.generateUserDelegationSharedAccessSignature(UserDelegationKey delegationKey, SharedAccessBlobPolicy policy) CloudBlob.generateUserDelegationSharedAccessSignature(final UserDelegationKey delegationKey, final SharedAccessBlobPolicy policy, final SharedAccessBlobHeaders headers, final IPRange ipRange, final SharedAccessProtocols protocols) CloudBlob.getContainer() CloudBlob.getCopyState() CloudBlob.getMetadata() CloudBlob.getName() CloudBlob.getParent() CloudBlob.getParentNameFromURI(final StorageUri resourceAddress, final String delimiter, final CloudBlobContainer container) CloudBlob.getProperties() CloudBlob.getQualifiedStorageUri() CloudBlob.getQualifiedUri() CloudBlob.getServiceClient() CloudBlob.getSnapshotID() CloudBlob.getSnapshotQualifiedStorageUri() CloudBlob.getSnapshotQualifiedUri() CloudBlob.getStorageUri() CloudBlob.getStreamMinimumReadSizeInBytes() CloudBlob.getStreamWriteSizeInBytes() CloudBlob.getTransformedAddress(final OperationContext opContext) CloudBlob.getUri() CloudBlob.isSnapshot() CloudBlob.openInputStream() CloudBlob.openInputStream(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.openInputStream(final long offset, final Long length, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.parent CloudBlob.releaseLease(final AccessCondition accessCondition) CloudBlob.releaseLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.renewLease(final AccessCondition accessCondition) CloudBlob.renewLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.setContainer(final CloudBlobContainer container) CloudBlob.setMetadata(final HashMap<String, String> metadata) CloudBlob.setProperties(final BlobProperties properties) CloudBlob.setSnapshotID(final String snapshotID) CloudBlob.setStorageUri(final StorageUri storageUri) CloudBlob.setStreamMinimumReadSizeInBytes(final int minimumReadSize) CloudBlob.startCopy(final URI source) CloudBlob.startCopy(final URI source, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.startCopy(final URI source, final String blobTierString, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.startCopy(final URI source, String contentMd5, boolean syncCopy, final String blobTierString, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.startCopy(final URI source, String contentMd5, boolean syncCopy, final String blobTierString, final RehydratePriority rehydratePriority, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.startCopyImpl(final URI source, final String contentMd5, final boolean syncCopy, final boolean incrementalCopy, final String blobTierString, final RehydratePriority rehydratePriority, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, final BlobRequestOptions options) CloudBlob.streamMinimumReadSizeInBytes CloudBlob.streamWriteSizeInBytes CloudBlob.undelete() CloudBlob.undelete(BlobRequestOptions options, OperationContext opContext) CloudBlob.updateEtagAndLastModifiedFromResponse(HttpURLConnection request) CloudBlob.updateLengthFromResponse(HttpURLConnection request) CloudBlob.uploadFromByteArray(final byte[] buffer, final int offset, final int length) CloudBlob.uploadFromByteArray(final byte[] buffer, final int offset, final int length, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.uploadFromFile(final String path) CloudBlob.uploadFromFile(final String path, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.uploadMetadata() CloudBlob.uploadMetadata(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.uploadProperties() CloudBlob.uploadProperties(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) CloudBlob.validateCPKHeaders(StorageRequest<CloudBlobClient, T, R> request, BlobRequestOptions options, boolean upload)

Applies to