com.microsoft.azure.storage.blob

Class BlobURL

java.lang.Object

com.microsoft.azure.storage.blob.StorageURL

com.microsoft.azure.storage.blob.BlobURL

Direct Known Subclasses:

AppendBlobURL, BlockBlobURL, PageBlobURL

public class BlobURL
extends StorageURL

Represents a URL to an Azure Storage blob; the blob may be a block blob, append blob, or page blob.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobAbortCopyHeaders,java.lang.Void>>	abortCopy(java.lang.String copyId, LeaseAccessConditions leaseAccessConditions) Stops a pending copy that was previously started and leaves a destination blob with 0 length and metadata.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobLeaseHeaders,java.lang.Void>>	acquireLease(java.lang.String proposedID, int duration, HTTPAccessConditions httpAccessConditions) Acquires a lease on the blob for write and delete operations.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobLeaseHeaders,java.lang.Void>>	breakLease(java.lang.Integer breakPeriodInSeconds, HTTPAccessConditions httpAccessConditions) BreakLease breaks the blob's previously-acquired lease (if it exists).
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobLeaseHeaders,java.lang.Void>>	changeLease(java.lang.String leaseId, java.lang.String proposedID, HTTPAccessConditions httpAccessConditions) ChangeLease changes the blob's lease ID.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobTakeSnapshotHeaders,java.lang.Void>>	createSnapshot(Metadata metadata, BlobAccessConditions accessConditions) Creates a read-only snapshot of a blob.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobDeleteHeaders,java.lang.Void>>	delete(DeleteSnapshotsOptionType deleteBlobSnapshotOptions, BlobAccessConditions accessConditions) Deletes the specified blob or snapshot.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobGetHeaders,io.reactivex.Flowable<java.nio.ByteBuffer>>>	getBlob(BlobRange range, BlobAccessConditions accessConditions, boolean rangeGetContentMD5) Reads a range of bytes from a blob.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobGetPropertiesHeaders,java.lang.Void>>	getPropertiesAndMetadata(BlobAccessConditions accessConditions) Returns the blob's metadata and properties.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobLeaseHeaders,java.lang.Void>>	releaseLease(java.lang.String leaseID, HTTPAccessConditions httpAccessConditions) Releases the blob's previously-acquired lease.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobLeaseHeaders,java.lang.Void>>	renewLease(java.lang.String leaseID, HTTPAccessConditions httpAccessConditions) Renews the blob's previously-acquired lease.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobSetMetadataHeaders,java.lang.Void>>	setMetadata(Metadata metadata, BlobAccessConditions accessConditions) Changes a blob's metadata.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobSetPropertiesHeaders,java.lang.Void>>	setProperties(BlobHTTPHeaders headers, BlobAccessConditions accessConditions) Changes a blob's HTTP header properties.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobCopyHeaders,java.lang.Void>>	startCopy(java.net.URL sourceURL, Metadata metadata, BlobAccessConditions sourceAccessConditions, BlobAccessConditions destAccessConditions) Copies the data at the source URL to a blob.
AppendBlobURL	toAppendBlobURL() Converts this BlobURL to an AppendBlobURL object.
BlockBlobURL	toBlockBlobURL() Converts this BlobURL to a BlockBlobURL object.
PageBlobURL	toPageBlobURL() Converts this BlobURL to a PageBlobURL object.
BlobURL	withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a new BlobURL with the given pipeline.
BlobURL	withSnapshot(java.lang.String snapshot) Creates a new BlobURL with the given snapshot.

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

Constructor Detail

BlobURL

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

Creates a new BlobURL object.

Parameters:

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

pipeline - An HttpPipeline for sending requests.

Method Detail

withPipeline

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

Creates a new BlobURL with the given pipeline.

Parameters:

pipeline - An HttpPipeline object to set.

Returns:

A BlobURL object with the given pipeline.

withSnapshot

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

Creates a new BlobURL with the given snapshot.

Parameters:

snapshot - A String to set.

Returns:

A BlobURL object with the given pipeline.

Throws:

java.net.MalformedURLException

java.net.UnknownHostException

toBlockBlobURL

public BlockBlobURL toBlockBlobURL()

Converts this BlobURL to a BlockBlobURL object. Note that this does not change the actual type of the blob if it has already been created.

Returns:

A BlockBlobURL object.

toAppendBlobURL

public AppendBlobURL toAppendBlobURL()

Converts this BlobURL to an AppendBlobURL object. Note that this does not change the actual type of the blob if it has already been created.

Returns:

An AppendBlobURL object.

toPageBlobURL

public PageBlobURL toPageBlobURL()

Converts this BlobURL to a PageBlobURL object. Note that this does not change the actual type of the blob if it has already been created.

Returns:

A PageBlobURL object.

startCopy

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobCopyHeaders,java.lang.Void>> startCopy(java.net.URL sourceURL,
                                                                                                         Metadata metadata,
                                                                                                         BlobAccessConditions sourceAccessConditions,
                                                                                                         BlobAccessConditions destAccessConditions)

Copies the data at the source URL to a blob. For more information, see https://docs.microsoft.com/rest/api/storageservices/copy-blob.

Parameters:

sourceURL - A java.net.URL representing the source URL to copy from. URLs outside of Azure may only be copied to block blobs.

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

sourceAccessConditions - BlobAccessConditions object to check against the source

destAccessConditions - BlobAccessConditions object to check against the destination

Returns:

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

abortCopy

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobAbortCopyHeaders,java.lang.Void>> abortCopy(java.lang.String copyId,
                                                                                                              LeaseAccessConditions leaseAccessConditions)

Stops a pending copy that was previously started and leaves a destination blob with 0 length and metadata. For more information, see https://docs.microsoft.com/rest/api/storageservices/abort-copy-blob.

Parameters:

copyId - A String representing the copy identifier provided in the x-ms-copy-id header of the original Copy Blob operation.

leaseAccessConditions - LeaseAccessConditions object representing lease access conditions

Returns:

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

getBlob

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobGetHeaders,io.reactivex.Flowable<java.nio.ByteBuffer>>> getBlob(BlobRange range,
                                                                                                                                  BlobAccessConditions accessConditions,
                                                                                                                                  boolean rangeGetContentMD5)

Reads a range of bytes from a blob. The response also includes the blob's properties and metadata. For more information, see https://docs.microsoft.com/rest/api/storageservices/get-blob.

Parameters:

range - A BlobRange which bytes to read.

accessConditions - A BlobAccessConditions object that represents the access conditions for the blob.

rangeGetContentMD5 - A boolean indicating if the contentMD5 for the specified blob range should be returned.

Returns:

The Single which emits a RestResponse object containing the BlobGetHeaders and a Flowable which emits ByteBuffer as the body if successful.

delete

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobDeleteHeaders,java.lang.Void>> delete(DeleteSnapshotsOptionType deleteBlobSnapshotOptions,
                                                                                                        BlobAccessConditions accessConditions)

Deletes the specified blob or snapshot. Note that deleting a blob also deletes all its snapshots. For more information, see https://docs.microsoft.com/rest/api/storageservices/delete-blob.

Parameters:

deleteBlobSnapshotOptions - A DeleteSnapshotsOptionType which represents delete snapshot options.

accessConditions - A BlobAccessConditions object that represents the access conditions for the blob.

Returns:

A Single which emits a RestResponse object containing the BlobDeleteHeaders and a Void body if successful.

getPropertiesAndMetadata

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobGetPropertiesHeaders,java.lang.Void>> getPropertiesAndMetadata(BlobAccessConditions accessConditions)

Returns the blob's metadata and properties. For more information, see https://docs.microsoft.com/rest/api/storageservices/get-blob-properties.

Parameters:

accessConditions - A BlobAccessConditions object that represents the access conditions for the blob.

Returns:

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

setProperties

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobSetPropertiesHeaders,java.lang.Void>> setProperties(BlobHTTPHeaders headers,
                                                                                                                      BlobAccessConditions accessConditions)

Changes a blob's HTTP header properties. For more information, see https://docs.microsoft.com/rest/api/storageservices/set-blob-properties.

Parameters:

headers - A BlobHTTPHeaders object that specifies which properties 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 object containing the BlobSetPropertiesHeaders and a Void body if successful.

setMetadata

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobSetMetadataHeaders,java.lang.Void>> setMetadata(Metadata metadata,
                                                                                                                  BlobAccessConditions accessConditions)

Changes a blob's metadata. https://docs.microsoft.com/rest/api/storageservices/set-blob-metadata.

Parameters:

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 object containing the BlobSetMetadataHeaders and a Void body if successful.

createSnapshot

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobTakeSnapshotHeaders,java.lang.Void>> createSnapshot(Metadata metadata,
                                                                                                                      BlobAccessConditions accessConditions)

Creates a read-only snapshot of a blob. For more information, see https://docs.microsoft.com/rest/api/storageservices/snapshot-blob.

Parameters:

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

accessConditions - A BlobAccessConditions object that represents the access conditions for the blob.

Returns:

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

acquireLease

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobLeaseHeaders,java.lang.Void>> acquireLease(java.lang.String proposedID,
                                                                                                             int duration,
                                                                                                             HTTPAccessConditions httpAccessConditions)

Acquires a lease on the blob for write and delete operations. The lease duration must be between 15 to 60 seconds, or infinite (-1). For more information, see https://docs.microsoft.com/rest/api/storageservices/lease-blob.

Parameters:

proposedID - A String in any valid GUID format.

duration - A Integer specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds.

httpAccessConditions - A HTTPAccessConditions object that represents HTTP access conditions.

Returns:

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

renewLease

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobLeaseHeaders,java.lang.Void>> renewLease(java.lang.String leaseID,
                                                                                                           HTTPAccessConditions httpAccessConditions)

Renews the blob's previously-acquired lease. For more information, see https://docs.microsoft.com/rest/api/storageservices/lease-blob.

Parameters:

leaseID - A String representing the lease on the blob.

httpAccessConditions - A HTTPAccessConditions object that represents HTTP access conditions.

Returns:

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

releaseLease

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobLeaseHeaders,java.lang.Void>> releaseLease(java.lang.String leaseID,
                                                                                                             HTTPAccessConditions httpAccessConditions)

Releases the blob's previously-acquired lease. For more information, see https://docs.microsoft.com/rest/api/storageservices/lease-blob.

Parameters:

leaseID - A String representing the lease on the blob.

httpAccessConditions - A HTTPAccessConditions object that represents HTTP access conditions.

Returns:

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

breakLease

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobLeaseHeaders,java.lang.Void>> breakLease(java.lang.Integer breakPeriodInSeconds,
                                                                                                           HTTPAccessConditions httpAccessConditions)

BreakLease breaks the blob's previously-acquired lease (if it exists). Pass the LeaseBreakDefault (-1) constant to break a fixed-duration lease when it expires or an infinite lease immediately. For more information, see https://docs.microsoft.com/rest/api/storageservices/lease-blob.

Parameters:

breakPeriodInSeconds - An optional Integer representing the proposed duration of seconds that the lease should continue before it is broken, between 0 and 60 seconds. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period

httpAccessConditions - A HTTPAccessConditions object that represents HTTP access conditions.

Returns:

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

changeLease

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobLeaseHeaders,java.lang.Void>> changeLease(java.lang.String leaseId,
                                                                                                            java.lang.String proposedID,
                                                                                                            HTTPAccessConditions httpAccessConditions)

ChangeLease changes the blob's lease ID. For more information, see https://docs.microsoft.com/rest/api/storageservices/lease-blob.

Parameters:

leaseId - A String representing the lease ID to change.

proposedID - A String in any valid GUID format.

httpAccessConditions - A HTTPAccessConditions object that represents HTTP access conditions.

Returns:

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