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 BlobURL 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<BlobAbortCopyFromURLResponse>	abortCopyFromURL(String copyId) Stops a pending copy that was previously started and leaves a destination blob with 0 length and metadata.
io.reactivex.Single<BlobAbortCopyFromURLResponse>	abortCopyFromURL(String copyId, LeaseAccessConditions leaseAccessConditions, com.microsoft.rest.v2.Context context) Stops a pending copy that was previously started and leaves a destination blob with 0 length and metadata.
io.reactivex.Single<BlobAcquireLeaseResponse>	acquireLease(String proposedId, int duration) Acquires a lease on the blob for write and delete operations.
io.reactivex.Single<BlobAcquireLeaseResponse>	acquireLease(String proposedID, int duration, ModifiedAccessConditions modifiedAccessConditions, com.microsoft.rest.v2.Context context) Acquires a lease on the blob for write and delete operations.
io.reactivex.Single<BlobBreakLeaseResponse>	breakLease() BreakLease breaks the blob's previously-acquired lease (if it exists).
io.reactivex.Single<BlobBreakLeaseResponse>	breakLease(Integer breakPeriodInSeconds, ModifiedAccessConditions modifiedAccessConditions, com.microsoft.rest.v2.Context context) BreakLease breaks the blob's previously-acquired lease (if it exists).
io.reactivex.Single<BlobChangeLeaseResponse>	changeLease(String leaseId, String proposedID) ChangeLease changes the blob's lease ID.
io.reactivex.Single<BlobChangeLeaseResponse>	changeLease(String leaseId, String proposedID, ModifiedAccessConditions modifiedAccessConditions, com.microsoft.rest.v2.Context context) ChangeLease changes the blob's lease ID.
io.reactivex.Single<BlobCreateSnapshotResponse>	createSnapshot() Creates a read-only snapshot of a blob.
io.reactivex.Single<BlobCreateSnapshotResponse>	createSnapshot(Metadata metadata, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context) Creates a read-only snapshot of a blob.
io.reactivex.Single<BlobDeleteResponse>	delete() Deletes the specified blob or snapshot.
io.reactivex.Single<BlobDeleteResponse>	delete(DeleteSnapshotsOptionType deleteBlobSnapshotOptions, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context) Deletes the specified blob or snapshot.
io.reactivex.Single<DownloadResponse>	download() Reads a range of bytes from a blob.
io.reactivex.Single<DownloadResponse>	download(BlobRange range, BlobAccessConditions accessConditions, boolean rangeGetContentMD5, com.microsoft.rest.v2.Context context) Reads a range of bytes from a blob.
io.reactivex.Single<BlobGetAccountInfoResponse>	getAccountInfo() Returns the sku name and account kind for the account.
io.reactivex.Single<BlobGetAccountInfoResponse>	getAccountInfo(com.microsoft.rest.v2.Context context) Returns the sku name and account kind for the account.
io.reactivex.Single<BlobGetPropertiesResponse>	getProperties() Returns the blob's metadata and properties.
io.reactivex.Single<BlobGetPropertiesResponse>	getProperties(BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context) Returns the blob's metadata and properties.
io.reactivex.Single<BlobReleaseLeaseResponse>	releaseLease(String leaseID) Releases the blob's previously-acquired lease.
io.reactivex.Single<BlobReleaseLeaseResponse>	releaseLease(String leaseID, ModifiedAccessConditions modifiedAccessConditions, com.microsoft.rest.v2.Context context) Releases the blob's previously-acquired lease.
io.reactivex.Single<BlobRenewLeaseResponse>	renewLease(String leaseID) Renews the blob's previously-acquired lease.
io.reactivex.Single<BlobRenewLeaseResponse>	renewLease(String leaseID, ModifiedAccessConditions modifiedAccessConditions, com.microsoft.rest.v2.Context context) Renews the blob's previously-acquired lease.
io.reactivex.Single<BlobSetHTTPHeadersResponse>	setHTTPHeaders(BlobHTTPHeaders headers) Changes a blob's HTTP header properties.
io.reactivex.Single<BlobSetHTTPHeadersResponse>	setHTTPHeaders(BlobHTTPHeaders headers, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context) Changes a blob's HTTP header properties.
io.reactivex.Single<BlobSetMetadataResponse>	setMetadata(Metadata metadata) Changes a blob's metadata.
io.reactivex.Single<BlobSetMetadataResponse>	setMetadata(Metadata metadata, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context) Changes a blob's metadata.
io.reactivex.Single<BlobSetTierResponse>	setTier(AccessTier tier) Sets the tier on a blob.
io.reactivex.Single<BlobSetTierResponse>	setTier(AccessTier tier, LeaseAccessConditions leaseAccessConditions, com.microsoft.rest.v2.Context context) Sets the tier on a blob.
io.reactivex.Single<BlobStartCopyFromURLResponse>	startCopyFromURL(URL sourceURL) Copies the data at the source URL to a blob.
io.reactivex.Single<BlobStartCopyFromURLResponse>	startCopyFromURL(URL sourceURL, Metadata metadata, ModifiedAccessConditions sourceModifiedAccessConditions, BlobAccessConditions destAccessConditions, com.microsoft.rest.v2.Context context) Copies the data at the source URL to a blob.
io.reactivex.Single<BlobCopyFromURLResponse>	syncCopyFromURL(URL copySource) Copies the data at the source URL to a blob and waits for the copy to complete before returning a response.
io.reactivex.Single<BlobCopyFromURLResponse>	syncCopyFromURL(URL copySource, Metadata metadata, ModifiedAccessConditions sourceModifiedAccessConditions, BlobAccessConditions destAccessConditions, com.microsoft.rest.v2.Context context) Copies the data at the source URL to a blob and waits for the copy to complete before returning a response.
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.
io.reactivex.Single<BlobUndeleteResponse>	undelete() Undelete restores the content and metadata of a soft-deleted blob and/or any associated soft-deleted snapshots.
io.reactivex.Single<BlobUndeleteResponse>	undelete(com.microsoft.rest.v2.Context context) Undelete restores the content and metadata of a soft-deleted blob and/or any associated soft-deleted snapshots.
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, createPipeline, createPipeline, 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 BlobURL 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 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 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<BlobStartCopyFromURLResponse> startCopyFromURL(URL sourceURL)

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.

Returns:

Emits the successful response.

startCopyFromURL

public io.reactivex.Single<BlobStartCopyFromURLResponse> startCopyFromURL(URL sourceURL,
                                                                          Metadata metadata,
                                                                          ModifiedAccessConditions sourceModifiedAccessConditions,
                                                                          BlobAccessConditions destAccessConditions,
                                                                          com.microsoft.rest.v2.Context context)

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

sourceModifiedAccessConditions - ModifiedAccessConditions against the source. Standard HTTP Access conditions related to the modification of data. ETag and LastModifiedTime are used to construct conditions related to when the blob was changed relative to the given request. The request will fail if the specified condition is not satisfied.

destAccessConditions - BlobAccessConditions against the destination.

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.

abortCopyFromURL

public io.reactivex.Single<BlobAbortCopyFromURLResponse> abortCopyFromURL(String copyId)

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 BlobStartCopyFromURLHeaders object.

Returns:

Emits the successful response.

abortCopyFromURL

public io.reactivex.Single<BlobAbortCopyFromURLResponse> abortCopyFromURL(String copyId,
                                                                          LeaseAccessConditions leaseAccessConditions,
                                                                          com.microsoft.rest.v2.Context context)

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 BlobStartCopyFromURLHeaders object.

leaseAccessConditions - By setting lease access conditions, requests will fail if the provided lease does not match the active lease on the blob.

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.

syncCopyFromURL

public io.reactivex.Single<BlobCopyFromURLResponse> syncCopyFromURL(URL copySource)

Copies the data at the source URL to a blob and waits for the copy to complete before returning a response. For more information, see the Azure Docs

Parameters:

copySource - The source URL to copy from.

Returns:

Emits the successful response.

syncCopyFromURL

public io.reactivex.Single<BlobCopyFromURLResponse> syncCopyFromURL(URL copySource,
                                                                    Metadata metadata,
                                                                    ModifiedAccessConditions sourceModifiedAccessConditions,
                                                                    BlobAccessConditions destAccessConditions,
                                                                    com.microsoft.rest.v2.Context context)

Copies the data at the source URL to a blob and waits for the copy to complete before returning a response. For more information, see the Azure Docs

Parameters:

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

metadata - Metadata

sourceModifiedAccessConditions - ModifiedAccessConditions against the source. Standard HTTP Access conditions related to the modification of data. ETag and LastModifiedTime are used to construct conditions related to when the blob was changed relative to the given request. The request will fail if the specified condition is not satisfied.

destAccessConditions - BlobAccessConditions against the destination.

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.

download

public io.reactivex.Single<DownloadResponse> download()

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.

Note that the response body has reliable download functionality built in, meaning that a failed download stream will be automatically retried. This behavior may be configured with ReliableDownloadOptions.

Returns:

Emits the successful response.

download

public io.reactivex.Single<DownloadResponse> download(BlobRange range,
                                                      BlobAccessConditions accessConditions,
                                                      boolean rangeGetContentMD5,
                                                      com.microsoft.rest.v2.Context context)

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.

Note that the response body has reliable download functionality built in, meaning that a failed download stream will be automatically retried. This behavior may be configured with ReliableDownloadOptions.

Parameters:

range - BlobRange

accessConditions - BlobAccessConditions

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

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.

delete

public io.reactivex.Single<BlobDeleteResponse> delete()

Deletes the specified blob or snapshot. Note that deleting a blob also deletes all its snapshots. For more information, see the Azure Docs.

Returns:

Emits the successful response.

delete

public io.reactivex.Single<BlobDeleteResponse> delete(DeleteSnapshotsOptionType deleteBlobSnapshotOptions,
                                                      BlobAccessConditions accessConditions,
                                                      com.microsoft.rest.v2.Context context)

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

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.

getProperties

public io.reactivex.Single<BlobGetPropertiesResponse> getProperties()

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

Returns:

Emits the successful response.

getProperties

public io.reactivex.Single<BlobGetPropertiesResponse> getProperties(BlobAccessConditions accessConditions,
                                                                    com.microsoft.rest.v2.Context context)

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

Parameters:

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.

setHTTPHeaders

public io.reactivex.Single<BlobSetHTTPHeadersResponse> setHTTPHeaders(BlobHTTPHeaders headers)

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

Parameters:

headers - BlobHTTPHeaders

Returns:

Emits the successful response.

setHTTPHeaders

public io.reactivex.Single<BlobSetHTTPHeadersResponse> setHTTPHeaders(BlobHTTPHeaders headers,
                                                                      BlobAccessConditions accessConditions,
                                                                      com.microsoft.rest.v2.Context context)

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

Parameters:

headers - BlobHTTPHeaders

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.

setMetadata

public io.reactivex.Single<BlobSetMetadataResponse> setMetadata(Metadata metadata)

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

Parameters:

metadata - Metadata

Returns:

Emits the successful response.

setMetadata

public io.reactivex.Single<BlobSetMetadataResponse> setMetadata(Metadata metadata,
                                                                BlobAccessConditions accessConditions,
                                                                com.microsoft.rest.v2.Context context)

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

Parameters:

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.

createSnapshot

public io.reactivex.Single<BlobCreateSnapshotResponse> createSnapshot()

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

Returns:

Emits the successful response.

createSnapshot

public io.reactivex.Single<BlobCreateSnapshotResponse> createSnapshot(Metadata metadata,
                                                                      BlobAccessConditions accessConditions,
                                                                      com.microsoft.rest.v2.Context context)

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

Parameters:

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.

setTier

public io.reactivex.Single<BlobSetTierResponse> setTier(AccessTier tier)

Sets the tier on a blob. The operation is allowed on a page blob in a premium storage account or a block blob in a blob storage or GPV2 account. A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines the Hot/Cool/Archive storage type. This does not update the blob's etag.

For detailed information about block blob level tiering see the Azure Docs.

Parameters:

tier - The new tier for the blob.

Returns:

Emits the successful response.

setTier

public io.reactivex.Single<BlobSetTierResponse> setTier(AccessTier tier,
                                                        LeaseAccessConditions leaseAccessConditions,
                                                        com.microsoft.rest.v2.Context context)

Sets the tier on a blob. The operation is allowed on a page blob in a premium storage account or a block blob in a blob storage or GPV2 account. A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines the Hot/Cool/Archive storage type. This does not update the blob's etag.

For detailed information about block blob level tiering see the Azure Docs.

Parameters:

tier - The new tier for the blob.

leaseAccessConditions - By setting lease access conditions, requests will fail if the provided lease does not match the active lease on the blob.

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.

undelete

public io.reactivex.Single<BlobUndeleteResponse> undelete()

Undelete restores the content and metadata of a soft-deleted blob and/or any associated soft-deleted snapshots. For more information, see the Azure Docs.

Returns:

Emits the successful response.

undelete

public io.reactivex.Single<BlobUndeleteResponse> undelete(com.microsoft.rest.v2.Context context)

Undelete restores the content and metadata of a soft-deleted blob and/or any associated soft-deleted snapshots. For more information, see the Azure Docs.

Parameters:

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.

acquireLease

public io.reactivex.Single<BlobAcquireLeaseResponse> acquireLease(String proposedId,
                                                                  int duration)

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.

Returns:

Emits the successful response.

acquireLease

public io.reactivex.Single<BlobAcquireLeaseResponse> acquireLease(String proposedID,
                                                                  int duration,
                                                                  ModifiedAccessConditions modifiedAccessConditions,
                                                                  com.microsoft.rest.v2.Context context)

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.

modifiedAccessConditions - Standard HTTP Access conditions related to the modification of data. ETag and LastModifiedTime are used to construct conditions related to when the blob was changed relative to the given request. The request will fail if the specified condition is not satisfied.

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.

renewLease

public io.reactivex.Single<BlobRenewLeaseResponse> renewLease(String leaseID)

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.

Returns:

Emits the successful response.

renewLease

public io.reactivex.Single<BlobRenewLeaseResponse> renewLease(String leaseID,
                                                              ModifiedAccessConditions modifiedAccessConditions,
                                                              com.microsoft.rest.v2.Context context)

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.

modifiedAccessConditions - Standard HTTP Access conditions related to the modification of data. ETag and LastModifiedTime are used to construct conditions related to when the blob was changed relative to the given request. The request will fail if the specified condition is not satisfied.

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.

releaseLease

public io.reactivex.Single<BlobReleaseLeaseResponse> releaseLease(String leaseID)

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.

Returns:

Emits the successful response.

releaseLease

public io.reactivex.Single<BlobReleaseLeaseResponse> releaseLease(String leaseID,
                                                                  ModifiedAccessConditions modifiedAccessConditions,
                                                                  com.microsoft.rest.v2.Context context)

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.

modifiedAccessConditions - Standard HTTP Access conditions related to the modification of data. ETag and LastModifiedTime are used to construct conditions related to when the blob was changed relative to the given request. The request will fail if the specified condition is not satisfied.

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.

breakLease

public io.reactivex.Single<BlobBreakLeaseResponse> breakLease()

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.

Returns:

Emits the successful response.

breakLease

public io.reactivex.Single<BlobBreakLeaseResponse> breakLease(Integer breakPeriodInSeconds,
                                                              ModifiedAccessConditions modifiedAccessConditions,
                                                              com.microsoft.rest.v2.Context context)

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.

modifiedAccessConditions - Standard HTTP Access conditions related to the modification of data. ETag and LastModifiedTime are used to construct conditions related to when the blob was changed relative to the given request. The request will fail if the specified condition is not satisfied.

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.

changeLease

public io.reactivex.Single<BlobChangeLeaseResponse> changeLease(String leaseId,
                                                                String proposedID)

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.

Returns:

Emits the successful response.

changeLease

public io.reactivex.Single<BlobChangeLeaseResponse> changeLease(String leaseId,
                                                                String proposedID,
                                                                ModifiedAccessConditions modifiedAccessConditions,
                                                                com.microsoft.rest.v2.Context context)

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.

modifiedAccessConditions - Standard HTTP Access conditions related to the modification of data. ETag and LastModifiedTime are used to construct conditions related to when the blob was changed relative to the given request. The request will fail if the specified condition is not satisfied.

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.

getAccountInfo

public io.reactivex.Single<BlobGetAccountInfoResponse> getAccountInfo()

Returns the sku name and account kind for the account. For more information, please see the Azure Docs.

Returns:

Emits the successful response.

getAccountInfo

public io.reactivex.Single<BlobGetAccountInfoResponse> getAccountInfo(com.microsoft.rest.v2.Context context)

Returns the sku name and account kind for the account. For more information, please see the Azure Docs.

Parameters:

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.