ShareServiceClientBuilder (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.storage.file.share.ShareServiceClientBuilder

public final class ShareServiceClientBuilder
extends Object

This class provides a fluent builder API to help aid the configuration and instantiation of the 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();

See Also:: ShareServiceClient, ShareServiceAsyncClient, StorageSharedKeyCredential

Constructor Summary

Constructors
Constructor and Description

ShareServiceClientBuilder()
Creates a builder instance that is able to configure and construct FileServiceClients and FileServiceAsyncClients.

Constructors
Constructor and Description
`ShareServiceClientBuilder()` Creates a builder instance that is able to configure and construct `FileServiceClients` and `FileServiceAsyncClients`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`clientOptions(com.azure.core.util.ClientOptions clientOptions)` Sets the client options for all the requests made through the client.
`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(com.azure.core.credential.AzureSasCredential credential)` Sets the `AzureSasCredential` used to authorize requests sent 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ShareServiceClientBuilder
```
public ShareServiceClientBuilder()
```
    Creates a builder instance that is able to configure and construct FileServiceClients and FileServiceAsyncClients.
- Method Detail
  - buildAsyncClient
```
public ShareServiceAsyncClient buildAsyncClient()
```
    Creates a 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.
    
    Returns:
    
    A ShareServiceAsyncClient with the options set from the builder.
    
    Throws:
    
    IllegalArgumentException - If neither a StorageSharedKeyCredential or SAS token has been set.
    
    IllegalStateException - If multiple credentials have been specified.
  - buildClient
```
public ShareServiceClient buildClient()
```
    Creates a 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.
    
    Returns:
    
    A ShareServiceClient with the options set from the builder.
    
    Throws:
    
    NullPointerException - If endpoint is null.
    
    IllegalArgumentException - If neither a StorageSharedKeyCredential or SAS token has been set.
    
    IllegalStateException - If multiple credentials have been specified.
  - endpoint
```
public ShareServiceClientBuilder endpoint(String endpoint)
```
    Sets the endpoint for the Azure Storage File instance that the client will interact with.
    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 ShareServiceClientBuilder object
    
    Throws:
    
    IllegalArgumentException - If endpoint isn't a proper URL
  - credential
```
public ShareServiceClientBuilder credential(StorageSharedKeyCredential credential)
```
    Sets the StorageSharedKeyCredential used to authorize requests sent to the service.
    
    Parameters:
    
    credential - StorageSharedKeyCredential.
    
    Returns:
    
    the updated ShareServiceClientBuilder
    
    Throws:
    
    NullPointerException - If credential is null.
  - sasToken
```
public ShareServiceClientBuilder 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 ShareServiceClientBuilder
    
    Throws:
    
    NullPointerException - If sasToken is null.
  - credential
```
public ShareServiceClientBuilder credential(com.azure.core.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 ShareServiceClientBuilder
    
    Throws:
    
    NullPointerException - If credential is null.
  - connectionString
```
public ShareServiceClientBuilder connectionString(String connectionString)
```
    Sets the connection string to connect to the service.
    
    Parameters:
    
    connectionString - Connection string of the storage account.
    
    Returns:
    
    the updated ShareServiceClientBuilder
    
    Throws:
    
    IllegalArgumentException - If connectionString is invalid.
  - httpClient
```
public ShareServiceClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
```
    Sets the HttpClient to use for sending a receiving requests to and from the service.
    
    Parameters:
    
    httpClient - HttpClient to use for requests.
    
    Returns:
    
    the updated ShareServiceClientBuilder object
  - addPolicy
```
public ShareServiceClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
```
    Adds a pipeline policy to apply on each request sent. The policy will be added after the retry policy. If the method is called multiple times, all policies will be added and their order preserved.
    
    Parameters:
    
    pipelinePolicy - a pipeline policy
    
    Returns:
    
    the updated ShareServiceClientBuilder object
    
    Throws:
    
    NullPointerException - If pipelinePolicy is null.
  - httpLogOptions
```
public ShareServiceClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
```
    Sets the HttpLogOptions for service requests.
    
    Parameters:
    
    logOptions - The logging configuration to use when sending and receiving HTTP requests/responses.
    
    Returns:
    
    the updated ShareServiceClientBuilder object
    
    Throws:
    
    NullPointerException - If logOptions is null.
  - getDefaultHttpLogOptions
```
public static com.azure.core.http.policy.HttpLogOptions getDefaultHttpLogOptions()
```
    Gets the default log options with Storage headers and query parameters.
    
    Returns:
    
    the default log options.
  - configuration
```
public ShareServiceClientBuilder configuration(com.azure.core.util.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 ShareServiceClientBuilder object
  - retryOptions
```
public ShareServiceClientBuilder retryOptions(RequestRetryOptions retryOptions)
```
    Sets the request retry options for all the requests made through the client.
    
    Parameters:
    
    retryOptions - RequestRetryOptions.
    
    Returns:
    
    the updated ShareServiceClientBuilder object
    
    Throws:
    
    NullPointerException - If retryOptions is null.
  - pipeline
```
public ShareServiceClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
```
    Sets the HttpPipeline to use for the service client. If pipeline is set, all other settings are ignored, aside from endpoint.
    
    Parameters:
    
    httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
    
    Returns:
    
    the updated ShareServiceClientBuilder object
  - clientOptions
```
public ShareServiceClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
```
    Sets the client options for all the requests made through the client.
    
    Parameters:
    
    clientOptions - ClientOptions.
    
    Returns:
    
    the updated ShareServiceClientBuilder object
    
    Throws:
    
    NullPointerException - If clientOptions is null.
  - serviceVersion
```
public ShareServiceClientBuilder 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 ShareServiceClientBuilder object

Visit the Azure for Java Developers site for more Java documentation, including quick starts, tutorials, and code samples.

Class ShareServiceClientBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShareServiceClientBuilder

Method Detail

buildAsyncClient

buildClient

endpoint

credential

sasToken

credential

connectionString

httpClient

addPolicy

httpLogOptions

getDefaultHttpLogOptions

configuration

retryOptions

pipeline

clientOptions

serviceVersion