com.microsoft.azure.storage.blob

Class AppendBlobURL

java.lang.Object

com.microsoft.azure.storage.blob.StorageURL

com.microsoft.azure.storage.blob.BlobURL

com.microsoft.azure.storage.blob.AppendBlobURL

public final class AppendBlobURL
extends BlobURL

Represents a URL to an append blob. It may be obtained by direct construction or via the create method on a ContainerURL object. This class does not hold any state about a particular append blob but is instead a convenient way of sending off appropriate requests to the resource on the service. Please refer to the Azure Docs

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_APPEND_BLOCK_BYTES Indicates the maximum number of bytes that can be sent in a call to appendBlock.
static int	MAX_BLOCKS Indicates the maximum number of blocks allowed in an append blob.

Fields inherited from class com.microsoft.azure.storage.blob.StorageURL

storageClient

Constructor Summary

Constructors

Constructor and Description
AppendBlobURL(URL url, com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a AppendBlobURL object pointing to the account specified by the URL and using the provided pipeline to make HTTP requests.

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<AppendBlobAppendBlockResponse>	appendBlock(io.reactivex.Flowable<ByteBuffer> data, long length) Commits a new block of data to the end of the existing append blob.
io.reactivex.Single<AppendBlobAppendBlockResponse>	appendBlock(io.reactivex.Flowable<ByteBuffer> data, long length, AppendBlobAccessConditions appendBlobAccessConditions, com.microsoft.rest.v2.Context context) Commits a new block of data to the end of the existing append blob.
io.reactivex.Single<AppendBlobAppendBlockFromUrlResponse>	appendBlockFromUrl(URL sourceURL, BlobRange sourceRange) Commits a new block of data from another blob to the end of this append blob.
io.reactivex.Single<AppendBlobAppendBlockFromUrlResponse>	appendBlockFromUrl(URL sourceURL, BlobRange sourceRange, byte[] sourceContentMD5, AppendBlobAccessConditions destAccessConditions, SourceModifiedAccessConditions sourceAccessConditions, com.microsoft.rest.v2.Context context) Commits a new block of data from another blob to the end of this append blob.
io.reactivex.Single<AppendBlobCreateResponse>	create() Creates a 0-length append blob.
io.reactivex.Single<AppendBlobCreateResponse>	create(BlobHTTPHeaders headers, Metadata metadata, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context) Creates a 0-length append blob.
AppendBlobURL	withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a new AppendBlobURL with the given pipeline.
AppendBlobURL	withSnapshot(String snapshot) Creates a new AppendBlobURL with the given snapshot.

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

abortCopyFromURL, abortCopyFromURL, acquireLease, acquireLease, breakLease, breakLease, changeLease, changeLease, createSnapshot, createSnapshot, delete, delete, download, download, getAccountInfo, getAccountInfo, getProperties, getProperties, releaseLease, releaseLease, renewLease, renewLease, setHTTPHeaders, setHTTPHeaders, setMetadata, setMetadata, setTier, setTier, startCopyFromURL, startCopyFromURL, syncCopyFromURL, syncCopyFromURL, toAppendBlobURL, toBlockBlobURL, toPageBlobURL, undelete, undelete

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

appendToURLPath, createPipeline, createPipeline, createPipeline, createPipeline, toString, toURL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAX_APPEND_BLOCK_BYTES

public static final int MAX_APPEND_BLOCK_BYTES

Indicates the maximum number of bytes that can be sent in a call to appendBlock.

See Also:

Constant Field Values

MAX_BLOCKS

public static final int MAX_BLOCKS

Indicates the maximum number of blocks allowed in an append blob.

See Also:

Constant Field Values

Constructor Detail

AppendBlobURL

public AppendBlobURL(URL url,
                     com.microsoft.rest.v2.http.HttpPipeline pipeline)

Creates a AppendBlobURL object pointing to the account specified by the URL and using the provided pipeline to make HTTP requests.

Parameters:

url - A URL to an Azure Storage append blob.

pipeline - A HttpPipeline which configures the behavior of HTTP exchanges. Please refer to StorageURL.createPipeline(ICredentials, PipelineOptions) for more information.

Method Detail

withPipeline

public AppendBlobURL withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline)

Creates a new AppendBlobURL with the given pipeline.

Overrides:

withPipeline in class BlobURL

Parameters:

pipeline - An HttpPipeline object to process HTTP transactions.

Returns:

An AppendBlobURL object with the given pipeline.

withSnapshot

public AppendBlobURL withSnapshot(String snapshot)
                           throws MalformedURLException,
                                  UnknownHostException

Creates a new AppendBlobURL with the given snapshot.

Overrides:

withSnapshot in class BlobURL

Parameters:

snapshot - A String of the snapshot identifier.

Returns:

An AppendBlobURL object with the given pipeline.

Throws:

MalformedURLException - Appending the specified snapshot produced an invalid URL.

UnknownHostException - If the url contains an improperly formatted ipaddress or unknown host address.

create

public io.reactivex.Single<AppendBlobCreateResponse> create()

Creates a 0-length append blob. Call AppendBlock to append data to an append blob. For more information, see the Azure Docs.

Returns:

Emits the successful response.

create

public io.reactivex.Single<AppendBlobCreateResponse> create(BlobHTTPHeaders headers,
                                                            Metadata metadata,
                                                            BlobAccessConditions accessConditions,
                                                            com.microsoft.rest.v2.Context context)

Creates a 0-length append blob. Call AppendBlock to append data to an append blob. For more information, see the Azure Docs.

Parameters:

headers - BlobHTTPHeaders

metadata - Metadata

accessConditions - BlobAccessConditions

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

appendBlock

public io.reactivex.Single<AppendBlobAppendBlockResponse> appendBlock(io.reactivex.Flowable<ByteBuffer> data,
                                                                      long length)

Commits a new block of data to the end of the existing append blob. For more information, see the Azure Docs.

Note that the data passed must be replayable if retries are enabled (the default). In other words, the Flowable must produce the same data each time it is subscribed to.

Parameters:

data - The data to write to the blob. Note that this Flowable must be replayable if retries are enabled (the default). In other words, the Flowable must produce the same data each time it is subscribed to.

length - The exact length of the data. It is important that this value match precisely the length of the data emitted by the Flowable.

Returns:

Emits the successful response.

appendBlock

public io.reactivex.Single<AppendBlobAppendBlockResponse> appendBlock(io.reactivex.Flowable<ByteBuffer> data,
                                                                      long length,
                                                                      AppendBlobAccessConditions appendBlobAccessConditions,
                                                                      com.microsoft.rest.v2.Context context)

Commits a new block of data to the end of the existing append blob. For more information, see the Azure Docs.

Note that the data passed must be replayable if retries are enabled (the default). In other words, the Flowable must produce the same data each time it is subscribed to.

Parameters:

data - The data to write to the blob. Note that this Flowable must be replayable if retries are enabled (the default). In other words, the Flowable must produce the same data each time it is subscribed to.

length - The exact length of the data. It is important that this value match precisely the length of the data emitted by the Flowable.

appendBlobAccessConditions - AppendBlobAccessConditions

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

appendBlockFromUrl

public io.reactivex.Single<AppendBlobAppendBlockFromUrlResponse> appendBlockFromUrl(URL sourceURL,
                                                                                    BlobRange sourceRange)

Commits a new block of data from another blob to the end of this append blob. For more information, see the Azure Docs.

Parameters:

sourceURL - The url to the blob that will be the source of the copy. A source blob in the same storage account can be authenticated via Shared Key. However, if the source is a blob in another account, the source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation.

sourceRange - The source BlobRange to copy.

Returns:

Emits the successful response.

appendBlockFromUrl

public io.reactivex.Single<AppendBlobAppendBlockFromUrlResponse> appendBlockFromUrl(URL sourceURL,
                                                                                    BlobRange sourceRange,
                                                                                    byte[] sourceContentMD5,
                                                                                    AppendBlobAccessConditions destAccessConditions,
                                                                                    SourceModifiedAccessConditions sourceAccessConditions,
                                                                                    com.microsoft.rest.v2.Context context)

Commits a new block of data from another blob to the end of this append blob. For more information, see the Azure Docs.

Parameters:

sourceURL - The url to the blob that will be the source of the copy. A source blob in the same storage account can be authenticated via Shared Key. However, if the source is a blob in another account, the source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation.

sourceRange - BlobRange

sourceContentMD5 - An MD5 hash of the block content from the source blob. If specified, the service will calculate the MD5 of the received data and fail the request if it does not match the provided MD5.

destAccessConditions - AppendBlobAccessConditions

sourceAccessConditions - SourceModifiedAccessConditions

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.