Freigeben über


ShareFileClientBuilder Class

  • java.lang.Object
    • com.azure.storage.file.share.ShareFileClientBuilder

Implements

public class ShareFileClientBuilder
implements TokenCredentialTrait<ShareFileClientBuilder>, HttpTrait<ShareFileClientBuilder>, ConnectionStringTrait<ShareFileClientBuilder>, AzureNamedKeyCredentialTrait<ShareFileClientBuilder>, AzureSasCredentialTrait<ShareFileClientBuilder>, ConfigurationTrait<ShareFileClientBuilder>, EndpointTrait<ShareFileClientBuilder>

This class provides a fluent builder API to help aid the configuration and instantiation of the ShareFileClient, ShareFileAsyncClient, ShareDirectoryClient, and ShareDirectoryAsyncClient. Calling buildFileClient(), buildFileAsyncClient(), buildDirectoryClient(), or buildDirectoryAsyncClient() constructs an instance of ShareFileClient, ShareFileAsyncClient, ShareDirectoryClient, or ShareDirectoryAsyncClient respectively.

The client needs the endpoint of the Azure Storage File service, name of the share, and authorization credential. endpoint(String endpoint) gives the builder the endpoint and may give the builder the shareName(String shareName), resourcePath(String resourcePath) and a sasToken(String sasToken) that authorizes the client.

Instantiating a synchronous File Client with SAS token

ShareFileClient fileClient = new ShareFileClientBuilder()
     .endpoint("https://${accountName}.file.core.windows.net?${SASToken}")
     .shareName("myshare")
     .resourcePath("myfilepath")
     .buildFileClient();

Instantiating an Asynchronous File Client with SAS token

ShareDirectoryClient shareDirectoryClient = new ShareFileClientBuilder()
     .endpoint("https://${accountName}.file.core.windows.net?${SASToken}")
     .shareName("myshare")
     .resourcePath("mydirectory")
     .buildDirectoryClient();

If the endpoint doesn't contain the query parameters to construct a SAS token it may be set using sasToken(String sasToken).

ShareFileClient fileClient = new ShareFileClientBuilder()
     .endpoint("https://${accountName}.file.core.windows.net")
     .sasToken("${SASTokenQueryParams}")
     .shareName("myshare")
     .resourcePath("myfilepath")
     .buildFileClient();
ShareFileAsyncClient shareFileAsyncClient = new ShareFileClientBuilder()
     .endpoint("https://{accountName}.file.core.windows.net")
     .sasToken("${SASTokenQueryParams}")
     .shareName("myshare")
     .resourcePath("myfilepath")
     .buildFileAsyncClient();

Another way to authenticate the client is using a StorageSharedKeyCredential. To create a StorageSharedKeyCredential a connection string from the Storage File service must be used. Set the StorageSharedKeyCredential with connectionString(String connectionString). If the builder has both a SAS token and StorageSharedKeyCredential the StorageSharedKeyCredential will be preferred when authorizing requests sent to the service.

Instantiating a synchronous File Client with connection string.

String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};AccountKey={key}"
     + ";EndpointSuffix={core.windows.net}";
 ShareDirectoryClient shareDirectoryClient = new ShareFileClientBuilder()
     .connectionString(connectionString)
     .shareName("myshare")
     .resourcePath("mydirectory")
     .buildDirectoryClient();

Instantiating an Asynchronous File Client with connection string.

String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};AccountKey={key};"
     + "EndpointSuffix={core.windows.net}";
 ShareDirectoryAsyncClient shareDirectoryAsyncClient = new ShareFileClientBuilder()
     .connectionString(connectionString).shareName("myshare").resourcePath("mydirectory")
     .buildDirectoryAsyncClient();

Constructor Summary

Constructor Description
ShareFileClientBuilder()

Creates a builder instance that is able to configure and construct ShareFileClient and ShareFileAsyncClient.

Method Summary

Modifier and Type Method and Description
ShareFileClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)

Adds a HttpPipelinePolicy to apply on each request sent.

ShareFileClientBuilder allowSourceTrailingDot(boolean allowSourceTrailingDot)

Set the trailing dot property to specify whether trailing dot will be trimmed or not from the source URI.

ShareFileClientBuilder allowTrailingDot(boolean allowTrailingDot)

Set the trailing dot property to specify whether trailing dot will be trimmed or not from the target URI.

ShareFileClientBuilder audience(ShareAudience audience)

Sets the Audience to use for authentication with Azure Active Directory (AAD).

ShareDirectoryAsyncClient buildDirectoryAsyncClient()

Creates a ShareDirectoryAsyncClient based on options set in the builder.

ShareDirectoryClient buildDirectoryClient()

Creates a ShareDirectoryClient based on options set in the builder.

ShareFileAsyncClient buildFileAsyncClient()

Creates a ShareFileAsyncClient based on options set in the builder.

ShareFileClient buildFileClient()

Creates a ShareFileClient based on options set in the builder.

ShareFileClientBuilder clientOptions(ClientOptions clientOptions)

Allows for setting common properties such as application ID, headers, proxy configuration, etc.

ShareFileClientBuilder configuration(Configuration configuration)

Sets the configuration object used to retrieve environment configuration values during building of the client.

ShareFileClientBuilder connectionString(String connectionString)

Sets the connection string to connect to the service.

ShareFileClientBuilder credential(AzureNamedKeyCredential credential)

Sets the AzureNamedKeyCredential used to authorize requests sent to the service.

ShareFileClientBuilder credential(AzureSasCredential credential)

Sets the AzureSasCredential used to authorize requests sent to the service.

ShareFileClientBuilder credential(TokenCredential tokenCredential)

Sets the TokenCredential used to authorize requests sent to the service.

ShareFileClientBuilder credential(StorageSharedKeyCredential credential)

Sets the StorageSharedKeyCredential used to authorize requests sent to the service.

ShareFileClientBuilder endpoint(String endpoint)

Sets the endpoint for the Azure Storage File instance that the client will interact with.

static HttpLogOptions getDefaultHttpLogOptions()

Gets the default log options with Storage headers and query parameters.

ShareFileClientBuilder httpClient(HttpClient httpClient)

Sets the HttpClient to use for sending and receiving requests to and from the service.

ShareFileClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions to use when sending and receiving requests to and from the service.

ShareFileClientBuilder pipeline(HttpPipeline httpPipeline)

Sets the HttpPipeline to use for the service client.

ShareFileClientBuilder resourcePath(String resourcePath)

Sets the file that the constructed clients will interact with

ShareFileClientBuilder retryOptions(RetryOptions retryOptions)

Sets the RetryOptions for all the requests made through the client.

ShareFileClientBuilder retryOptions(RequestRetryOptions retryOptions)

Sets the request retry options for all the requests made through the client.

ShareFileClientBuilder sasToken(String sasToken)

Sets the SAS token used to authorize requests sent to the service.

ShareFileClientBuilder serviceVersion(ShareServiceVersion version)

Sets the ShareServiceVersion that is used when making API requests.

ShareFileClientBuilder shareName(String shareName)

Sets the share that the constructed clients will interact with

ShareFileClientBuilder shareTokenIntent(ShareTokenIntent shareTokenIntent)

Sets the ShareTokenIntent that specifies whether there is intent for a file to be backed up.

ShareFileClientBuilder snapshot(String snapshot)

Sets the shareSnapshot that the constructed clients will interact with.

Methods inherited from java.lang.Object

Constructor Details

ShareFileClientBuilder

public ShareFileClientBuilder()

Creates a builder instance that is able to configure and construct ShareFileClient and ShareFileAsyncClient.

Method Details

addPolicy

public ShareFileClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)

Adds a HttpPipelinePolicy to apply on each request sent.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

pipelinePolicy - A HttpPipelinePolicy.

Returns:

the updated ShareFileClientBuilder object

allowSourceTrailingDot

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

allowTrailingDot

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

audience

public ShareFileClientBuilder audience(ShareAudience audience)

Sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.

Parameters:

audience - ShareAudience to be used when requesting a token from Azure Active Directory (AAD).

Returns:

the updated ShareFileClientBuilder object

buildDirectoryAsyncClient

public ShareDirectoryAsyncClient buildDirectoryAsyncClient()

Creates a ShareDirectoryAsyncClient based on options set in the builder. Every time buildFileAsyncClient() is called a new instance of ShareDirectoryAsyncClient is created.

If pipeline(HttpPipeline httpPipeline) is set, then the pipeline and endpoint(String endpoint) are used to create the ShareDirectoryAsyncClient. All other builder settings are ignored.

Returns:

A ShareAsyncClient with the options set from the builder.

buildDirectoryClient

public ShareDirectoryClient buildDirectoryClient()

Creates a ShareDirectoryClient based on options set in the builder. Every time buildDirectoryClient() is called a new instance of ShareDirectoryClient is created.

If pipeline(HttpPipeline httpPipeline) is set, then the pipeline and endpoint(String endpoint) are used to create the ShareDirectoryClient. All other builder settings are ignored.

Returns:

A ShareDirectoryClient with the options set from the builder.

buildFileAsyncClient

public ShareFileAsyncClient buildFileAsyncClient()

Creates a ShareFileAsyncClient based on options set in the builder. Every time buildFileAsyncClient() is called a new instance of ShareFileAsyncClient is created.

If pipeline(HttpPipeline httpPipeline) is set, then the pipeline and endpoint(String endpoint) are used to create the ShareFileAsyncClient. All other builder settings are ignored.

Returns:

A ShareAsyncClient with the options set from the builder.

buildFileClient

public ShareFileClient buildFileClient()

Creates a ShareFileClient based on options set in the builder. Every time buildFileClient() is called a new instance of ShareFileClient is created.

If pipeline(HttpPipeline httpPipeline) is set, then the pipeline and endpoint(String endpoint) are used to create the ShareFileClient. All other builder settings are ignored.

Returns:

A ShareFileClient with the options set from the builder.

clientOptions

public ShareFileClientBuilder clientOptions(ClientOptions clientOptions)

Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the HttpClientOptions class (a subclass of the ClientOptions base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

the updated ShareFileClientBuilder object

configuration

public ShareFileClientBuilder configuration(Configuration configuration)

Sets the configuration object used to retrieve environment configuration values during building of the client.

Parameters:

configuration - Configuration store used to retrieve environment configurations.

Returns:

the updated ShareFileClientBuilder object

connectionString

public ShareFileClientBuilder connectionString(String connectionString)

Sets the connection string to connect to the service.

Parameters:

connectionString - Connection string of the storage account.

Returns:

the updated ShareFileClientBuilder

credential

public ShareFileClientBuilder credential(AzureNamedKeyCredential credential)

Sets the AzureNamedKeyCredential used to authorize requests sent to the service.

Parameters:

credential - AzureNamedKeyCredential.

Returns:

the updated ShareFileClientBuilder

credential

public ShareFileClientBuilder credential(AzureSasCredential credential)

Sets the AzureSasCredential used to authorize requests sent to the service.

Parameters:

credential - AzureSasCredential used to authorize requests sent to the service.

Returns:

the updated ShareFileClientBuilder

credential

public ShareFileClientBuilder credential(TokenCredential tokenCredential)

Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type.

Parameters:

tokenCredential - TokenCredential used to authorize requests sent to the service.

Returns:

the updated ShareFileClientBuilder

credential

public ShareFileClientBuilder credential(StorageSharedKeyCredential credential)

Sets the StorageSharedKeyCredential used to authorize requests sent to the service.

Parameters:

Returns:

the updated ShareFileClientBuilder

endpoint

public ShareFileClientBuilder endpoint(String endpoint)

Sets the endpoint for the Azure Storage File instance that the client will interact with.

The first path segment, if the endpoint contains path segments, will be assumed to be the name of the share that the client will interact with. Rest of the path segments should be the path of the file. It mush end up with the file name if more segments exist.

Query parameters of the endpoint will be parsed in an attempt to generate a SAS token to authenticate requests sent to the service.

Parameters:

endpoint - The URL of the Azure Storage File instance to send service requests to and receive responses from.

Returns:

the updated ShareFileClientBuilder object

getDefaultHttpLogOptions

public static HttpLogOptions getDefaultHttpLogOptions()

Gets the default log options with Storage headers and query parameters.

Returns:

the default log options.

httpClient

public ShareFileClientBuilder httpClient(HttpClient httpClient)

Sets the HttpClient to use for sending and receiving requests to and from the service.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

httpClient - The HttpClient to use for requests.

Returns:

the updated ShareFileClientBuilder object

httpLogOptions

public ShareFileClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel#NONE is set.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

logOptions - The HttpLogOptions to use when sending and receiving requests to and from the service.

Returns:

the updated ShareFileClientBuilder object

pipeline

public ShareFileClientBuilder pipeline(HttpPipeline httpPipeline)

Sets the HttpPipeline to use for the service client.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

The endpoint(String endpoint) is not ignored when pipeline is set.

Parameters:

httpPipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

the updated ShareFileClientBuilder object

resourcePath

public ShareFileClientBuilder resourcePath(String resourcePath)

Sets the file that the constructed clients will interact with

Parameters:

resourcePath - Path of the file (or directory).

Returns:

the updated ShareFileClientBuilder object

retryOptions

public ShareFileClientBuilder retryOptions(RetryOptions retryOptions)

Sets the RetryOptions for all the requests made through the client.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Setting this is mutually exclusive with using retryOptions(RequestRetryOptions retryOptions). Consider using retryOptions(RequestRetryOptions retryOptions) to also set storage specific options.

Parameters:

retryOptions - The RetryOptions to use for all the requests made through the client.

Returns:

the updated ShareFileClientBuilder object

retryOptions

public ShareFileClientBuilder retryOptions(RequestRetryOptions retryOptions)

Sets the request retry options for all the requests made through the client. Setting this is mutually exclusive with using retryOptions(RetryOptions retryOptions).

Parameters:

retryOptions - RequestRetryOptions.

Returns:

the updated ShareFileClientBuilder object.

sasToken

public ShareFileClientBuilder sasToken(String sasToken)

Sets the SAS token used to authorize requests sent to the service.

Parameters:

sasToken - The SAS token to use for authenticating requests. This string should only be the query parameters (with or without a leading '?') and not a full url.

Returns:

the updated ShareFileClientBuilder

serviceVersion

public ShareFileClientBuilder serviceVersion(ShareServiceVersion version)

Sets the ShareServiceVersion that is used when making API requests.

If a service version is not provided, the service version that will be used will be the latest known service version based on the version of the client library being used. If no service version is specified, updating to a newer version of the client library will have the result of potentially moving to a newer service version.

Targeting a specific service version may also mean that the service will return an error for newer APIs.

Parameters:

version - ShareServiceVersion of the service to be used when making requests.

Returns:

the updated ShareFileClientBuilder object

shareName

public ShareFileClientBuilder shareName(String shareName)

Sets the share that the constructed clients will interact with

Parameters:

shareName - Name of the share

Returns:

the updated ShareFileClientBuilder object

shareTokenIntent

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

snapshot

public ShareFileClientBuilder snapshot(String snapshot)

Sets the shareSnapshot that the constructed clients will interact with. This shareSnapshot must be linked to the share that has been specified in the builder.

Parameters:

snapshot - Identifier of the shareSnapshot

Returns:

the updated ShareFileClientBuilder object

Applies to