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 a blob of any type: block, append, or page. 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 blob but is instead a convenient way of sending off appropriate requests to the resource on the service. Please refer to the Azure Docs for more information.

Field Summary

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

storageClient

Constructor Summary

Constructors

Constructor and Description
BlobURL(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<BlobsAbortCopyFromURLResponse>	abortCopyFromURL(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<BlobsAcquireLeaseResponse>	acquireLease(String proposedID, int duration, HTTPAccessConditions httpAccessConditions) Acquires a lease on the blob for write and delete operations.
io.reactivex.Single<BlobsBreakLeaseResponse>	breakLease(Integer breakPeriodInSeconds, HTTPAccessConditions httpAccessConditions) BreakLease breaks the blob's previously-acquired lease (if it exists).
io.reactivex.Single<BlobsChangeLeaseResponse>	changeLease(String leaseId, String proposedID, HTTPAccessConditions httpAccessConditions) ChangeLease changes the blob's lease ID.
io.reactivex.Single<BlobsCreateSnapshotResponse>	createSnapshot(Metadata metadata, BlobAccessConditions accessConditions) Creates a read-only snapshot of a blob.
io.reactivex.Single<BlobsDeleteResponse>	delete(DeleteSnapshotsOptionType deleteBlobSnapshotOptions, BlobAccessConditions accessConditions) Deletes the specified blob or snapshot.
io.reactivex.Single<BlobsDownloadResponse>	download(BlobRange range, BlobAccessConditions accessConditions, boolean rangeGetContentMD5) Reads a range of bytes from a blob.
io.reactivex.Single<BlobsGetPropertiesResponse>	getProperties(BlobAccessConditions accessConditions) Returns the blob's metadata and properties.
io.reactivex.Single<BlobsReleaseLeaseResponse>	releaseLease(String leaseID, HTTPAccessConditions httpAccessConditions) Releases the blob's previously-acquired lease.
io.reactivex.Single<BlobsRenewLeaseResponse>	renewLease(String leaseID, HTTPAccessConditions httpAccessConditions) Renews the blob's previously-acquired lease.
io.reactivex.Single<BlobsSetHTTPHeadersResponse>	setHTTPHeaders(BlobHTTPHeaders headers, BlobAccessConditions accessConditions) Changes a blob's HTTP header properties.
io.reactivex.Single<BlobsSetMetadataResponse>	setMetadata(Metadata metadata, BlobAccessConditions accessConditions) Changes a blob's metadata.
io.reactivex.Single<BlobsStartCopyFromURLResponse>	startCopyFromURL(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(String snapshot) Creates a new BlobURL with the given snapshot.

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

appendToURLPath, createPipeline, toString, toURL

Methods inherited from class java.lang.Object

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

Constructor Detail

BlobURL

public BlobURL(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(String snapshot)
                     throws MalformedURLException,
                            UnknownHostException

Creates a new BlobURL with the given snapshot.

Parameters:

snapshot - A String to set.

Returns:

A BlobURL 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.

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.

startCopyFromURL

public io.reactivex.Single<BlobsStartCopyFromURLResponse> startCopyFromURL(URL sourceURL,
                                                                           Metadata metadata,
                                                                           BlobAccessConditions sourceAccessConditions,
                                                                           BlobAccessConditions destAccessConditions)

Copies the data at the source URL to a blob. For more information, see the Azure Docs

Parameters:

sourceURL - The source URL to copy from. URLs outside of Azure may only be copied to block blobs.

metadata - Metadata

sourceAccessConditions - BlobAccessConditions against the source.

destAccessConditions - BlobAccessConditions against the destination.

Returns:

Emits the successful response.

abortCopyFromURL

public io.reactivex.Single<BlobsAbortCopyFromURLResponse> abortCopyFromURL(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 the Azure Docs.

Parameters:

copyId - The id of the copy operation to abort. Returned as the copyId field on the BlobsStartCopyFromURLHeaders object.

leaseAccessConditions - LeaseAccessConditions

Returns:

Emits the successful response.

download

public io.reactivex.Single<BlobsDownloadResponse> download(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 the Azure Docs.

Parameters:

range - BlobRange

accessConditions - BlobAccessConditions

rangeGetContentMD5 - Whether the contentMD5 for the specified blob range should be returned.

Returns:

Emits the successful response.

delete

public io.reactivex.Single<BlobsDeleteResponse> 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 the Azure Docs.

Parameters:

deleteBlobSnapshotOptions - Specifies the behavior for deleting the snapshots on this blob. Include will delete the base blob and all snapshots. Only will delete only the snapshots. If a snapshot is being deleted, you must pass null.

accessConditions - BlobAccessConditions

Returns:

Emits the successful response.

getProperties

public io.reactivex.Single<BlobsGetPropertiesResponse> getProperties(BlobAccessConditions accessConditions)

Returns the blob's metadata and properties. For more information, see the Azure Docs.

Parameters:

accessConditions - BlobAccessConditions

Returns:

Emits the successful response.

setHTTPHeaders

public io.reactivex.Single<BlobsSetHTTPHeadersResponse> setHTTPHeaders(BlobHTTPHeaders headers,
                                                                       BlobAccessConditions accessConditions)

Changes a blob's HTTP header properties. For more information, see the Azure Docs.

Parameters:

headers - BlobHTTPHeaders

accessConditions - BlobAccessConditions

Returns:

Emits the successful response.

setMetadata

public io.reactivex.Single<BlobsSetMetadataResponse> setMetadata(Metadata metadata,
                                                                 BlobAccessConditions accessConditions)

Changes a blob's metadata. For more information, see the Azure Docs.

Parameters:

metadata - Metadata

accessConditions - BlobAccessConditions

Returns:

Emits the successful response.

createSnapshot

public io.reactivex.Single<BlobsCreateSnapshotResponse> createSnapshot(Metadata metadata,
                                                                       BlobAccessConditions accessConditions)

Creates a read-only snapshot of a blob. For more information, see the Azure Docs.

Parameters:

metadata - Metadata

accessConditions - BlobAccessConditions

Returns:

Emits the successful response.

acquireLease

public io.reactivex.Single<BlobsAcquireLeaseResponse> acquireLease(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 the Azure Docs.

Parameters:

proposedID - A String in any valid GUID format. May be null.

duration - 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 - HTTPAccessConditions

Returns:

Emits the successful response.

renewLease

public io.reactivex.Single<BlobsRenewLeaseResponse> renewLease(String leaseID,
                                                               HTTPAccessConditions httpAccessConditions)

Renews the blob's previously-acquired lease. For more information, see the Azure Docs.

Parameters:

leaseID - The leaseId of the active lease on the blob.

httpAccessConditions - HTTPAccessConditions

Returns:

Emits the successful response.

releaseLease

public io.reactivex.Single<BlobsReleaseLeaseResponse> releaseLease(String leaseID,
                                                                   HTTPAccessConditions httpAccessConditions)

Releases the blob's previously-acquired lease. For more information, see the Azure Docs.

Parameters:

leaseID - The leaseId of the active lease on the blob.

httpAccessConditions - HTTPAccessConditions

Returns:

Emits the successful response.

breakLease

public io.reactivex.Single<BlobsBreakLeaseResponse> breakLease(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 the Azure Docs.

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 - HTTPAccessConditions

Returns:

Emits the successful response.

changeLease

public io.reactivex.Single<BlobsChangeLeaseResponse> changeLease(String leaseId,
                                                                 String proposedID,
                                                                 HTTPAccessConditions httpAccessConditions)

ChangeLease changes the blob's lease ID. For more information, see the Azure Docs.

Parameters:

leaseId - The leaseId of the active lease on the blob.

proposedID - A String in any valid GUID format.

httpAccessConditions - HTTPAccessConditions

Returns:

Emits the successful response.