public class BlobURL extends StorageURL
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.storageClient| 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. |
| Modifier and Type | Method and Description |
|---|---|
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,
ModifiedAccessConditions modifiedAccessConditions,
com.microsoft.rest.v2.Context context)
Acquires a lease on the blob for write and delete operations.
|
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,
ModifiedAccessConditions modifiedAccessConditions,
com.microsoft.rest.v2.Context context)
ChangeLease changes the blob's lease ID.
|
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(DeleteSnapshotsOptionType deleteBlobSnapshotOptions,
BlobAccessConditions accessConditions,
com.microsoft.rest.v2.Context context)
Deletes the specified blob or snapshot.
|
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(com.microsoft.rest.v2.Context context)
Returns the sku name and account kind for the account.
|
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,
ModifiedAccessConditions modifiedAccessConditions,
com.microsoft.rest.v2.Context context)
Releases 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,
BlobAccessConditions accessConditions,
com.microsoft.rest.v2.Context context)
Changes a blob's HTTP header properties.
|
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,
LeaseAccessConditions leaseAccessConditions,
com.microsoft.rest.v2.Context context)
Sets the tier on 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.
|
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(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. |
appendToURLPath, createPipeline, toString, toURLpublic BlobURL(URL url, com.microsoft.rest.v2.http.HttpPipeline pipeline)
BlobURL object pointing to the account specified by the URL and using the provided pipeline to
make HTTP requests.url - A URL to an Azure Storage blob.pipeline - A HttpPipeline which configures the behavior of HTTP exchanges. Please refer to the
createPipeline method on StorageURL for more information.public BlobURL withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline)
BlobURL with the given pipeline.pipeline - An HttpPipeline object to set.BlobURL object with the given pipeline.public BlobURL withSnapshot(String snapshot) throws MalformedURLException, UnknownHostException
BlobURL with the given snapshot.snapshot - A String to set.BlobURL object with the given pipeline.MalformedURLException - Appending the specified snapshot produced an invalid URL.UnknownHostException - If the url contains an improperly formatted ipaddress or unknown host address.public BlockBlobURL toBlockBlobURL()
BlockBlobURL object. Note that this does not change the actual type of the
blob if it has already been created.BlockBlobURL object.public AppendBlobURL toAppendBlobURL()
AppendBlobURL object. Note that this does not change the actual type of the
blob if it has already been created.AppendBlobURL object.public PageBlobURL toPageBlobURL()
PageBlobURL object. Note that this does not change the actual type of the blob
if it has already been created.PageBlobURL object.public io.reactivex.Single<BlobStartCopyFromURLResponse> startCopyFromURL(URL sourceURL, Metadata metadata, ModifiedAccessConditions sourceModifiedAccessConditions, BlobAccessConditions destAccessConditions, com.microsoft.rest.v2.Context context)
sourceURL - The source URL to copy from. URLs outside of Azure may only be copied to block blobs.metadata - MetadatasourceModifiedAccessConditions - ModifiedAccessConditions against the source.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.public io.reactivex.Single<BlobAbortCopyFromURLResponse> abortCopyFromURL(String copyId, LeaseAccessConditions leaseAccessConditions, com.microsoft.rest.v2.Context context)
copyId - The id of the copy operation to abort. Returned as the copyId field on the BlobStartCopyFromURLHeaders object.leaseAccessConditions - LeaseAccessConditionscontext - 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.public io.reactivex.Single<DownloadResponse> download(BlobRange range, BlobAccessConditions accessConditions, boolean rangeGetContentMD5, com.microsoft.rest.v2.Context context)
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.
range - BlobRangeaccessConditions - BlobAccessConditionsrangeGetContentMD5 - 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.public io.reactivex.Single<BlobDeleteResponse> delete(DeleteSnapshotsOptionType deleteBlobSnapshotOptions, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context)
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 - BlobAccessConditionscontext - 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.public io.reactivex.Single<BlobGetPropertiesResponse> getProperties(BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context)
accessConditions - BlobAccessConditionscontext - 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.public io.reactivex.Single<BlobSetHTTPHeadersResponse> setHTTPHeaders(BlobHTTPHeaders headers, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context)
headers - BlobHTTPHeadersaccessConditions - BlobAccessConditionscontext - 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.public io.reactivex.Single<BlobSetMetadataResponse> setMetadata(Metadata metadata, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context)
metadata - MetadataaccessConditions - BlobAccessConditionscontext - 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.public io.reactivex.Single<BlobCreateSnapshotResponse> createSnapshot(Metadata metadata, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context)
metadata - MetadataaccessConditions - BlobAccessConditionscontext - 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.public io.reactivex.Single<BlobSetTierResponse> setTier(AccessTier tier, LeaseAccessConditions leaseAccessConditions, com.microsoft.rest.v2.Context context)
tier - The new tier for the blob.leaseAccessConditions - LeaseAccessConditionscontext - 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.public io.reactivex.Single<BlobUndeleteResponse> undelete(com.microsoft.rest.v2.Context context)
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.public io.reactivex.Single<BlobAcquireLeaseResponse> acquireLease(String proposedID, int duration, ModifiedAccessConditions modifiedAccessConditions, com.microsoft.rest.v2.Context context)
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 - ModifiedAccessConditionscontext - 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.public io.reactivex.Single<BlobRenewLeaseResponse> renewLease(String leaseID, ModifiedAccessConditions modifiedAccessConditions, com.microsoft.rest.v2.Context context)
leaseID - The leaseId of the active lease on the blob.modifiedAccessConditions - ModifiedAccessConditionscontext - 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.public io.reactivex.Single<BlobReleaseLeaseResponse> releaseLease(String leaseID, ModifiedAccessConditions modifiedAccessConditions, com.microsoft.rest.v2.Context context)
leaseID - The leaseId of the active lease on the blob.modifiedAccessConditions - ModifiedAccessConditionscontext - 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.public io.reactivex.Single<BlobBreakLeaseResponse> breakLease(Integer breakPeriodInSeconds, ModifiedAccessConditions modifiedAccessConditions, com.microsoft.rest.v2.Context context)
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 - ModifiedAccessConditionscontext - 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.public io.reactivex.Single<BlobChangeLeaseResponse> changeLease(String leaseId, String proposedID, ModifiedAccessConditions modifiedAccessConditions, com.microsoft.rest.v2.Context context)
leaseId - The leaseId of the active lease on the blob.proposedID - A String in any valid GUID format.modifiedAccessConditions - ModifiedAccessConditionscontext - 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.public io.reactivex.Single<BlobGetAccountInfoResponse> getAccountInfo(com.microsoft.rest.v2.Context context)
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.This documentation was released into the public domain.