Class ShareClientBuilder
- java.lang.Object
-
- com.azure.storage.file.share.ShareClientBuilder
-
public class ShareClientBuilder extends Object
This class provides a fluent builder API to help aid the configuration and instantiation of theShareClients
andShareAsyncClients
, callingbuildClient
constructs an instance of ShareClient and callingbuildAsyncClient
constructs an instance of ShareAsyncClient.The client needs the endpoint of the Azure Storage File service, name of the share, and authorization credential.
endpoint
gives the builder the endpoint and may give the builder theshareName
and aSAS token
that authorizes the client.Instantiating a synchronous Share Client with SAS token
ShareClient shareClient = new ShareClientBuilder() .endpoint("https://${accountName}.file.core.windows.net?${SASToken}") .shareName("myshare") .buildClient();
Instantiating an Asynchronous Share Client with SAS token
ShareAsyncClient shareAsyncClient = new ShareClientBuilder() .endpoint("https://{accountName}.file.core.windows.net?{SASToken}") .shareName("myshare") .buildAsyncClient();
If the
endpoint
doesn't contain the query parameters to construct a SAS token it may be set usingsasToken
.ShareClient shareClient = new ShareClientBuilder() .endpoint("https://${accountName}.file.core.windows.net") .sasToken("${SASTokenQueryParams}") .shareName("myshare") .buildClient();
ShareAsyncClient shareAsyncClient = new ShareClientBuilder() .endpoint("https://{accountName}.file.core.windows.net") .sasToken("${SASTokenQueryParams}") .shareName("myshare") .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 withconnectionString
. 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 Share Client with connection string.
String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};AccountKey={key};" + "EndpointSuffix={core.windows.net}"; ShareClient shareClient = new ShareClientBuilder() .connectionString(connectionString).shareName("myshare") .buildClient();
Instantiating an Asynchronous Share Client with connection string.
String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};AccountKey={key};" + "EndpointSuffix={core.windows.net}"; ShareAsyncClient shareAsyncClient = new ShareClientBuilder() .connectionString(connectionString).shareName("myshare") .buildAsyncClient();
- See Also:
ShareClient
,ShareAsyncClient
,StorageSharedKeyCredential
-
-
Constructor Summary
Constructors Constructor Description ShareClientBuilder()
Creates a builder instance that is able to configure and constructShareClients
andShareAsyncClients
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ShareClientBuilder
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
Adds a pipeline policy to apply on each request sent.ShareAsyncClient
buildAsyncClient()
Creates aShareAsyncClient
based on options set in the builder.ShareClient
buildClient()
Creates aShareClient
based on options set in the builder.ShareClientBuilder
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Sets the client options for all the requests made through the client.ShareClientBuilder
configuration(com.azure.core.util.Configuration configuration)
Sets the configuration object used to retrieve environment configuration values during building of the client.ShareClientBuilder
connectionString(String connectionString)
Sets the connection string to connect to the service.ShareClientBuilder
credential(com.azure.core.credential.AzureSasCredential credential)
Sets theAzureSasCredential
used to authorize requests sent to the service.ShareClientBuilder
credential(StorageSharedKeyCredential credential)
Sets theStorageSharedKeyCredential
used to authorize requests sent to the service.ShareClientBuilder
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.ShareClientBuilder
httpClient(com.azure.core.http.HttpClient httpClient)
Sets theHttpClient
to use for sending a receiving requests to and from the service.ShareClientBuilder
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets theHttpLogOptions
for service requests.ShareClientBuilder
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service client.ShareClientBuilder
retryOptions(RequestRetryOptions retryOptions)
Sets the request retry options for all the requests made through the client.ShareClientBuilder
sasToken(String sasToken)
Sets the SAS token used to authorize requests sent to the service.ShareClientBuilder
serviceVersion(ShareServiceVersion version)
Sets theShareServiceVersion
that is used when making API requests.ShareClientBuilder
shareName(String shareName)
Sets the share that the constructed clients will interact withShareClientBuilder
snapshot(String snapshot)
Sets the snapshot that the constructed clients will interact with.
-
-
-
Constructor Detail
-
ShareClientBuilder
public ShareClientBuilder()
Creates a builder instance that is able to configure and constructShareClients
andShareAsyncClients
.
-
-
Method Detail
-
buildAsyncClient
public ShareAsyncClient buildAsyncClient()
Creates aShareAsyncClient
based on options set in the builder. Every timebuildAsyncClient()
is called a new instance ofShareAsyncClient
is created.If
pipeline
is set, then thepipeline
andendpoint
are used to create theclient
. All other builder settings are ignored.- Returns:
- A ShareAsyncClient with the options set from the builder.
- Throws:
NullPointerException
- IfshareName
isnull
.IllegalArgumentException
- If neither aStorageSharedKeyCredential
orSAS token
has been set.IllegalStateException
- If multiple credentials have been specified.
-
buildClient
public ShareClient buildClient()
Creates aShareClient
based on options set in the builder. Every timebuildClient()
is called a new instance ofShareClient
is created.If
pipeline
is set, then thepipeline
andendpoint
are used to create theclient
. All other builder settings are ignored.- Returns:
- A ShareClient with the options set from the builder.
- Throws:
NullPointerException
- Ifendpoint
orshareName
isnull
.IllegalStateException
- If neither aStorageSharedKeyCredential
orSAS token
has been set.IllegalStateException
- If multiple credentials have been specified.
-
endpoint
public ShareClientBuilder 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.
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 ShareClientBuilder object
- Throws:
IllegalArgumentException
- Ifendpoint
isnull
or is an invalid URL
-
shareName
public ShareClientBuilder shareName(String shareName)
Sets the share that the constructed clients will interact with- Parameters:
shareName
- Name of the share- Returns:
- the updated ShareClientBuilder object
- Throws:
NullPointerException
- IfshareName
isnull
.
-
snapshot
public ShareClientBuilder snapshot(String snapshot)
Sets the snapshot that the constructed clients will interact with. This snapshot must be linked to the share that has been specified in the builder.- Parameters:
snapshot
- Identifier of the snapshot- Returns:
- the updated ShareClientBuilder object
-
credential
public ShareClientBuilder credential(StorageSharedKeyCredential credential)
Sets theStorageSharedKeyCredential
used to authorize requests sent to the service.- Parameters:
credential
-StorageSharedKeyCredential
.- Returns:
- the updated ShareClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
sasToken
public ShareClientBuilder 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 ShareClientBuilder
- Throws:
NullPointerException
- IfsasToken
isnull
.
-
credential
public ShareClientBuilder credential(com.azure.core.credential.AzureSasCredential credential)
Sets theAzureSasCredential
used to authorize requests sent to the service.- Parameters:
credential
-AzureSasCredential
used to authorize requests sent to the service.- Returns:
- the updated ShareClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
connectionString
public ShareClientBuilder connectionString(String connectionString)
Sets the connection string to connect to the service.- Parameters:
connectionString
- Connection string of the storage account.- Returns:
- the updated ShareClientBuilder
- Throws:
IllegalArgumentException
- IfconnectionString
in invalid.NullPointerException
- IfconnectionString
isnull
.
-
httpClient
public ShareClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
Sets theHttpClient
to use for sending a receiving requests to and from the service.- Parameters:
httpClient
- HttpClient to use for requests.- Returns:
- the updated ShareClientBuilder object
-
addPolicy
public ShareClientBuilder 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 ShareClientBuilder object
- Throws:
NullPointerException
- IfpipelinePolicy
isnull
.
-
httpLogOptions
public ShareClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets theHttpLogOptions
for service requests.- Parameters:
logOptions
- The logging configuration to use when sending and receiving HTTP requests/responses.- Returns:
- the updated ShareClientBuilder object
- Throws:
NullPointerException
- IflogOptions
isnull
.
-
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 ShareClientBuilder 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 ShareClientBuilder object
-
retryOptions
public ShareClientBuilder retryOptions(RequestRetryOptions retryOptions)
Sets the request retry options for all the requests made through the client.- Parameters:
retryOptions
-RequestRetryOptions
.- Returns:
- the updated ShareClientBuilder object
- Throws:
NullPointerException
- IfretryOptions
isnull
.
-
pipeline
public ShareClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service client. Ifpipeline
is set, all other settings are ignored, aside fromendpoint
.- Parameters:
httpPipeline
- HttpPipeline to use for sending service requests and receiving responses.- Returns:
- the updated ShareClientBuilder object
-
clientOptions
public ShareClientBuilder 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 ShareClientBuilder object
- Throws:
NullPointerException
- IfclientOptions
isnull
.
-
serviceVersion
public ShareClientBuilder serviceVersion(ShareServiceVersion version)
Sets theShareServiceVersion
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 ShareClientBuilder object
-
-