Package com.azure.storage.file.datalake.specialized

Class DataLakeLeaseClientBuilder

java.lang.Object

com.azure.storage.file.datalake.specialized.DataLakeLeaseClientBuilder

public final class DataLakeLeaseClientBuilder
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 file system and path clients and act as a supplement client. A new instance of DataLakeLeaseClient and DataLakeLeaseAsyncClient are constructed every time buildClient and buildAsyncClient are called respectively.

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

Instantiating LeaseClients

 DataLakeLeaseClient dataLakeLeaseClient = new DataLakeLeaseClientBuilder()
     .fileClient(fileClient)
     .leaseId(leaseId)
     .buildClient();
 

 DataLakeLeaseClient dataLakeLeaseClient = new DataLakeLeaseClientBuilder()
     .directoryClient(directoryClient)
     .leaseId(leaseId)
     .buildClient();
 

 DataLakeLeaseClient dataLakeLeaseClient = new DataLakeLeaseClientBuilder()
     .fileSystemClient(dataLakeFileSystemClient)
     .leaseId(leaseId)
     .buildClient();
 

Instantiating LeaseAsyncClients

 DataLakeLeaseAsyncClient dataLakeLeaseAsyncClient = new DataLakeLeaseClientBuilder()
     .fileAsyncClient(fileAsyncClient)
     .leaseId(leaseId)
     .buildAsyncClient();
 

 DataLakeLeaseAsyncClient dataLakeLeaseAsyncClient = new DataLakeLeaseClientBuilder()
     .directoryAsyncClient(directoryAsyncClient)
     .leaseId(leaseId)
     .buildAsyncClient();
 

 DataLakeLeaseAsyncClient dataLakeLeaseAsyncClient = new DataLakeLeaseClientBuilder()
     .fileSystemAsyncClient(dataLakeFileSystemAsyncClient)
     .leaseId(leaseId)
     .buildAsyncClient();
 

See Also:

DataLakeLeaseClient, DataLakeLeaseAsyncClient

Constructor Summary

Constructors

Constructor	Description
DataLakeLeaseClientBuilder()	Creates a new instance of DataLakeLeaseClientBuilder.

Method Summary

Modifier and Type	Method	Description
DataLakeLeaseAsyncClient	buildAsyncClient()	Creates a DataLakeLeaseAsyncClient based on the configurations set in the builder.
DataLakeLeaseClient	buildClient()	Creates a DataLakeLeaseClient based on the configurations set in the builder.
DataLakeLeaseClientBuilder	directoryAsyncClient(DataLakeDirectoryAsyncClient dataLakeDirectoryAsyncClient)	Configures the builder based on the passed DataLakeDirectoryAsyncClient.
DataLakeLeaseClientBuilder	directoryClient(DataLakeDirectoryClient dataLakeDirectoryClient)	Configures the builder based on the passed DataLakeDirectoryClient.
DataLakeLeaseClientBuilder	fileAsyncClient(DataLakeFileAsyncClient dataLakeFileAsyncClient)	Configures the builder based on the passed DataLakeFileAsyncClient.
DataLakeLeaseClientBuilder	fileClient(DataLakeFileClient dataLakeFileClient)	Configures the builder based on the passed DataLakeFileClient.
DataLakeLeaseClientBuilder	fileSystemAsyncClient(DataLakeFileSystemAsyncClient dataLakeFileSystemAsyncClient)	Configures the builder based on the passed DataLakeFileSystemAsyncClient.
DataLakeLeaseClientBuilder	fileSystemClient(DataLakeFileSystemClient dataLakeFileSystemClient)	Configures the builder based on the passed DataLakeFileSystemClient.
DataLakeLeaseClientBuilder	leaseId(String leaseId)	Sets the identifier for the lease.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataLakeLeaseClientBuilder

public DataLakeLeaseClientBuilder()

Creates a new instance of DataLakeLeaseClientBuilder.

Method Detail

buildClient

public DataLakeLeaseClient buildClient()

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

Returns:

a DataLakeLeaseClient based on the configurations in this builder.

buildAsyncClient

public DataLakeLeaseAsyncClient buildAsyncClient()

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

Returns:

a DataLakeLeaseAsyncClient based on the configurations in this builder.

fileClient

public DataLakeLeaseClientBuilder fileClient(DataLakeFileClient dataLakeFileClient)

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

Parameters:

dataLakeFileClient - DataLakeFileClient used to configure the builder.

Returns:

the updated DataLakeLeaseClientBuilder object

Throws:

NullPointerException - If DataLakeFileClient is null.

fileAsyncClient

public DataLakeLeaseClientBuilder fileAsyncClient(DataLakeFileAsyncClient dataLakeFileAsyncClient)

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

Parameters:

dataLakeFileAsyncClient - DataLakeFileAsyncClient used to configure the builder.

Returns:

the updated DataLakeLeaseClientBuilder object

Throws:

NullPointerException - If DataLakeFileAsyncClient is null.

directoryClient

public DataLakeLeaseClientBuilder directoryClient(DataLakeDirectoryClient dataLakeDirectoryClient)

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

Parameters:

dataLakeDirectoryClient - DataLakeDirectoryClient used to configure the builder.

Returns:

the updated DataLakeLeaseClientBuilder object

Throws:

NullPointerException - If DataLakeDirectoryClient is null.

directoryAsyncClient

public DataLakeLeaseClientBuilder directoryAsyncClient(DataLakeDirectoryAsyncClient dataLakeDirectoryAsyncClient)

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

Parameters:

dataLakeDirectoryAsyncClient - DataLakeDirectoryAsyncClient used to configure the builder.

Returns:

the updated DataLakeLeaseClientBuilder object

Throws:

NullPointerException - If DataLakeDirectoryAsyncClient is null.

fileSystemClient

public DataLakeLeaseClientBuilder fileSystemClient(DataLakeFileSystemClient dataLakeFileSystemClient)

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

Parameters:

dataLakeFileSystemClient - DataLakeFileSystemClient used to configure the builder.

Returns:

the updated DataLakeLeaseClientBuilder object

Throws:

NullPointerException - If dataLakeFileSystemClient is null.

fileSystemAsyncClient

public DataLakeLeaseClientBuilder fileSystemAsyncClient(DataLakeFileSystemAsyncClient dataLakeFileSystemAsyncClient)

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

Parameters:

dataLakeFileSystemAsyncClient - DataLakeFileSystemAsyncClient used to configure the builder.

Returns:

the updated DataLakeLeaseClientBuilder object

Throws:

NullPointerException - If dataLakeFileSystemAsyncClient is null.

leaseId

public DataLakeLeaseClientBuilder 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 DataLakeLeaseClientBuilder object