BlobLeaseClientBuilder Class

Definition

This class provides a fluent builder API to help aid the configuration and instantiation of Storage Lease clients. Lease clients are able to interact with both container and blob clients and act as a supplement client. A new instance of BlobLeaseClient and BlobLeaseAsyncClient are constructed every time buildClient() and buildAsyncClient() are called respectively.

When a client is instantiated and a leaseId(String leaseId) hasn't been set a UUID will be used as the lease identifier.

Instantiating LeaseClients

BlobLeaseClient blobLeaseClient = new BlobLeaseClientBuilder()
     .blobClient(blobClient)
     .leaseId(leaseId)
     .buildClient();
BlobLeaseClient blobLeaseClient = new BlobLeaseClientBuilder()
     .containerClient(blobContainerClient)
     .leaseId(leaseId)
     .buildClient();

Instantiating LeaseAsyncClients

BlobLeaseAsyncClient blobLeaseAsyncClient = new BlobLeaseClientBuilder()
     .blobAsyncClient(blobAsyncClient)
     .leaseId(leaseId)
     .buildAsyncClient();
BlobLeaseAsyncClient blobLeaseAsyncClient = new BlobLeaseClientBuilder()
     .containerAsyncClient(blobContainerAsyncClient)
     .leaseId(leaseId)
     .buildAsyncClient();
public final class BlobLeaseClientBuilder
Inheritance
java.lang.Object
BlobLeaseClientBuilder

Inherited Members

java.lang.Object.clone() java.lang.Object.equals(java.lang.Object) java.lang.Object.finalize() java.lang.Object.getClass() java.lang.Object.hashCode() java.lang.Object.notify() java.lang.Object.notifyAll() java.lang.Object.toString() java.lang.Object.wait() java.lang.Object.wait(long) java.lang.Object.wait(long,int)

Constructors

BlobLeaseClientBuilder()

Methods

blobAsyncClient(BlobAsyncClientBase blobAsyncClient)

Configures the builder based on the passed BlobAsyncClient. This will set the HttpPipeline and URL that are used to interact with the service.

blobClient(BlobClientBase blobClient)

Configures the builder based on the passed BlobClient. This will set the HttpPipeline and URL that are used to interact with the service.

buildAsyncClient()

Creates a BlobLeaseAsyncClient based on the configurations set in the builder.

buildClient()

Creates a BlobLeaseClient based on the configurations set in the builder.

containerAsyncClient(BlobContainerAsyncClient blobContainerAsyncClient)

Configures the builder based on the passed BlobContainerAsyncClient. This will set the HttpPipeline and URL that are used to interact with the service.

containerClient(BlobContainerClient blobContainerClient)

Configures the builder based on the passed BlobContainerClient. This will set the HttpPipeline and URL that are used to interact with the service.

leaseId(String leaseId)

Sets the identifier for the lease.

If a lease ID isn't set then a UUID will be used.

Applies to