386 строки
55 KiB
YAML
386 строки
55 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.file.share.ShareClientBuilder"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder"
|
|
name: "ShareClientBuilder"
|
|
nameWithType: "ShareClientBuilder"
|
|
summary: "This class provides a fluent builder API to help aid the configuration and instantiation of the <xref uid=\"com.azure.storage.file.share.ShareClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareClients\"></xref> and <xref uid=\"com.azure.storage.file.share.ShareAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareAsyncClients\"></xref>, calling <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> constructs an instance of Share<wbr>Client and calling <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> constructs an instance of Share<wbr>Async<wbr>Client."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **ShareClientBuilder**</br> implements <xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConnectionStringTrait?alt=com.azure.core.client.traits.ConnectionStringTrait&text=ConnectionStringTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.AzureNamedKeyCredentialTrait?alt=com.azure.core.client.traits.AzureNamedKeyCredentialTrait&text=AzureNamedKeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.AzureSasCredentialTrait?alt=com.azure.core.client.traits.AzureSasCredentialTrait&text=AzureSasCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.ShareClientBuilder()"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.ShareClientBuilder()"
|
|
name: "ShareClientBuilder()"
|
|
nameWithType: "ShareClientBuilder.ShareClientBuilder()"
|
|
summary: "Creates a builder instance that is able to configure and construct <xref uid=\"com.azure.storage.file.share.ShareClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareClients\"></xref> and <xref uid=\"com.azure.storage.file.share.ShareAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareAsyncClients\"></xref>."
|
|
syntax: "public ShareClientBuilder()"
|
|
desc: "Creates a builder instance that is able to configure and construct <xref uid=\"com.azure.storage.file.share.ShareClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareClients\"></xref> and <xref uid=\"com.azure.storage.file.share.ShareAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareAsyncClients\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.addPolicy(HttpPipelinePolicy pipelinePolicy)"
|
|
name: "addPolicy(HttpPipelinePolicy pipelinePolicy)"
|
|
nameWithType: "ShareClientBuilder.addPolicy(HttpPipelinePolicy pipelinePolicy)"
|
|
summary: "Adds a <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref> to apply on each request sent."
|
|
parameters:
|
|
- description: "A <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref>."
|
|
name: "pipelinePolicy"
|
|
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)"
|
|
desc: "Adds a <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref> to apply on each request sent.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.allowSourceTrailingDot(boolean)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.allowSourceTrailingDot(boolean allowSourceTrailingDot)"
|
|
name: "allowSourceTrailingDot(boolean allowSourceTrailingDot)"
|
|
nameWithType: "ShareClientBuilder.allowSourceTrailingDot(boolean allowSourceTrailingDot)"
|
|
summary: "Set the trailing dot property to specify whether trailing dot will be trimmed or not from the source URI."
|
|
parameters:
|
|
- description: "the allowSourceTrailingDot value."
|
|
name: "allowSourceTrailingDot"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder allowSourceTrailingDot(boolean allowSourceTrailingDot)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.allowTrailingDot(boolean)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.allowTrailingDot(boolean allowTrailingDot)"
|
|
name: "allowTrailingDot(boolean allowTrailingDot)"
|
|
nameWithType: "ShareClientBuilder.allowTrailingDot(boolean allowTrailingDot)"
|
|
summary: "Set the trailing dot property to specify whether trailing dot will be trimmed or not from the target URI."
|
|
parameters:
|
|
- description: "the allowTrailingDot value."
|
|
name: "allowTrailingDot"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder allowTrailingDot(boolean allowTrailingDot)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.audience(com.azure.storage.file.share.models.ShareAudience)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.audience(ShareAudience audience)"
|
|
name: "audience(ShareAudience audience)"
|
|
nameWithType: "ShareClientBuilder.audience(ShareAudience audience)"
|
|
summary: "Sets the Audience to use for authentication with Azure Active Directory (AAD)."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.file.share.models.ShareAudience\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareAudience\"></xref> to be used when requesting a token from Azure Active Directory (AAD)."
|
|
name: "audience"
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareAudience?alt=com.azure.storage.file.share.models.ShareAudience&text=ShareAudience\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder audience(ShareAudience audience)"
|
|
desc: "Sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.buildAsyncClient()"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.buildAsyncClient()"
|
|
name: "buildAsyncClient()"
|
|
nameWithType: "ShareClientBuilder.buildAsyncClient()"
|
|
summary: "Creates a <xref uid=\"com.azure.storage.file.share.ShareAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareAsyncClient\"></xref> based on options set in the builder."
|
|
syntax: "public ShareAsyncClient buildAsyncClient()"
|
|
desc: "Creates a <xref uid=\"com.azure.storage.file.share.ShareAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareAsyncClient\"></xref> based on options set in the builder. Every time `buildAsyncClient()` is called a new instance of <xref uid=\"com.azure.storage.file.share.ShareAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareAsyncClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then the `pipeline` and <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> are used to create the <xref uid=\"com.azure.storage.file.share.ShareAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
|
|
returns:
|
|
description: "A ShareAsyncClient with the options set from the builder."
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareAsyncClient?alt=com.azure.storage.file.share.ShareAsyncClient&text=ShareAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.buildClient()"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.buildClient()"
|
|
name: "buildClient()"
|
|
nameWithType: "ShareClientBuilder.buildClient()"
|
|
summary: "Creates a <xref uid=\"com.azure.storage.file.share.ShareClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareClient\"></xref> based on options set in the builder."
|
|
syntax: "public ShareClient buildClient()"
|
|
desc: "Creates a <xref uid=\"com.azure.storage.file.share.ShareClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareClient\"></xref> based on options set in the builder. Every time `buildClient()` is called a new instance of <xref uid=\"com.azure.storage.file.share.ShareClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then the `pipeline` and <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> are used to create the <xref uid=\"com.azure.storage.file.share.ShareClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
|
|
returns:
|
|
description: "A ShareClient with the options set from the builder."
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClient?alt=com.azure.storage.file.share.ShareClient&text=ShareClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
name: "clientOptions(ClientOptions clientOptions)"
|
|
nameWithType: "ShareClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
summary: "Allows for setting common properties such as application ID, headers, proxy configuration, etc."
|
|
parameters:
|
|
- description: "A configured instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref>."
|
|
name: "clientOptions"
|
|
type: "<xref href=\"com.azure.core.util.ClientOptions?alt=com.azure.core.util.ClientOptions&text=ClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder clientOptions(ClientOptions clientOptions)"
|
|
desc: "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 <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref> class (a subclass of the <xref uid=\"com.azure.core.util.ClientOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientOptions\"></xref> base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.configuration(com.azure.core.util.Configuration)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.configuration(Configuration configuration)"
|
|
name: "configuration(Configuration configuration)"
|
|
nameWithType: "ShareClientBuilder.configuration(Configuration configuration)"
|
|
summary: "Sets the configuration object used to retrieve environment configuration values during building of the client."
|
|
parameters:
|
|
- description: "Configuration store used to retrieve environment configurations."
|
|
name: "configuration"
|
|
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder configuration(Configuration configuration)"
|
|
desc: "Sets the configuration object used to retrieve environment configuration values during building of the client."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.connectionString(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.connectionString(String connectionString)"
|
|
name: "connectionString(String connectionString)"
|
|
nameWithType: "ShareClientBuilder.connectionString(String connectionString)"
|
|
summary: "Sets the connection string to connect to the service."
|
|
parameters:
|
|
- description: "Connection string of the storage account."
|
|
name: "connectionString"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareClientBuilder connectionString(String connectionString)"
|
|
desc: "Sets the connection string to connect to the service."
|
|
returns:
|
|
description: "the updated ShareClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.credential(com.azure.core.credential.AzureNamedKeyCredential)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.credential(AzureNamedKeyCredential credential)"
|
|
name: "credential(AzureNamedKeyCredential credential)"
|
|
nameWithType: "ShareClientBuilder.credential(AzureNamedKeyCredential credential)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.credential.AzureNamedKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureNamedKeyCredential\"></xref> used to authorize requests sent to the service."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.core.credential.AzureNamedKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureNamedKeyCredential\"></xref>."
|
|
name: "credential"
|
|
type: "<xref href=\"com.azure.core.credential.AzureNamedKeyCredential?alt=com.azure.core.credential.AzureNamedKeyCredential&text=AzureNamedKeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder credential(AzureNamedKeyCredential credential)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.credential.AzureNamedKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureNamedKeyCredential\"></xref> used to authorize requests sent to the service."
|
|
returns:
|
|
description: "the updated ShareClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.credential(com.azure.core.credential.AzureSasCredential)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.credential(AzureSasCredential credential)"
|
|
name: "credential(AzureSasCredential credential)"
|
|
nameWithType: "ShareClientBuilder.credential(AzureSasCredential credential)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.credential.AzureSasCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureSasCredential\"></xref> used to authorize requests sent to the service."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.core.credential.AzureSasCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureSasCredential\"></xref> used to authorize requests sent to the service."
|
|
name: "credential"
|
|
type: "<xref href=\"com.azure.core.credential.AzureSasCredential?alt=com.azure.core.credential.AzureSasCredential&text=AzureSasCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder credential(AzureSasCredential credential)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.credential.AzureSasCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureSasCredential\"></xref> used to authorize requests sent to the service."
|
|
returns:
|
|
description: "the updated ShareClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.credential(TokenCredential tokenCredential)"
|
|
name: "credential(TokenCredential tokenCredential)"
|
|
nameWithType: "ShareClientBuilder.credential(TokenCredential tokenCredential)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
|
|
name: "tokenCredential"
|
|
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder credential(TokenCredential tokenCredential)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> 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 <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> type. Note: only Share-level operations that <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> is compatible with are <xref uid=\"com.azure.storage.file.share.ShareClient.createPermission(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareClient#createPermission(String)\"></xref> and <xref uid=\"com.azure.storage.file.share.ShareClient.getPermission(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareClient#getPermission(String)\"></xref>\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity"
|
|
returns:
|
|
description: "the updated ShareClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.credential(com.azure.storage.common.StorageSharedKeyCredential)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.credential(StorageSharedKeyCredential credential)"
|
|
name: "credential(StorageSharedKeyCredential credential)"
|
|
nameWithType: "ShareClientBuilder.credential(StorageSharedKeyCredential credential)"
|
|
summary: "Sets the <xref uid=\"com.azure.storage.common.StorageSharedKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StorageSharedKeyCredential\"></xref> used to authorize requests sent to the service."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.common.StorageSharedKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StorageSharedKeyCredential\"></xref>."
|
|
name: "credential"
|
|
type: "<xref href=\"com.azure.storage.common.StorageSharedKeyCredential?alt=com.azure.storage.common.StorageSharedKeyCredential&text=StorageSharedKeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder credential(StorageSharedKeyCredential credential)"
|
|
desc: "Sets the <xref uid=\"com.azure.storage.common.StorageSharedKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StorageSharedKeyCredential\"></xref> used to authorize requests sent to the service."
|
|
returns:
|
|
description: "the updated ShareClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.endpoint(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.endpoint(String endpoint)"
|
|
name: "endpoint(String endpoint)"
|
|
nameWithType: "ShareClientBuilder.endpoint(String endpoint)"
|
|
summary: "Sets the endpoint for the Azure Storage File instance that the client will interact with."
|
|
parameters:
|
|
- description: "The URL of the Azure Storage File instance to send service requests to and receive responses\n from."
|
|
name: "endpoint"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareClientBuilder endpoint(String endpoint)"
|
|
desc: "Sets the endpoint for the Azure Storage File instance that the client will interact with.\n\nThe 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.\n\nQuery parameters of the endpoint will be parsed in an attempt to generate a SAS token to authenticate requests sent to the service."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.getDefaultHttpLogOptions()"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.getDefaultHttpLogOptions()"
|
|
name: "getDefaultHttpLogOptions()"
|
|
nameWithType: "ShareClientBuilder.getDefaultHttpLogOptions()"
|
|
summary: "Gets the default log options with Storage headers and query parameters."
|
|
modifiers:
|
|
- "static"
|
|
syntax: "public static HttpLogOptions getDefaultHttpLogOptions()"
|
|
desc: "Gets the default log options with Storage headers and query parameters."
|
|
returns:
|
|
description: "the default log options."
|
|
type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.httpClient(HttpClient httpClient)"
|
|
name: "httpClient(HttpClient httpClient)"
|
|
nameWithType: "ShareClientBuilder.httpClient(HttpClient httpClient)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for sending and receiving requests to and from the service."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for requests."
|
|
name: "httpClient"
|
|
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder httpClient(HttpClient httpClient)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for sending and receiving requests to and from the service.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
|
name: "httpLogOptions(HttpLogOptions logOptions)"
|
|
nameWithType: "ShareClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to and from the service."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to\n and from the service."
|
|
name: "logOptions"
|
|
type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder httpLogOptions(HttpLogOptions logOptions)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to and from the service. If a `logLevel` is not provided, default value of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpLogDetailLevel#NONE\"></xref> is set.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
|
name: "pipeline(HttpPipeline httpPipeline)"
|
|
nameWithType: "ShareClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for the service client."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for sending service requests and receiving responses."
|
|
name: "httpPipeline"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder pipeline(HttpPipeline httpPipeline)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for the service client.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.\n\nThe <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> is not ignored when `pipeline` is set."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
name: "retryOptions(RetryOptions retryOptions)"
|
|
nameWithType: "ShareClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> for all the requests made through the client."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> to use for all the requests made through the client."
|
|
name: "retryOptions"
|
|
type: "<xref href=\"com.azure.core.http.policy.RetryOptions?alt=com.azure.core.http.policy.RetryOptions&text=RetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder retryOptions(RetryOptions retryOptions)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> for all the requests made through the client.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.\n\nSetting this is mutually exclusive with using <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.retryOptions(com.azure.storage.common.policy.RequestRetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RequestRetryOptions)\"></xref>. Consider using <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.retryOptions(com.azure.storage.common.policy.RequestRetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RequestRetryOptions)\"></xref> to also set storage specific options."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.retryOptions(com.azure.storage.common.policy.RequestRetryOptions)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.retryOptions(RequestRetryOptions retryOptions)"
|
|
name: "retryOptions(RequestRetryOptions retryOptions)"
|
|
nameWithType: "ShareClientBuilder.retryOptions(RequestRetryOptions retryOptions)"
|
|
summary: "Sets the request retry options for all the requests made through the client."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.common.policy.RequestRetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestRetryOptions\"></xref>."
|
|
name: "retryOptions"
|
|
type: "<xref href=\"com.azure.storage.common.policy.RequestRetryOptions?alt=com.azure.storage.common.policy.RequestRetryOptions&text=RequestRetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder retryOptions(RequestRetryOptions retryOptions)"
|
|
desc: "Sets the request retry options for all the requests made through the client. Setting this is mutually exclusive with using <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object."
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.sasToken(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.sasToken(String sasToken)"
|
|
name: "sasToken(String sasToken)"
|
|
nameWithType: "ShareClientBuilder.sasToken(String sasToken)"
|
|
summary: "Sets the SAS token used to authorize requests sent to the service."
|
|
parameters:
|
|
- description: "The SAS token to use for authenticating requests. This string should only be the query parameters\n (with or without a leading '?') and not a full url."
|
|
name: "sasToken"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareClientBuilder sasToken(String sasToken)"
|
|
desc: "Sets the SAS token used to authorize requests sent to the service."
|
|
returns:
|
|
description: "the updated ShareClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.serviceVersion(com.azure.storage.file.share.ShareServiceVersion)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.serviceVersion(ShareServiceVersion version)"
|
|
name: "serviceVersion(ShareServiceVersion version)"
|
|
nameWithType: "ShareClientBuilder.serviceVersion(ShareServiceVersion version)"
|
|
summary: "Sets the <xref uid=\"com.azure.storage.file.share.ShareServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareServiceVersion\"></xref> that is used when making API requests."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.file.share.ShareServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareServiceVersion\"></xref> of the service to be used when making requests."
|
|
name: "version"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareServiceVersion?alt=com.azure.storage.file.share.ShareServiceVersion&text=ShareServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder serviceVersion(ShareServiceVersion version)"
|
|
desc: "Sets the <xref uid=\"com.azure.storage.file.share.ShareServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareServiceVersion\"></xref> that is used when making API requests.\n\nIf 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.\n\nTargeting a specific service version may also mean that the service will return an error for newer APIs."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.shareName(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.shareName(String shareName)"
|
|
name: "shareName(String shareName)"
|
|
nameWithType: "ShareClientBuilder.shareName(String shareName)"
|
|
summary: "Sets the share that the constructed clients will interact with"
|
|
parameters:
|
|
- description: "Name of the share"
|
|
name: "shareName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareClientBuilder shareName(String shareName)"
|
|
desc: "Sets the share that the constructed clients will interact with"
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.shareTokenIntent(com.azure.storage.file.share.models.ShareTokenIntent)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.shareTokenIntent(ShareTokenIntent shareTokenIntent)"
|
|
name: "shareTokenIntent(ShareTokenIntent shareTokenIntent)"
|
|
nameWithType: "ShareClientBuilder.shareTokenIntent(ShareTokenIntent shareTokenIntent)"
|
|
summary: "Sets the <xref uid=\"com.azure.storage.file.share.models.ShareTokenIntent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareTokenIntent\"></xref> that specifies whether there is intent for a file to be backed up."
|
|
parameters:
|
|
- description: "the <xref uid=\"com.azure.storage.file.share.models.ShareTokenIntent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareTokenIntent\"></xref> value."
|
|
name: "shareTokenIntent"
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareTokenIntent?alt=com.azure.storage.file.share.models.ShareTokenIntent&text=ShareTokenIntent\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareClientBuilder shareTokenIntent(ShareTokenIntent shareTokenIntent)"
|
|
desc: "Sets the <xref uid=\"com.azure.storage.file.share.models.ShareTokenIntent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareTokenIntent\"></xref> that specifies whether there is intent for a file to be backed up. This is currently required when using <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref>, and ignored for other forms of authentication."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.ShareClientBuilder.snapshot(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.ShareClientBuilder.snapshot(String snapshot)"
|
|
name: "snapshot(String snapshot)"
|
|
nameWithType: "ShareClientBuilder.snapshot(String snapshot)"
|
|
summary: "Sets the snapshot that the constructed clients will interact with."
|
|
parameters:
|
|
- description: "Identifier of the snapshot"
|
|
name: "snapshot"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareClientBuilder snapshot(String snapshot)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the updated ShareClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "This class provides a fluent builder API to help aid the configuration and instantiation of the <xref uid=\"com.azure.storage.file.share.ShareClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareClients\"></xref> and <xref uid=\"com.azure.storage.file.share.ShareAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareAsyncClients\"></xref>, calling <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> constructs an instance of ShareClient and calling <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> constructs an instance of ShareAsyncClient.\n\nThe client needs the endpoint of the Azure Storage File service, name of the share, and authorization credential. <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> gives the builder the endpoint and may give the builder the <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.shareName(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"shareName\"></xref> and a <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.sasToken(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SAS token\"></xref> that authorizes the client.\n\n**Instantiating a synchronous Share Client with SAS token**\n\n```java\nShareClient shareClient = new ShareClientBuilder()\n .endpoint(\"https://${accountName}.file.core.windows.net?${SASToken}\")\n .shareName(\"myshare\")\n .buildClient();\n```\n\n**Instantiating an Asynchronous Share Client with SAS token**\n\n```java\nShareAsyncClient shareAsyncClient = new ShareClientBuilder()\n .endpoint(\"https://{accountName}.file.core.windows.net?{SASToken}\")\n .shareName(\"myshare\")\n .buildAsyncClient();\n```\n\nIf the `endpoint` doesn't contain the query parameters to construct a SAS token it may be set using <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.sasToken(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"sasToken\"></xref>.\n\n```java\nShareClient shareClient = new ShareClientBuilder()\n .endpoint(\"https://${accountName}.file.core.windows.net\")\n .sasToken(\"${SASTokenQueryParams}\")\n .shareName(\"myshare\")\n .buildClient();\n```\n\n```java\nShareAsyncClient shareAsyncClient = new ShareClientBuilder()\n .endpoint(\"https://{accountName}.file.core.windows.net\")\n .sasToken(\"${SASTokenQueryParams}\")\n .shareName(\"myshare\")\n .buildAsyncClient();\n```\n\nAnother way to authenticate the client is using a <xref uid=\"com.azure.storage.common.StorageSharedKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StorageSharedKeyCredential\"></xref>. To create a StorageSharedKeyCredential a connection string from the Storage File service must be used. Set the StorageSharedKeyCredential with <xref uid=\"com.azure.storage.file.share.ShareClientBuilder.connectionString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"connectionString\"></xref>. If the builder has both a SAS token and StorageSharedKeyCredential the StorageSharedKeyCredential will be preferred when authorizing requests sent to the service.\n\n**Instantiating a synchronous Share Client with connection string.**\n\n```java\nString connectionString = \"DefaultEndpointsProtocol=https;AccountName={name};AccountKey={key};\"\n + \"EndpointSuffix={core.windows.net}\";\n ShareClient shareClient = new ShareClientBuilder()\n .connectionString(connectionString).shareName(\"myshare\")\n .buildClient();\n```\n\n**Instantiating an Asynchronous Share Client with connection string.**\n\n```java\nString connectionString = \"DefaultEndpointsProtocol=https;AccountName={name};AccountKey={key};\"\n + \"EndpointSuffix={core.windows.net}\";\n ShareAsyncClient shareAsyncClient = new ShareClientBuilder()\n .connectionString(connectionString).shareName(\"myshare\")\n .buildAsyncClient();\n```"
|
|
implements:
|
|
- "<xref href=\"com.azure.core.client.traits.AzureNamedKeyCredentialTrait?alt=com.azure.core.client.traits.AzureNamedKeyCredentialTrait&text=AzureNamedKeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.AzureSasCredentialTrait?alt=com.azure.core.client.traits.AzureSasCredentialTrait&text=AzureSasCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.ConnectionStringTrait?alt=com.azure.core.client.traits.ConnectionStringTrait&text=ConnectionStringTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.ShareClientBuilder?alt=com.azure.storage.file.share.ShareClientBuilder&text=ShareClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.storage.file.share"
|
|
artifact: com.azure:azure-storage-file-share:12.24.0
|