com.microsoft.azure.storage.blob

Class CloudAppendBlob

java.lang.Object

com.microsoft.azure.storage.blob.CloudBlob

com.microsoft.azure.storage.blob.CloudAppendBlob

All Implemented Interfaces:

ListBlobItem

public final class CloudAppendBlob
extends CloudBlob

Represents a Microsoft Azure Append Blob.

Constructor Summary

Constructors

Constructor and Description
CloudAppendBlob(CloudAppendBlob otherBlob) Creates an instance of the CloudAppendBlob class by copying values from another append blob.
CloudAppendBlob(StorageUri blobAbsoluteUri) Creates an instance of the CloudAppendBlob class using the specified absolute URI and storage service client.
CloudAppendBlob(StorageUri blobAbsoluteUri, StorageCredentials credentials) Creates an instance of the CloudAppendBlob class using the specified absolute StorageUri and credentials.
CloudAppendBlob(StorageUri blobAbsoluteUri, String snapshotID, StorageCredentials credentials) Creates an instance of the CloudAppendBlob class using the specified absolute StorageUri, snapshot ID, and credentials.
CloudAppendBlob(URI blobAbsoluteUri) Creates an instance of the CloudAppendBlob class using the specified absolute URI and storage service client.
CloudAppendBlob(URI blobAbsoluteUri, StorageCredentials credentials) Creates an instance of the CloudAppendBlob class using the specified absolute URI and credentials.
CloudAppendBlob(URI blobAbsoluteUri, String snapshotID, StorageCredentials credentials) Creates an instance of the CloudAppendBlob class using the specified absolute URI, snapshot ID, and credentials.

Method Summary

Methods

Modifier and Type	Method and Description
void	append(InputStream sourceStream, long length) Appends a stream to an append blob.
void	append(InputStream sourceStream, long length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) Appends a stream to an append blob.
Long	appendBlock(InputStream sourceStream, long length) Commits a new block of data to the end of the blob.
Long	appendBlock(InputStream sourceStream, long length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) Commits a new block of data to the end of the blob.
Long	appendBlockFromURI(URI copySource, Long offset, Long length) Appends a block, using the specified source URL.
Long	appendBlockFromURI(URI copySource, Long offset, Long length, String md5, AccessCondition accessCondition, AccessCondition sourceAccessCondition, BlobRequestOptions options, OperationContext opContext) Appends a block, using the specified source URL.
void	appendFromByteArray(byte[] buffer, int offset, int length) Appends the contents of a byte array to an append blob.This API should be used strictly in a single writer scenario because the API internally uses the append-offset conditional header to avoid duplicate blocks which does not work in a multiple writer scenario.
void	appendFromByteArray(byte[] buffer, int offset, int length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) Appends the contents of a byte array to an append blob.This API should be used strictly in a single writer scenario because the API internally uses the append-offset conditional header to avoid duplicate blocks which does not work in a multiple writer scenario.
void	appendFromFile(String path) Appends a file to an append blob.
void	appendFromFile(String path, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) Appends a file to an append blob.
void	appendText(String content) Appends a string of text to an append blob using the platform's default encoding.
void	appendText(String content, String charsetName, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) Appends a string of text to an append blob using the specified encoding.
void	createOrReplace() Creates an empty append blob.
void	createOrReplace(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) Creates an append blob using the specified request options and operation context.
BlobOutputStream	openWriteExisting() Opens an output stream object to write data to the append blob.
BlobOutputStream	openWriteExisting(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) Opens an output stream object to write data to the append blob, using the specified lease ID, request options and operation context.
BlobOutputStream	openWriteNew() Opens an output stream object to write data to the append blob.
BlobOutputStream	openWriteNew(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) Opens an output stream object to write data to the append blob, using the specified lease ID, request options and operation context.
void	setStreamWriteSizeInBytes(int streamWriteSizeInBytes) Sets the number of bytes to buffer when writing to a BlobOutputStream.
String	startCopy(CloudAppendBlob sourceBlob) Requests the service to start copying a append blob's contents, properties, and metadata to a new append blob.
String	startCopy(CloudAppendBlob sourceBlob, AccessCondition sourceAccessCondition, AccessCondition destinationAccessCondition, BlobRequestOptions options, OperationContext opContext) Requests the service to start copying a append blob's contents, properties, and metadata to a new append blob, using the specified access conditions, lease ID, request options, and operation context.
void	upload(InputStream sourceStream, long length) Uploads the source stream data to the append blob.
void	upload(InputStream sourceStream, long length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) Uploads the source stream data to the append blob using the specified lease ID, request options, and operation context.

Methods inherited from class com.microsoft.azure.storage.blob.CloudBlob

abortCopy, abortCopy, acquireLease, acquireLease, acquireLease, breakLease, breakLease, changeLease, changeLease, createSnapshot, createSnapshot, createSnapshot, delete, delete, deleteIfExists, deleteIfExists, download, download, downloadAccountInfo, downloadAccountInfo, downloadAttributes, downloadAttributes, downloadRange, downloadRange, downloadRangeToByteArray, downloadRangeToByteArray, downloadToByteArray, downloadToByteArray, downloadToFile, downloadToFile, exists, exists, generateSharedAccessSignature, generateSharedAccessSignature, generateSharedAccessSignature, generateSharedAccessSignature, generateUserDelegationSharedAccessSignature, generateUserDelegationSharedAccessSignature, getContainer, getCopyState, getMetadata, getName, getParent, getProperties, getQualifiedStorageUri, getQualifiedUri, getServiceClient, getSnapshotID, getSnapshotQualifiedStorageUri, getSnapshotQualifiedUri, getStorageUri, getStreamMinimumReadSizeInBytes, getStreamWriteSizeInBytes, getUri, isSnapshot, openInputStream, openInputStream, openInputStream, releaseLease, releaseLease, renewLease, renewLease, setMetadata, setStreamMinimumReadSizeInBytes, startCopy, startCopy, undelete, undelete, uploadFromByteArray, uploadFromByteArray, uploadFromFile, uploadFromFile, uploadMetadata, uploadMetadata, uploadProperties, uploadProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloudAppendBlob

public CloudAppendBlob(URI blobAbsoluteUri)
                throws StorageException

Creates an instance of the CloudAppendBlob class using the specified absolute URI and storage service client.

Parameters:

blobAbsoluteUri - A java.net.URI object which represents the absolute URI to the blob.

Throws:

StorageException - If a storage service error occurred.

CloudAppendBlob

public CloudAppendBlob(StorageUri blobAbsoluteUri)
                throws StorageException

Creates an instance of the CloudAppendBlob class using the specified absolute URI and storage service client.

Parameters:

blobAbsoluteUri - A StorageUri object which represents the absolute URI to the blob.

Throws:

StorageException - If a storage service error occurred.

CloudAppendBlob

public CloudAppendBlob(CloudAppendBlob otherBlob)

Creates an instance of the CloudAppendBlob class by copying values from another append blob.

Parameters:

otherBlob - A CloudAppendBlob object which represents the append blob to copy.

CloudAppendBlob

public CloudAppendBlob(URI blobAbsoluteUri,
               StorageCredentials credentials)
                throws StorageException

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

Parameters:

blobAbsoluteUri - A java.net.URI object that represents the absolute URI to the blob.

credentials - A StorageCredentials object used to authenticate access.

Throws:

StorageException - If a storage service error occurred.

CloudAppendBlob

public CloudAppendBlob(URI blobAbsoluteUri,
               String snapshotID,
               StorageCredentials credentials)
                throws StorageException

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

Parameters:

blobAbsoluteUri - A java.net.URI object that represents the absolute URI to the blob.

snapshotID - A String that represents the snapshot version, if applicable.

credentials - A StorageCredentials object used to authenticate access.

Throws:

StorageException - If a storage service error occurred.

CloudAppendBlob

public CloudAppendBlob(StorageUri blobAbsoluteUri,
               StorageCredentials credentials)
                throws StorageException

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

Parameters:

blobAbsoluteUri - A StorageUri object that represents the absolute URI to the blob.

credentials - A StorageCredentials object used to authenticate access.

Throws:

StorageException - If a storage service error occurred.

CloudAppendBlob

public CloudAppendBlob(StorageUri blobAbsoluteUri,
               String snapshotID,
               StorageCredentials credentials)
                throws StorageException

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

Parameters:

blobAbsoluteUri - A StorageUri object that represents the absolute URI to the blob.

snapshotID - A String that represents the snapshot version, if applicable.

credentials - A StorageCredentials object used to authenticate access.

Throws:

StorageException - If a storage service error occurred.

Method Detail

startCopy

@DoesServiceRequest
public final String startCopy(CloudAppendBlob sourceBlob)
                       throws StorageException,
                              URISyntaxException

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

Parameters:

sourceBlob - A CloudAppendBlob object that represents the source blob to copy.

Returns:

A String which represents the copy ID associated with the copy operation.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException

startCopy

@DoesServiceRequest
public final String startCopy(CloudAppendBlob sourceBlob,
                                  AccessCondition sourceAccessCondition,
                                  AccessCondition destinationAccessCondition,
                                  BlobRequestOptions options,
                                  OperationContext opContext)
                       throws StorageException,
                              URISyntaxException

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

Parameters:

sourceBlob - A CloudAppendBlob object that represents the source blob to copy.

sourceAccessCondition - An AccessCondition object that represents the access conditions for the source blob.

destinationAccessCondition - An AccessCondition object that represents the access conditions for the destination blob.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

A String which represents the copy ID associated with the copy operation.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException

createOrReplace

@DoesServiceRequest
public void createOrReplace()
                     throws StorageException

Creates an empty append blob. If the blob already exists, this will replace it.

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

Throws:

StorageException - If a storage service error occurred.

createOrReplace

@DoesServiceRequest
public void createOrReplace(AccessCondition accessCondition,
                                      BlobRequestOptions options,
                                      OperationContext opContext)
                     throws StorageException

Creates an append blob using the specified request options and operation context. If the blob already exists, this will replace it.

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

Parameters:

accessCondition - An AccessCondition object which represents the access conditions for the blob.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

appendBlock

@DoesServiceRequest
public Long appendBlock(InputStream sourceStream,
                                  long length)
                 throws IOException,
                        StorageException

Commits a new block of data to the end of the blob.

Parameters:

sourceStream - An InputStream object that represents the input stream to write to the append blob.

length - A long which represents the length, in bytes, of the stream data, or -1 if unknown.

Returns:

The offset at which the block was appended.

Throws:

IOException - If an I/O exception occurred.

StorageException - If a storage service error occurred.

appendBlock

@DoesServiceRequest
public Long appendBlock(InputStream sourceStream,
                                  long length,
                                  AccessCondition accessCondition,
                                  BlobRequestOptions options,
                                  OperationContext opContext)
                 throws StorageException,
                        IOException

Commits a new block of data to the end of the blob.

Parameters:

sourceStream - An InputStream object that represents the input stream to write to the Append blob.

length - A long which represents the length, in bytes, of the stream data, or -1 if unknown.

accessCondition - An AccessCondition object which represents the access conditions for the blob.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

The offset at which the block was appended.

Throws:

IOException - If an I/O exception occurred.

StorageException - If a storage service error occurred.

appendBlockFromURI

@DoesServiceRequest
public Long appendBlockFromURI(URI copySource,
                                         Long offset,
                                         Long length)
                        throws StorageException

Appends a block, using the specified source URL.

Parameters:

copySource - The URI of the source data. It can point to any Azure Blob or File that is public or the URL can include a shared access signature.

offset - A long which represents the offset to use as the starting point for the source.

length - A Long which represents the number of bytes to copy or null to copy until the end of the blob.

Returns:

The offset at which the block was appended.

Throws:

StorageException - If a storage service error occurred.

appendBlockFromURI

@DoesServiceRequest
public Long appendBlockFromURI(URI copySource,
                                         Long offset,
                                         Long length,
                                         String md5,
                                         AccessCondition accessCondition,
                                         AccessCondition sourceAccessCondition,
                                         BlobRequestOptions options,
                                         OperationContext opContext)
                        throws StorageException

Appends a block, using the specified source URL.

Parameters:

copySource - The URI of the source data. It can point to any Azure Blob or File that is public or the URL can include a shared access signature.

offset - A long which represents the offset to use as the starting point for the source.

length - A Long which represents the number of bytes to copy or null to copy until the end of the blob.

md5 - A String which represents the MD5 caluclated for the range of bytes of the source.

accessCondition - An AccessCondition object which represents the access conditions for the blob.

sourceAccessCondition - An AccessCondition object which represents the access conditions for the source blob.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

The offset at which the block was appended.

Throws:

StorageException - If a storage service error occurred.

append

@DoesServiceRequest
public void append(InputStream sourceStream,
                             long length)
            throws StorageException,
                   IOException

Appends a stream to an append blob. This API should be used strictly in a single writer scenario because the API internally uses the append-offset conditional header to avoid duplicate blocks which does not work in a multiple writer scenario.

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Parameters:

sourceStream - A InputStream object providing the blob content to append.

length - A long which represents the length, in bytes, of the stream data, or -1 if unknown.

Throws:

StorageException - If a storage service error occurred.

IOException - If an I/O exception occurred.

append

@DoesServiceRequest
public void append(InputStream sourceStream,
                             long length,
                             AccessCondition accessCondition,
                             BlobRequestOptions options,
                             OperationContext opContext)
            throws StorageException,
                   IOException

Appends a stream to an append blob. This API should be used strictly in a single writer scenario because the API internally uses the append-offset conditional header to avoid duplicate blocks which does not work in a multiple writer scenario.

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Parameters:

sourceStream - A InputStream object providing the blob content to append.

length - A long which represents the length, in bytes, of the stream data, or -1 if unknown.

accessCondition - An AccessCondition object which represents the access conditions for the blob.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

IOException - If an I/O exception occurred.

appendFromByteArray

public void appendFromByteArray(byte[] buffer,
                       int offset,
                       int length)
                         throws StorageException,
                                IOException

Appends the contents of a byte array to an append blob.This API should be used strictly in a single writer scenario because the API internally uses the append-offset conditional header to avoid duplicate blocks which does not work in a multiple writer scenario.

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Parameters:

buffer - A byte array which represents the data to append to the blob.

offset - A int which represents the offset of the byte array from which to start the data upload.

length - An int which represents the number of bytes to upload from the input buffer.

Throws:

StorageException - If a storage service error occurred.

IOException - If an I/O exception occurred.

appendFromByteArray

public void appendFromByteArray(byte[] buffer,
                       int offset,
                       int length,
                       AccessCondition accessCondition,
                       BlobRequestOptions options,
                       OperationContext opContext)
                         throws StorageException,
                                IOException

Appends the contents of a byte array to an append blob.This API should be used strictly in a single writer scenario because the API internally uses the append-offset conditional header to avoid duplicate blocks which does not work in a multiple writer scenario.

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Parameters:

buffer - A byte array which represents the data to append to the blob.

offset - A int which represents the offset of the byte array from which to start the data upload.

length - An int which represents the number of bytes to upload from the input buffer.

accessCondition - An AccessCondition object that represents the access conditions for the blob.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

IOException - If an I/O exception occurred.

appendFromFile

public void appendFromFile(String path)
                    throws StorageException,
                           IOException

Appends a file to an append blob. This API should be used strictly in a single writer scenario because the API internally uses the append-offset conditional header to avoid duplicate blocks which does not work in a multiple writer scenario.

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Parameters:

path - A String which represents the path to the file to be appended.

Throws:

StorageException - If a storage service error occurred.

IOException - If an I/O exception occurred.

appendFromFile

public void appendFromFile(String path,
                  AccessCondition accessCondition,
                  BlobRequestOptions options,
                  OperationContext opContext)
                    throws StorageException,
                           IOException

Appends a file to an append blob. This API should be used strictly in a single writer scenario because the API internally uses the append-offset conditional header to avoid duplicate blocks which does not work in a multiple writer scenario.

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Parameters:

path - A String which represents the path to the file to be appended.

accessCondition - An AccessCondition object that represents the access conditions for the blob.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

IOException - If an I/O exception occurred.

appendText

public void appendText(String content)
                throws StorageException,
                       IOException

Appends a string of text to an append blob using the platform's default encoding. This API should be used strictly in a single writer scenario because the API internally uses the append-offset conditional header to avoid duplicate blocks which does not work in a multiple writer scenario.

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Parameters:

content - A String which represents the content that will be appended to the blob.

Throws:

StorageException - If a storage service error occurred.

IOException - If an I/O exception occurred.

appendText

public void appendText(String content,
              String charsetName,
              AccessCondition accessCondition,
              BlobRequestOptions options,
              OperationContext opContext)
                throws StorageException,
                       IOException

Appends a string of text to an append blob using the specified encoding. This API should be used strictly in a single writer scenario because the API internally uses the append-offset conditional header to avoid duplicate blocks which does not work in a multiple writer scenario.

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Parameters:

content - A String which represents the content that will be appended to the blob.

charsetName - A String which represents the name of the charset to use to encode the content. If null, the platform's default encoding is used.

accessCondition - An AccessCondition object that represents the access conditions for the blob.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

IOException - If an I/O exception occurred.

openWriteExisting

@DoesServiceRequest
public BlobOutputStream openWriteExisting()
                                   throws StorageException

Opens an output stream object to write data to the append blob. The append blob must already exist and will be appended to.

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Returns:

A BlobOutputStream object used to write data to the blob.

Throws:

StorageException - If a storage service error occurred.

openWriteExisting

@DoesServiceRequest
public BlobOutputStream openWriteExisting(AccessCondition accessCondition,
                                                    BlobRequestOptions options,
                                                    OperationContext opContext)
                                   throws StorageException

Opens an output stream object to write data to the append blob, using the specified lease ID, request options and operation context. The append blob must already exist and will be appended to.

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Parameters:

accessCondition - An AccessCondition object which represents the access conditions for the blob.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

A BlobOutputStream object used to write data to the blob.

Throws:

StorageException - If a storage service error occurred.

openWriteNew

@DoesServiceRequest
public BlobOutputStream openWriteNew()
                              throws StorageException

Opens an output stream object to write data to the append blob. The append blob does not need to yet exist. If the blob already exists, this will replace it.

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

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Returns:

A BlobOutputStream object used to write data to the blob.

Throws:

StorageException - If a storage service error occurred.

openWriteNew

@DoesServiceRequest
public BlobOutputStream openWriteNew(AccessCondition accessCondition,
                                               BlobRequestOptions options,
                                               OperationContext opContext)
                              throws StorageException

Opens an output stream object to write data to the append blob, using the specified lease ID, request options and operation context. The append blob does not need to yet exist. If the blob already exists, this will replace it.

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

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Parameters:

accessCondition - An AccessCondition object which represents the access conditions for the blob.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

A BlobOutputStream object used to write data to the blob.

Throws:

StorageException - If a storage service error occurred.

upload

@DoesServiceRequest
public void upload(InputStream sourceStream,
                             long length)
            throws StorageException,
                   IOException

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

If you want to append data to an already existing blob, please see appendBlock(InputStream, long).

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Specified by:

upload in class CloudBlob

Parameters:

sourceStream - An InputStream object to read from.

length - A long which represents the length, in bytes, of the stream data, or -1 if unknown.

Throws:

IOException - If an I/O exception occurred.

StorageException - If a storage service error occurred.

upload

@DoesServiceRequest
public void upload(InputStream sourceStream,
                             long length,
                             AccessCondition accessCondition,
                             BlobRequestOptions options,
                             OperationContext opContext)
            throws StorageException,
                   IOException

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

If you want to append data to an already existing blob, please see appendBlock(InputStream, long).

If you are doing writes in a single writer scenario, please look at BlobRequestOptions.setAbsorbConditionalErrorsOnRetry(Boolean) and see if setting this flag to true is acceptable for you.

Specified by:

upload in class CloudBlob

Parameters:

sourceStream - An InputStream object to read from.

length - A long which represents the length, in bytes, of the stream data, or -1 if unknown.

accessCondition - An AccessCondition object which represents the access conditions for the blob.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

IOException - If an I/O exception occurred.

StorageException - If a storage service error occurred.

setStreamWriteSizeInBytes

public void setStreamWriteSizeInBytes(int streamWriteSizeInBytes)

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

Specified by:

setStreamWriteSizeInBytes in class CloudBlob

Parameters:

streamWriteSizeInBytes - An int which represents the maximum block size, in bytes, for writing to an append blob while using a BlobOutputStream object, ranging from 16 KB to 4 MB, inclusive.

Throws:

IllegalArgumentException - If streamWriteSizeInBytes is less than 16 KB or greater than 4 MB.