382 строки
51 KiB
YAML
382 строки
51 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.blob.BlobContainerClientBuilder"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder"
|
|
name: "BlobContainerClientBuilder"
|
|
nameWithType: "BlobContainerClientBuilder"
|
|
summary: "This class provides a fluent builder API to help aid the configuration and instantiation of <xref uid=\"com.azure.storage.blob.BlobContainerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerClients\"></xref> and <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClients\"></xref>, call <xref uid=\"com.azure.storage.blob.BlobContainerClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> and <xref uid=\"com.azure.storage.blob.BlobContainerClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired 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 final class **BlobContainerClientBuilder**</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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" 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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" 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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" 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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" 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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" 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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" 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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.BlobContainerClientBuilder()"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.BlobContainerClientBuilder()"
|
|
name: "BlobContainerClientBuilder()"
|
|
nameWithType: "BlobContainerClientBuilder.BlobContainerClientBuilder()"
|
|
summary: "Creates a builder instance that is able to configure and construct <xref uid=\"com.azure.storage.blob.BlobContainerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ContainerClients\"></xref> and <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ContainerAsyncClients\"></xref>."
|
|
syntax: "public BlobContainerClientBuilder()"
|
|
desc: "Creates a builder instance that is able to configure and construct <xref uid=\"com.azure.storage.blob.BlobContainerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ContainerClients\"></xref> and <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ContainerAsyncClients\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.addPolicy(HttpPipelinePolicy pipelinePolicy)"
|
|
name: "addPolicy(HttpPipelinePolicy pipelinePolicy)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder 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 BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.audience(com.azure.storage.blob.models.BlobAudience)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.audience(BlobAudience audience)"
|
|
name: "audience(BlobAudience audience)"
|
|
nameWithType: "BlobContainerClientBuilder.audience(BlobAudience audience)"
|
|
summary: "Sets the Audience to use for authentication with Azure Active Directory (AAD)."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.BlobAudience\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobAudience\"></xref> to be used when requesting a token from Azure Active Directory (AAD)."
|
|
name: "audience"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobAudience?alt=com.azure.storage.blob.models.BlobAudience&text=BlobAudience\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlobContainerClientBuilder audience(BlobAudience 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 BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.blobContainerEncryptionScope(com.azure.storage.blob.models.BlobContainerEncryptionScope)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.blobContainerEncryptionScope(BlobContainerEncryptionScope blobContainerEncryptionScope)"
|
|
name: "blobContainerEncryptionScope(BlobContainerEncryptionScope blobContainerEncryptionScope)"
|
|
nameWithType: "BlobContainerClientBuilder.blobContainerEncryptionScope(BlobContainerEncryptionScope blobContainerEncryptionScope)"
|
|
summary: "Sets the <xref uid=\"com.azure.storage.blob.models.BlobContainerEncryptionScope\" data-throw-if-not-resolved=\"false\" data-raw-source=\"encryption scope\"></xref> that is used to determine how blob contents are encrypted on the server."
|
|
parameters:
|
|
- description: "Encryption scope containing the encryption key information."
|
|
name: "blobContainerEncryptionScope"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobContainerEncryptionScope?alt=com.azure.storage.blob.models.BlobContainerEncryptionScope&text=BlobContainerEncryptionScope\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlobContainerClientBuilder blobContainerEncryptionScope(BlobContainerEncryptionScope blobContainerEncryptionScope)"
|
|
desc: "Sets the <xref uid=\"com.azure.storage.blob.models.BlobContainerEncryptionScope\" data-throw-if-not-resolved=\"false\" data-raw-source=\"encryption scope\"></xref> that is used to determine how blob contents are encrypted on the server."
|
|
returns:
|
|
description: "the updated BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.buildAsyncClient()"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.buildAsyncClient()"
|
|
name: "buildAsyncClient()"
|
|
nameWithType: "BlobContainerClientBuilder.buildAsyncClient()"
|
|
summary: "Creates a <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> from the configured options."
|
|
syntax: "public BlobContainerAsyncClient buildAsyncClient()"
|
|
desc: "Creates a <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> from the configured options.\n\n**Code Samples**\n\n```java\nBlobContainerAsyncClient client = new BlobContainerClientBuilder()\n .connectionString(connectionString)\n .buildAsyncClient();\n```"
|
|
returns:
|
|
description: "a <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> created from the configurations in this builder."
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerAsyncClient?alt=com.azure.storage.blob.BlobContainerAsyncClient&text=BlobContainerAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.buildClient()"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.buildClient()"
|
|
name: "buildClient()"
|
|
nameWithType: "BlobContainerClientBuilder.buildClient()"
|
|
summary: "Creates a <xref uid=\"com.azure.storage.blob.BlobContainerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerClient\"></xref> from the configured options."
|
|
syntax: "public BlobContainerClient buildClient()"
|
|
desc: "Creates a <xref uid=\"com.azure.storage.blob.BlobContainerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerClient\"></xref> from the configured options.\n\n**Code Samples**\n\n```java\nBlobContainerClient client = new BlobContainerClientBuilder()\n .connectionString(connectionString)\n .buildClient();\n```"
|
|
returns:
|
|
description: "a <xref uid=\"com.azure.storage.blob.BlobContainerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerClient\"></xref> created from the configurations in this builder."
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClient?alt=com.azure.storage.blob.BlobContainerClient&text=BlobContainerClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
name: "clientOptions(ClientOptions clientOptions)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder 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 BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.configuration(com.azure.core.util.Configuration)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.configuration(Configuration configuration)"
|
|
name: "configuration(Configuration configuration)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder configuration(Configuration configuration)"
|
|
desc: "Sets the configuration object used to retrieve environment configuration values during building of the client."
|
|
returns:
|
|
description: "the updated BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.connectionString(java.lang.String)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.connectionString(String connectionString)"
|
|
name: "connectionString(String connectionString)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder connectionString(String connectionString)"
|
|
desc: "Sets the connection string to connect to the service."
|
|
returns:
|
|
description: "the updated BlobContainerClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.containerName(java.lang.String)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.containerName(String containerName)"
|
|
name: "containerName(String containerName)"
|
|
nameWithType: "BlobContainerClientBuilder.containerName(String containerName)"
|
|
summary: "Sets the name of the container."
|
|
parameters:
|
|
- description: "Name of the container. If the value <code>null</code> or empty the root container, <code>$root</code>\n , will be used."
|
|
name: "containerName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public BlobContainerClientBuilder containerName(String containerName)"
|
|
desc: "Sets the name of the container."
|
|
returns:
|
|
description: "the updated BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.credential(com.azure.core.credential.AzureNamedKeyCredential)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.credential(AzureNamedKeyCredential credential)"
|
|
name: "credential(AzureNamedKeyCredential credential)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder 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 BlobContainerClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.credential(com.azure.core.credential.AzureSasCredential)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.credential(AzureSasCredential credential)"
|
|
name: "credential(AzureSasCredential credential)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder 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 BlobContainerClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.credential(TokenCredential credential)"
|
|
name: "credential(TokenCredential credential)"
|
|
nameWithType: "BlobContainerClientBuilder.credential(TokenCredential credential)"
|
|
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: "credential"
|
|
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlobContainerClientBuilder credential(TokenCredential credential)"
|
|
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.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity"
|
|
returns:
|
|
description: "the updated BlobContainerClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.credential(com.azure.storage.common.StorageSharedKeyCredential)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.credential(StorageSharedKeyCredential credential)"
|
|
name: "credential(StorageSharedKeyCredential credential)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder 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 BlobContainerClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.customerProvidedKey(com.azure.storage.blob.models.CustomerProvidedKey)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.customerProvidedKey(CustomerProvidedKey customerProvidedKey)"
|
|
name: "customerProvidedKey(CustomerProvidedKey customerProvidedKey)"
|
|
nameWithType: "BlobContainerClientBuilder.customerProvidedKey(CustomerProvidedKey customerProvidedKey)"
|
|
summary: "Sets the <xref uid=\"com.azure.storage.blob.models.CustomerProvidedKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"customer provided key\"></xref> that is used to encrypt blob contents on the server."
|
|
parameters:
|
|
- description: "Customer provided key containing the encryption key information."
|
|
name: "customerProvidedKey"
|
|
type: "<xref href=\"com.azure.storage.blob.models.CustomerProvidedKey?alt=com.azure.storage.blob.models.CustomerProvidedKey&text=CustomerProvidedKey\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlobContainerClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)"
|
|
desc: "Sets the <xref uid=\"com.azure.storage.blob.models.CustomerProvidedKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"customer provided key\"></xref> that is used to encrypt blob contents on the server."
|
|
returns:
|
|
description: "the updated BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.encryptionScope(java.lang.String)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.encryptionScope(String encryptionScope)"
|
|
name: "encryptionScope(String encryptionScope)"
|
|
nameWithType: "BlobContainerClientBuilder.encryptionScope(String encryptionScope)"
|
|
summary: "Sets the `encryption scope` that is used to encrypt blob contents on the server."
|
|
parameters:
|
|
- description: "Encryption scope containing the encryption key information."
|
|
name: "encryptionScope"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public BlobContainerClientBuilder encryptionScope(String encryptionScope)"
|
|
desc: "Sets the `encryption scope` that is used to encrypt blob contents on the server."
|
|
returns:
|
|
description: "the updated BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.endpoint(java.lang.String)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.endpoint(String endpoint)"
|
|
name: "endpoint(String endpoint)"
|
|
nameWithType: "BlobContainerClientBuilder.endpoint(String endpoint)"
|
|
summary: "Sets the service endpoint, additionally parses it for information (SAS token, container name)"
|
|
parameters:
|
|
- description: "URL of the service"
|
|
name: "endpoint"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public BlobContainerClientBuilder endpoint(String endpoint)"
|
|
desc: "Sets the service endpoint, additionally parses it for information (SAS token, container name)"
|
|
returns:
|
|
description: "the updated BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.getDefaultHttpLogOptions()"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.getDefaultHttpLogOptions()"
|
|
name: "getDefaultHttpLogOptions()"
|
|
nameWithType: "BlobContainerClientBuilder.getDefaultHttpLogOptions()"
|
|
summary: "Gets the default Storage allowlist log headers and query parameters."
|
|
modifiers:
|
|
- "static"
|
|
syntax: "public static HttpLogOptions getDefaultHttpLogOptions()"
|
|
desc: "Gets the default Storage allowlist log headers and query parameters."
|
|
returns:
|
|
description: "the default http 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.blob.BlobContainerClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.httpClient(HttpClient httpClient)"
|
|
name: "httpClient(HttpClient httpClient)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder 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 BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
|
name: "httpLogOptions(HttpLogOptions logOptions)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder 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 BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
|
name: "pipeline(HttpPipeline httpPipeline)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder 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.blob.BlobContainerClientBuilder.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 BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
name: "retryOptions(RetryOptions retryOptions)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder 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.blob.BlobContainerClientBuilder.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.blob.BlobContainerClientBuilder.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 BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.retryOptions(com.azure.storage.common.policy.RequestRetryOptions)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.retryOptions(RequestRetryOptions retryOptions)"
|
|
name: "retryOptions(RequestRetryOptions retryOptions)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder 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.blob.BlobContainerClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
|
|
returns:
|
|
description: "the updated BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.sasToken(java.lang.String)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.sasToken(String sasToken)"
|
|
name: "sasToken(String sasToken)"
|
|
nameWithType: "BlobContainerClientBuilder.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 BlobContainerClientBuilder sasToken(String sasToken)"
|
|
desc: "Sets the SAS token used to authorize requests sent to the service."
|
|
returns:
|
|
description: "the updated BlobContainerClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.serviceVersion(com.azure.storage.blob.BlobServiceVersion)"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.serviceVersion(BlobServiceVersion version)"
|
|
name: "serviceVersion(BlobServiceVersion version)"
|
|
nameWithType: "BlobContainerClientBuilder.serviceVersion(BlobServiceVersion version)"
|
|
summary: "Sets the <xref uid=\"com.azure.storage.blob.BlobServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceVersion\"></xref> that is used when making API requests."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.blob.BlobServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceVersion\"></xref> of the service to be used when making requests."
|
|
name: "version"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobServiceVersion?alt=com.azure.storage.blob.BlobServiceVersion&text=BlobServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlobContainerClientBuilder serviceVersion(BlobServiceVersion version)"
|
|
desc: "Sets the <xref uid=\"com.azure.storage.blob.BlobServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceVersion\"></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 BlobContainerClientBuilder object"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.BlobContainerClientBuilder.setAnonymousAccess()"
|
|
fullName: "com.azure.storage.blob.BlobContainerClientBuilder.setAnonymousAccess()"
|
|
name: "setAnonymousAccess()"
|
|
nameWithType: "BlobContainerClientBuilder.setAnonymousAccess()"
|
|
summary: "Clears the credential used to authorize the request."
|
|
syntax: "public BlobContainerClientBuilder setAnonymousAccess()"
|
|
desc: "Clears the credential used to authorize the request.\n\nThis is for containers that are publicly accessible."
|
|
returns:
|
|
description: "the updated BlobContainerClientBuilder"
|
|
type: "<xref href=\"com.azure.storage.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "This class provides a fluent builder API to help aid the configuration and instantiation of <xref uid=\"com.azure.storage.blob.BlobContainerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerClients\"></xref> and <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClients\"></xref>, call <xref uid=\"com.azure.storage.blob.BlobContainerClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> and <xref uid=\"com.azure.storage.blob.BlobContainerClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client.\n\nThe following information must be provided on this builder:\n\n * the endpoint through `.endpoint()`, including the container name, in the format of `https://{accountName}.blob.core.windows.net/{containerName}`.\n * the credential through `.credential()` or `.connectionString()` if the container is not publicly accessible."
|
|
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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" 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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" 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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" 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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" 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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" 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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" 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.blob.BlobContainerClientBuilder?alt=com.azure.storage.blob.BlobContainerClientBuilder&text=BlobContainerClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.storage.blob"
|
|
artifact: com.azure:azure-storage-blob:12.27.1
|