public final class ShareServiceClientBuilder extends Object
FileServiceClients
and FileServiceAsyncClients
, calling buildClient
constructs an instance of ShareServiceClient and calling buildFileAsyncClient
constructs an instance of ShareServiceAsyncClient.
The client needs the endpoint of the Azure Storage File service and authorization credential.
endpoint
gives the builder the endpoint and may give the builder a
SAS token that authorizes the client.
Instantiating a synchronous FileService Client with SAS token
ShareServiceClient fileServiceClient = new ShareServiceClientBuilder() .endpoint("https://${accountName}.file.core.windows.net?${SASToken}") .buildClient();
Instantiating an Asynchronous FileService Client with SAS token
ShareServiceAsyncClient fileServiceAsyncClient = new ShareServiceClientBuilder() .endpoint("https://{accountName}.file.core.windows.net?{SASToken}") .buildAsyncClient();
If the endpoint
doesn't contain the query parameters to construct a SAS token they may be set using
sasToken
.
ShareServiceClient fileServiceClient = new ShareServiceClientBuilder() .endpoint("https://{accountName}.file.core.windows.net") .sasToken("${SASTokenQueryParams}") .buildClient();
ShareServiceAsyncClient fileServiceAsyncClient = new ShareServiceClientBuilder() .endpoint("https://{accountName}.file.core.windows.net") .sasToken("${SASTokenQueryParams}") .buildAsyncClient();
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
.
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 FileService Client with connection string.
String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};AccountKey={key};" + "EndpointSuffix={core.windows.net}"; ShareServiceClient fileServiceClient = new ShareServiceClientBuilder() .connectionString(connectionString) .buildClient();
Instantiating an Asynchronous FileService Client with connection string.
String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};AccountKey={key};" + "EndpointSuffix={core.windows.net}"; ShareServiceAsyncClient fileServiceAsyncClient = new ShareServiceClientBuilder() .connectionString(connectionString) .buildAsyncClient();
Constructor and Description |
---|
ShareServiceClientBuilder()
Creates a builder instance that is able to configure and construct
FileServiceClients
and FileServiceAsyncClients . |
Modifier and Type | Method and Description |
---|---|
ShareServiceClientBuilder |
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
Adds a pipeline policy to apply on each request sent.
|
ShareServiceAsyncClient |
buildAsyncClient()
Creates a
ShareServiceAsyncClient based on options set in the builder. |
ShareServiceClient |
buildClient()
Creates a
ShareServiceClient based on options set in the builder. |
ShareServiceClientBuilder |
configuration(com.azure.core.util.Configuration configuration)
Sets the configuration object used to retrieve environment configuration values during building of the client.
|
ShareServiceClientBuilder |
connectionString(String connectionString)
Sets the connection string to connect to the service.
|
ShareServiceClientBuilder |
credential(StorageSharedKeyCredential credential)
Sets the
StorageSharedKeyCredential used to authorize requests sent to the service. |
ShareServiceClientBuilder |
endpoint(String endpoint)
Sets the endpoint for the Azure Storage File instance that the client will interact with.
|
static com.azure.core.http.policy.HttpLogOptions |
getDefaultHttpLogOptions()
Gets the default log options with Storage headers and query parameters.
|
ShareServiceClientBuilder |
httpClient(com.azure.core.http.HttpClient httpClient)
Sets the
HttpClient to use for sending a receiving requests to and from the service. |
ShareServiceClientBuilder |
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets the
HttpLogOptions for service requests. |
ShareServiceClientBuilder |
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets the
HttpPipeline to use for the service client. |
ShareServiceClientBuilder |
retryOptions(RequestRetryOptions retryOptions)
Sets the request retry options for all the requests made through the client.
|
ShareServiceClientBuilder |
sasToken(String sasToken)
Sets the SAS token used to authorize requests sent to the service.
|
ShareServiceClientBuilder |
serviceVersion(ShareServiceVersion version)
Sets the
ShareServiceVersion that is used when making API requests. |
public ShareServiceClientBuilder()
FileServiceClients
and FileServiceAsyncClients
.public ShareServiceAsyncClient buildAsyncClient()
ShareServiceAsyncClient
based on options set in the builder. Every time this method is called a
new instance of ShareServiceAsyncClient
is created.
If pipeline
is set, then the pipeline
and
endpoint
are used to create the
client
. All other builder settings are ignored.
IllegalArgumentException
- If neither a StorageSharedKeyCredential
or
SAS token
has been set.public ShareServiceClient buildClient()
ShareServiceClient
based on options set in the builder. Every time buildClient()
is
called a new instance of ShareServiceClient
is created.
If pipeline
is set, then the pipeline
and endpoint
are used to create the client
.
All other builder settings are ignored.
NullPointerException
- If endpoint
is null
.IllegalArgumentException
- If neither a StorageSharedKeyCredential
or SAS token
has been set.public ShareServiceClientBuilder endpoint(String endpoint)
Query parameters of the endpoint will be parsed in an attempt to generate a SAS token to authenticate requests sent to the service.
endpoint
- The URL of the Azure Storage File instance to send service requests to and receive responses
from.IllegalArgumentException
- If endpoint
isn't a proper URLpublic ShareServiceClientBuilder credential(StorageSharedKeyCredential credential)
StorageSharedKeyCredential
used to authorize requests sent to the service.credential
- StorageSharedKeyCredential
.NullPointerException
- If credential
is null
.public ShareServiceClientBuilder sasToken(String sasToken)
sasToken
- The SAS token to use for authenticating requests.NullPointerException
- If sasToken
is null
.public ShareServiceClientBuilder connectionString(String connectionString)
connectionString
- Connection string of the storage account.IllegalArgumentException
- If connectionString
is invalid.public ShareServiceClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
HttpClient
to use for sending a receiving requests to and from the service.httpClient
- HttpClient to use for requests.public ShareServiceClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
pipelinePolicy
- a pipeline policyNullPointerException
- If pipelinePolicy
is null
.public ShareServiceClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
HttpLogOptions
for service requests.logOptions
- The logging configuration to use when sending and receiving HTTP requests/responses.NullPointerException
- If logOptions
is null
.public static com.azure.core.http.policy.HttpLogOptions getDefaultHttpLogOptions()
public ShareServiceClientBuilder configuration(com.azure.core.util.Configuration configuration)
configuration
- Configuration store used to retrieve environment configurations.public ShareServiceClientBuilder retryOptions(RequestRetryOptions retryOptions)
retryOptions
- RequestRetryOptions
.NullPointerException
- If retryOptions
is null
.public ShareServiceClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
HttpPipeline
to use for the service client.
If pipeline
is set, all other settings are ignored, aside from endpoint
.httpPipeline
- HttpPipeline to use for sending service requests and receiving responses.public ShareServiceClientBuilder serviceVersion(ShareServiceVersion version)
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.
version
- ShareServiceVersion
of the service to be used when making requests.Copyright © 2020 Microsoft Corporation. All rights reserved.