ShareLeaseClientBuilder Class

Package:: com.azure.storage.file.share.specialized

Maven Artifact:: com.azure:azure-storage-file-share:12.30.0

java.lang.Object
- com.azure.storage.file.share.specialized.ShareLeaseClientBuilder

public final class ShareLeaseClientBuilder

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 of ShareLeaseClient and ShareLeaseAsyncClient 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

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();

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
ShareLeaseClientBuilder	allowSourceTrailingDot(boolean allowSourceTrailingDot) Set the trailing dot property to specify whether trailing dot will be trimmed or not from the source URI.
ShareLeaseClientBuilder	allowTrailingDot(boolean allowTrailingDot) Set the trailing dot property to specify whether trailing dot will be trimmed or not from the target URI.
ShareLeaseAsyncClient	buildAsyncClient() Creates a ShareLeaseAsyncClient based on the configurations set in the builder.
ShareLeaseClient	buildClient() Creates a ShareLeaseClient based on the configurations set in the builder.
ShareLeaseClientBuilder	fileAsyncClient(ShareFileAsyncClient fileAsyncClient) Configures the builder based on the passed ShareFileAsyncClient.
ShareLeaseClientBuilder	fileClient(ShareFileClient fileClient) Configures the builder based on the passed ShareFileClient.
ShareLeaseClientBuilder	leaseId(String leaseId) Sets the identifier for the lease.
ShareLeaseClientBuilder	shareAsyncClient(ShareAsyncClient shareAsyncClient) Configures the builder based on the passed ShareAsyncClient.
ShareLeaseClientBuilder	shareClient(ShareClient shareClient) Configures the builder based on the passed ShareClient.
ShareLeaseClientBuilder	shareTokenIntent(ShareTokenIntent shareTokenIntent) Sets the ShareTokenIntent that specifies whether there is intent for a file to be backed up.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

public ShareLeaseClientBuilder()

Creates a new instance of ShareLeaseClientBuilder.

Method Details

public ShareLeaseClientBuilder allowSourceTrailingDot(boolean allowSourceTrailingDot)

Set the trailing dot property to specify whether trailing dot will be trimmed or not from the source URI. If set to true, trailing dot (.) will be allowed to suffix directory and file names. If false, the trailing dot will be trimmed. Supported by x-ms-version 2022-11-02 and above.

Parameters:

allowSourceTrailingDot - the allowSourceTrailingDot value.

Returns:

the updated ShareLeaseClientBuilder object

public ShareLeaseClientBuilder allowTrailingDot(boolean allowTrailingDot)

Set the trailing dot property to specify whether trailing dot will be trimmed or not from the target URI. If set to true, trailing dot (.) will be allowed to suffix directory and file names. If false, the trailing dot will be trimmed. Supported by x-ms-version 2022-11-02 and above.

Parameters:

allowTrailingDot - the allowTrailingDot value.

Returns:

the updated ShareLeaseClientBuilder object

public ShareLeaseAsyncClient buildAsyncClient()

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

Returns:

a ShareLeaseAsyncClient based on the configurations in this builder.

public ShareLeaseClient buildClient()

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

Returns:

a ShareLeaseClient based on the configurations in this builder.

public ShareLeaseClientBuilder fileAsyncClient(ShareFileAsyncClient fileAsyncClient)

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

Parameters:

fileAsyncClient - ShareFileAsyncClient used to configure the builder.

Returns:

the updated ShareLeaseClientBuilder object

public ShareLeaseClientBuilder fileClient(ShareFileClient fileClient)

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

Parameters:

fileClient - ShareFileClient used to configure the builder.

Returns:

the updated ShareLeaseClientBuilder object

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

public ShareLeaseClientBuilder shareAsyncClient(ShareAsyncClient shareAsyncClient)

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

Parameters:

shareAsyncClient - ShareAsyncClient used to configure the builder.

Returns:

the updated ShareLeaseClientBuilder object

public ShareLeaseClientBuilder shareClient(ShareClient shareClient)

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

Parameters:

shareClient - ShareClient used to configure the builder.

Returns:

the updated ShareLeaseClientBuilder object

public ShareLeaseClientBuilder shareTokenIntent(ShareTokenIntent shareTokenIntent)

Sets the ShareTokenIntent that specifies whether there is intent for a file to be backed up. This is currently required when using TokenCredential, and ignored for other forms of authentication.

Parameters:

shareTokenIntent - the ShareTokenIntent value.

Returns:

the updated ShareLeaseClientBuilder object

Applies to

Opinia

Czy ta strona była pomocna?