Class ShareFileClientBuilder
- java.lang.Object
-
- com.azure.storage.file.share.ShareFileClientBuilder
-
- All Implemented Interfaces:
com.azure.core.client.traits.AzureNamedKeyCredentialTrait<ShareFileClientBuilder>
,com.azure.core.client.traits.AzureSasCredentialTrait<ShareFileClientBuilder>
,com.azure.core.client.traits.ConfigurationTrait<ShareFileClientBuilder>
,com.azure.core.client.traits.ConnectionStringTrait<ShareFileClientBuilder>
,com.azure.core.client.traits.EndpointTrait<ShareFileClientBuilder>
,com.azure.core.client.traits.HttpTrait<ShareFileClientBuilder>
public class ShareFileClientBuilder extends Object implements com.azure.core.client.traits.HttpTrait<ShareFileClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<ShareFileClientBuilder>, com.azure.core.client.traits.AzureNamedKeyCredentialTrait<ShareFileClientBuilder>, com.azure.core.client.traits.AzureSasCredentialTrait<ShareFileClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<ShareFileClientBuilder>, com.azure.core.client.traits.EndpointTrait<ShareFileClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation of theFileClients
,FileAsyncClients
,DirectoryClients
, andDirectoryAsyncClients
. CallingbuildFileClient
,buildFileAsyncClient
,buildDirectoryClient
, orbuildDirectoryAsyncClient
constructs an instance ofShareFileClient
,ShareFileAsyncClient
,ShareDirectoryClient
, orShareDirectoryAsyncClient
respectively.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(String)
,resourcePath(String)
and aSAS token
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 usingsasToken
.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 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 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
Constructors Constructor Description ShareFileClientBuilder()
Creates a builder instance that is able to configure and constructFileClients
andFileAsyncClients
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ShareFileClientBuilder
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
Adds apipeline policy
to apply on each request sent.ShareDirectoryAsyncClient
buildDirectoryAsyncClient()
Creates aShareDirectoryAsyncClient
based on options set in the builder.ShareDirectoryClient
buildDirectoryClient()
Creates aShareDirectoryClient
based on options set in the builder.ShareFileAsyncClient
buildFileAsyncClient()
Creates aShareFileAsyncClient
based on options set in the builder.ShareFileClient
buildFileClient()
Creates aShareFileClient
based on options set in the builder.ShareFileClientBuilder
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Allows for setting common properties such as application ID, headers, proxy configuration, etc.ShareFileClientBuilder
configuration(com.azure.core.util.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(com.azure.core.credential.AzureNamedKeyCredential credential)
Sets theAzureNamedKeyCredential
used to authorize requests sent to the service.ShareFileClientBuilder
credential(com.azure.core.credential.AzureSasCredential credential)
Sets theAzureSasCredential
used to authorize requests sent to the service.ShareFileClientBuilder
credential(StorageSharedKeyCredential credential)
Sets theStorageSharedKeyCredential
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 com.azure.core.http.policy.HttpLogOptions
getDefaultHttpLogOptions()
Gets the default log options with Storage headers and query parameters.ShareFileClientBuilder
httpClient(com.azure.core.http.HttpClient httpClient)
Sets theHttpClient
to use for sending and receiving requests to and from the service.ShareFileClientBuilder
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service.ShareFileClientBuilder
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service client.ShareFileClientBuilder
resourcePath(String resourcePath)
Sets the file that the constructed clients will interact withShareFileClientBuilder
retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
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 theShareServiceVersion
that is used when making API requests.ShareFileClientBuilder
shareName(String shareName)
Sets the share that the constructed clients will interact withShareFileClientBuilder
snapshot(String snapshot)
Sets the shareSnapshot that the constructed clients will interact with.
-
-
-
Constructor Detail
-
ShareFileClientBuilder
public ShareFileClientBuilder()
Creates a builder instance that is able to configure and constructFileClients
andFileAsyncClients
.
-
-
Method Detail
-
buildDirectoryAsyncClient
public ShareDirectoryAsyncClient buildDirectoryAsyncClient()
Creates aShareDirectoryAsyncClient
based on options set in the builder. Every timebuildFileAsyncClient()
is called a new instance ofShareDirectoryAsyncClient
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
orshareName
isnull
.IllegalArgumentException
- If neither aStorageSharedKeyCredential
orSAS token
has been set.IllegalStateException
- If multiple credentials have been specified.
-
buildDirectoryClient
public ShareDirectoryClient buildDirectoryClient()
Creates aShareDirectoryClient
based on options set in the builder. Every timebuildDirectoryClient()
is called a new instance ofShareDirectoryClient
is created.If
pipeline
is set, then thepipeline
andendpoint
are used to create theclient
. All other builder settings are ignored.- Returns:
- A ShareDirectoryClient with the options set from the builder.
- Throws:
NullPointerException
- Ifendpoint
,shareName
ordirectoryPath
isnull
.IllegalArgumentException
- If neither aStorageSharedKeyCredential
orSAS token
has been set.IllegalStateException
- If multiple credentials have been specified.
-
buildFileAsyncClient
public ShareFileAsyncClient buildFileAsyncClient()
Creates aShareFileAsyncClient
based on options set in the builder. Every timebuildFileAsyncClient()
is called a new instance ofShareFileAsyncClient
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
or the (@code resourcePath) isnull
.IllegalArgumentException
- If neither aStorageSharedKeyCredential
orSAS token
has been set.IllegalStateException
- If multiple credentials have been specified.
-
buildFileClient
public ShareFileClient buildFileClient()
Creates aShareFileClient
based on options set in the builder. Every timebuildFileClient()
is called a new instance ofShareFileClient
is created.If
pipeline
is set, then thepipeline
andendpoint
are used to create theclient
. All other builder settings are ignored.- Returns:
- A ShareFileClient with the options set from the builder.
- Throws:
NullPointerException
- Ifendpoint
,shareName
orresourcePath
isnull
.IllegalStateException
- If neither aStorageSharedKeyCredential
orSAS token
has been set.IllegalStateException
- If multiple credentials have been specified.
-
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.
- Specified by:
endpoint
in interfacecom.azure.core.client.traits.EndpointTrait<ShareFileClientBuilder>
- Parameters:
endpoint
- The URL of the Azure Storage File instance to send service requests to and receive responses from.- Returns:
- the updated ShareFileClientBuilder object
- Throws:
IllegalArgumentException
- Ifendpoint
isnull
or is an invalid URL
-
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
- Throws:
NullPointerException
- IfshareName
isnull
.
-
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
- Throws:
NullPointerException
- IfshareSnapshot
isnull
.
-
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
- Throws:
NullPointerException
- IfresourcePath
isnull
.
-
credential
public ShareFileClientBuilder credential(StorageSharedKeyCredential credential)
Sets theStorageSharedKeyCredential
used to authorize requests sent to the service.- Parameters:
credential
-StorageSharedKeyCredential
.- Returns:
- the updated ShareFileClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
credential
public ShareFileClientBuilder credential(com.azure.core.credential.AzureNamedKeyCredential credential)
Sets theAzureNamedKeyCredential
used to authorize requests sent to the service.- Specified by:
credential
in interfacecom.azure.core.client.traits.AzureNamedKeyCredentialTrait<ShareFileClientBuilder>
- Parameters:
credential
-AzureNamedKeyCredential
.- Returns:
- the updated ShareFileClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
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
- Throws:
NullPointerException
- IfsasToken
isnull
.
-
credential
public ShareFileClientBuilder credential(com.azure.core.credential.AzureSasCredential credential)
Sets theAzureSasCredential
used to authorize requests sent to the service.- Specified by:
credential
in interfacecom.azure.core.client.traits.AzureSasCredentialTrait<ShareFileClientBuilder>
- Parameters:
credential
-AzureSasCredential
used to authorize requests sent to the service.- Returns:
- the updated ShareFileClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
connectionString
public ShareFileClientBuilder connectionString(String connectionString)
Sets the connection string to connect to the service.- Specified by:
connectionString
in interfacecom.azure.core.client.traits.ConnectionStringTrait<ShareFileClientBuilder>
- Parameters:
connectionString
- Connection string of the storage account.- Returns:
- the updated ShareFileClientBuilder
- Throws:
IllegalArgumentException
- IfconnectionString
in invalid.
-
httpClient
public ShareFileClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
Sets theHttpClient
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 noHttpPipeline
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 anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
httpClient
in interfacecom.azure.core.client.traits.HttpTrait<ShareFileClientBuilder>
- Parameters:
httpClient
- TheHttpClient
to use for requests.- Returns:
- the updated ShareFileClientBuilder object
-
addPolicy
public ShareFileClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
Adds apipeline policy
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 noHttpPipeline
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 anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
addPolicy
in interfacecom.azure.core.client.traits.HttpTrait<ShareFileClientBuilder>
- Parameters:
pipelinePolicy
- Apipeline policy
.- Returns:
- the updated ShareFileClientBuilder object
- Throws:
NullPointerException
- IfpipelinePolicy
isnull
.
-
httpLogOptions
public ShareFileClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service. If alogLevel
is not provided, default value ofHttpLogDetailLevel.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 noHttpPipeline
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 anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
httpLogOptions
in interfacecom.azure.core.client.traits.HttpTrait<ShareFileClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- the updated ShareFileClientBuilder 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 ShareFileClientBuilder configuration(com.azure.core.util.Configuration configuration)
Sets the configuration object used to retrieve environment configuration values during building of the client.- Specified by:
configuration
in interfacecom.azure.core.client.traits.ConfigurationTrait<ShareFileClientBuilder>
- Parameters:
configuration
- Configuration store used to retrieve environment configurations.- 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 usingretryOptions(RetryOptions)
.- Parameters:
retryOptions
-RequestRetryOptions
.- Returns:
- the updated ShareFileClientBuilder object.
-
retryOptions
public ShareFileClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
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 noHttpPipeline
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 anHttpPipeline
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)
. Consider usingretryOptions(RequestRetryOptions)
to also set storage specific options.- Specified by:
retryOptions
in interfacecom.azure.core.client.traits.HttpTrait<ShareFileClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- the updated ShareFileClientBuilder object
-
pipeline
public ShareFileClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
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 noHttpPipeline
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 anHttpPipeline
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
is not ignored whenpipeline
is set.- Specified by:
pipeline
in interfacecom.azure.core.client.traits.HttpTrait<ShareFileClientBuilder>
- Parameters:
httpPipeline
-HttpPipeline
to use for sending service requests and receiving responses.- Returns:
- the updated ShareFileClientBuilder object
-
clientOptions
public ShareFileClientBuilder clientOptions(com.azure.core.util.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 theHttpClientOptions
class (a subclass of theClientOptions
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 noHttpPipeline
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 anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
clientOptions
in interfacecom.azure.core.client.traits.HttpTrait<ShareFileClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- the updated ShareFileClientBuilder object
- Throws:
NullPointerException
- IfclientOptions
isnull
.- See Also:
HttpClientOptions
-
serviceVersion
public ShareFileClientBuilder 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 ShareFileClientBuilder object
-
-