com.microsoft.azure.storage.blob

Class BlockBlobURL

java.lang.Object

com.microsoft.azure.storage.blob.StorageURL

com.microsoft.azure.storage.blob.BlobURL

com.microsoft.azure.storage.blob.BlockBlobURL

public final class BlockBlobURL
extends BlobURL

Represents a URL to a block blob.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_BLOCKS Indicates the maximum number of blocks allowed in a block blob.
static int	MAX_PUT_BLOB_BYTES Indicates the maximum number of bytes that can be sent in a call to putBlob.
static int	MAX_PUT_BLOCK_BYTES Indicates the maximum number of bytes that can be sent in a call to putBlock.

Constructor Summary

Constructors

Constructor and Description
BlockBlobURL(java.net.URL url, com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a new BlockBlobURL object.

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlockBlobGetBlockListHeaders,BlockList>>	getBlockList(BlockListType listType, LeaseAccessConditions leaseAccessConditions) Returns the list of blocks that have been uploaded as part of a block blob using the specified block list filter.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobPutHeaders,java.lang.Void>>	putBlob(io.reactivex.Flowable<java.nio.ByteBuffer> data, long length, BlobHTTPHeaders headers, Metadata metadata, BlobAccessConditions accessConditions) Creates a new block blob, or updates the content of an existing block blob.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlockBlobPutBlockHeaders,java.lang.Void>>	putBlock(java.lang.String base64BlockID, io.reactivex.Flowable<java.nio.ByteBuffer> data, long length, LeaseAccessConditions leaseAccessConditions) Uploads the specified block to the block blob's "staging area" to be later commited by a call to PutBlockList.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlockBlobPutBlockListHeaders,java.lang.Void>>	putBlockList(java.util.List<java.lang.String> base64BlockIDs, BlobHTTPHeaders headers, Metadata metadata, BlobAccessConditions accessConditions) Writes a blob by specifying the list of block IDs that make up the blob.
BlockBlobURL	withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a new BlockBlobURL with the given pipeline.
BlockBlobURL	withSnapshot(java.lang.String snapshot) Creates a new BlockBlobURL with the given snapshot.

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

abortCopy, acquireLease, breakLease, changeLease, createSnapshot, delete, getBlob, getPropertiesAndMetadata, releaseLease, renewLease, setMetadata, setProperties, startCopy, toAppendBlobURL, toBlockBlobURL, toPageBlobURL

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

createPipeline, toString, toURL

Methods inherited from class java.lang.Object

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

Field Detail

MAX_PUT_BLOB_BYTES

public static final int MAX_PUT_BLOB_BYTES

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

See Also:

Constant Field Values

MAX_PUT_BLOCK_BYTES

public static final int MAX_PUT_BLOCK_BYTES

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

See Also:

Constant Field Values

MAX_BLOCKS

public static final int MAX_BLOCKS

Indicates the maximum number of blocks allowed in a block blob.

See Also:

Constant Field Values

Constructor Detail

BlockBlobURL

public BlockBlobURL(java.net.URL url,
                    com.microsoft.rest.v2.http.HttpPipeline pipeline)

Creates a new BlockBlobURL object.

Parameters:

url - A java.net.URL to a block blob.

pipeline - An HttpPipeline for sending requests.

Method Detail

withPipeline

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

Creates a new BlockBlobURL with the given pipeline.

Overrides:

withPipeline in class BlobURL

Parameters:

pipeline - An HttpPipeline object to set.

Returns:

A BlockBlobURL object with the given pipeline.

withSnapshot

public BlockBlobURL withSnapshot(java.lang.String snapshot)
                          throws java.net.MalformedURLException,
                                 java.net.UnknownHostException

Creates a new BlockBlobURL with the given snapshot.

Overrides:

withSnapshot in class BlobURL

Parameters:

snapshot - A String of the snapshot identifier.

Returns:

A BlockBlobURL object with the given pipeline.

Throws:

java.net.MalformedURLException

java.net.UnknownHostException

putBlob

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobPutHeaders,java.lang.Void>> putBlob(io.reactivex.Flowable<java.nio.ByteBuffer> data,
                                                                                                      long length,
                                                                                                      BlobHTTPHeaders headers,
                                                                                                      Metadata metadata,
                                                                                                      BlobAccessConditions accessConditions)

Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with PutBlob; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, use PutBlock and PutBlockList. For more information, see https://docs.microsoft.com/rest/api/storageservices/put-blob.

Parameters:

data - A Flowable emitting ByteBuffer which contain the data to write to the blob.

length - A long indicating how long the data is.

headers - A BlobHTTPHeaders object that specifies which properties to set on the blob.

metadata - A Metadata object that specifies key value pairs to set on the blob.

accessConditions - A BlobAccessConditions object that specifies under which conditions the operation should complete.

Returns:

The Single which emits a RestResponse containing the BlobPutHeaders and a Void body if successful.

putBlock

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlockBlobPutBlockHeaders,java.lang.Void>> putBlock(java.lang.String base64BlockID,
                                                                                                                 io.reactivex.Flowable<java.nio.ByteBuffer> data,
                                                                                                                 long length,
                                                                                                                 LeaseAccessConditions leaseAccessConditions)

Uploads the specified block to the block blob's "staging area" to be later commited by a call to PutBlockList. For more information, see https://docs.microsoft.com/rest/api/storageservices/put-block.

Parameters:

base64BlockID - A Base64 encoded String that specifies the ID for this block.

data - A Flowable of ByteBuffer which contains the data to write to the block.

length - A long indicating how long the data is.

leaseAccessConditions - A LeaseAccessConditions object that specifies the lease on the blob if there is one.

Returns:

The Single which emits a RestResponse containing the BlockBlobPutBlockHeaders and a Void body if successful.

getBlockList

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlockBlobGetBlockListHeaders,BlockList>> getBlockList(BlockListType listType,
                                                                                                                    LeaseAccessConditions leaseAccessConditions)

Returns the list of blocks that have been uploaded as part of a block blob using the specified block list filter. For more information, see https://docs.microsoft.com/rest/api/storageservices/get-block-list.

Parameters:

listType - A BlockListType value specifies which type of blocks to return.

leaseAccessConditions - A LeaseAccessConditions object that specifies the lease on the blob if there is one.

Returns:

The Single which emits a RestResponse containing the BlockBlobGetBlockListHeaders and a BlockList body if successful.

putBlockList

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlockBlobPutBlockListHeaders,java.lang.Void>> putBlockList(java.util.List<java.lang.String> base64BlockIDs,
                                                                                                                         BlobHTTPHeaders headers,
                                                                                                                         Metadata metadata,
                                                                                                                         BlobAccessConditions accessConditions)

Writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior PutBlock operation. You can call PutBlockList to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. Any blocks not specified in the block list and permanently deleted. For more information, see https://docs.microsoft.com/rest/api/storageservices/put-block-list.

Parameters:

base64BlockIDs - A java.util.List of base64 String that specifies the block IDs to be committed.

headers - A BlobHTTPHeaders object that specifies which properties to set on the blob.

metadata - A Metadata object that specifies key value pairs to set on the blob.

accessConditions - A BlobAccessConditions object that specifies under which conditions the operation should complete.

Returns:

The Single which emits a RestResponse containing the BlockBlobPutBlockListHeaders and a Void body if successful.