Class ShareLeaseClientBuilder
- java.lang.Object
-
- com.azure.storage.file.share.specialized.ShareLeaseClientBuilder
-
public final class ShareLeaseClientBuilder extends Object
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 share and share file clients and act as a supplement client. A new instance ofShareLeaseClient
andShareLeaseAsyncClient
are constructed every timebuildClient
andbuildAsyncClient
are called respectively.When a client is instantiated and a
leaseId
hasn't been set aUUID
will be used as the lease identifier.Instantiating LeaseClients
ShareLeaseClient fileLeaseClient = new ShareLeaseClientBuilder() .fileClient(shareFileClient) .leaseId(leaseId) .buildClient();
ShareLeaseClient fileLeaseClient = new ShareLeaseClientBuilder() .shareClient(shareClient) .leaseId(leaseId) .buildClient();
Instantiating LeaseAsyncClients
ShareLeaseAsyncClient fileLeaseAsyncClient = new ShareLeaseClientBuilder() .fileAsyncClient(shareFileAsyncClient) .leaseId(leaseId) .buildAsyncClient();
ShareLeaseAsyncClient fileLeaseAsyncClient = new ShareLeaseClientBuilder() .shareAsyncClient(shareAsyncClient) .leaseId(leaseId) .buildAsyncClient();
- See Also:
ShareLeaseClient
,ShareLeaseAsyncClient
-
-
Constructor Summary
Constructors Constructor Description ShareLeaseClientBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ShareLeaseAsyncClient
buildAsyncClient()
Creates aShareLeaseAsyncClient
based on the configurations set in the builder.ShareLeaseClient
buildClient()
Creates aShareLeaseClient
based on the configurations set in the builder.ShareLeaseClientBuilder
fileAsyncClient(ShareFileAsyncClient fileAsyncClient)
Configures the builder based on the passedShareFileAsyncClient
.ShareLeaseClientBuilder
fileClient(ShareFileClient fileClient)
Configures the builder based on the passedShareFileClient
.ShareLeaseClientBuilder
leaseId(String leaseId)
Sets the identifier for the lease.ShareLeaseClientBuilder
shareAsyncClient(ShareAsyncClient shareAsyncClient)
Configures the builder based on the passedShareAsyncClient
.ShareLeaseClientBuilder
shareClient(ShareClient shareClient)
Configures the builder based on the passedShareClient
.
-
-
-
Method Detail
-
buildClient
public ShareLeaseClient buildClient()
Creates aShareLeaseClient
based on the configurations set in the builder.- Returns:
- a
ShareLeaseClient
based on the configurations in this builder.
-
buildAsyncClient
public ShareLeaseAsyncClient buildAsyncClient()
Creates aShareLeaseAsyncClient
based on the configurations set in the builder.- Returns:
- a
ShareLeaseAsyncClient
based on the configurations in this builder.
-
fileClient
public ShareLeaseClientBuilder fileClient(ShareFileClient fileClient)
Configures the builder based on the passedShareFileClient
. This will set theHttpPipeline
andURL
that are used to interact with the service.- Parameters:
fileClient
- ShareFileClient used to configure the builder.- Returns:
- the updated ShareLeaseClientBuilder object
- Throws:
NullPointerException
- IffileClient
isnull
.
-
fileAsyncClient
public ShareLeaseClientBuilder fileAsyncClient(ShareFileAsyncClient fileAsyncClient)
Configures the builder based on the passedShareFileAsyncClient
. This will set theHttpPipeline
andURL
that are used to interact with the service.- Parameters:
fileAsyncClient
- ShareFileAsyncClient used to configure the builder.- Returns:
- the updated ShareLeaseClientBuilder object
- Throws:
NullPointerException
- IffileAsyncClient
isnull
.
-
shareClient
public ShareLeaseClientBuilder shareClient(ShareClient shareClient)
Configures the builder based on the passedShareClient
. This will set theHttpPipeline
andURL
that are used to interact with the service.- Parameters:
shareClient
- ShareClient used to configure the builder.- Returns:
- the updated ShareLeaseClientBuilder object
- Throws:
NullPointerException
- IffileClient
isnull
.
-
shareAsyncClient
public ShareLeaseClientBuilder shareAsyncClient(ShareAsyncClient shareAsyncClient)
Configures the builder based on the passedShareAsyncClient
. This will set theHttpPipeline
andURL
that are used to interact with the service.- Parameters:
shareAsyncClient
- ShareAsyncClient used to configure the builder.- Returns:
- the updated ShareLeaseClientBuilder object
- Throws:
NullPointerException
- IffileAsyncClient
isnull
.
-
leaseId
public ShareLeaseClientBuilder leaseId(String leaseId)
Sets the identifier for the lease.If a lease ID isn't set then a
UUID
will be used.- Parameters:
leaseId
- Identifier for the lease.- Returns:
- the updated ShareLeaseClientBuilder object
-
-