Package com.azure.data.tables

Class TableClientBuilder

    • Constructor Detail

      • TableClientBuilder

        public TableClientBuilder()
        Creates a builder instance that is able to configure and construct TableClient and TableAsyncClient objects.

    • Method Detail

      • buildClient

        public TableClient buildClient()
        Creates a TableClient based on options set in the builder.
        Returns:
        A TableClient created from the configurations in this builder.
        Throws:
        NullPointerException - If endpoint or tableName are null.
        IllegalArgumentException - If endpoint is malformed or empty or if tableName is empty.
        IllegalStateException - If no form of authentication or endpoint have been specified or if multiple forms of authentication are provided, with the exception of sasToken + connectionString. Also thrown if endpoint and/or sasToken are set alongside a connectionString and the endpoint and/or SAS token in the latter are different than the former, respectively.

      • buildAsyncClient

        public TableAsyncClient buildAsyncClient()
        Creates a TableAsyncClient based on options set in the builder.
        Returns:
        A TableAsyncClient created from the configurations in this builder.
        Throws:
        NullPointerException - If endpoint or tableName are null.
        IllegalArgumentException - If endpoint is malformed or empty or if tableName is empty.
        IllegalStateException - If no form of authentication or endpoint have been specified or if multiple forms of authentication are provided, with the exception of sasToken + connectionString. Also thrown if endpoint and/or sasToken are set alongside a connectionString and the endpoint and/or SAS token in the latter are different than the former, respectively.

      • connectionString

        public TableClientBuilder connectionString​(String connectionString)
        Sets the connection string to connect to the service.
        Specified by:
        connectionString in interface com.azure.core.client.traits.ConnectionStringTrait<TableClientBuilder>
        Parameters:
        connectionString - Connection string of the storage or CosmosDB table API account.
        Returns:
        The updated TableClientBuilder.
        Throws:
        NullPointerException - If connectionString is null.
        IllegalArgumentException - If connectionString isn't a valid connection string.

      • pipeline

        public TableClientBuilder pipeline​(com.azure.core.http.HttpPipeline pipeline)
        Sets the HttpPipeline to use for the service client.

        Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline 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 HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

        The endpoint is not ignored when pipeline is set.

        Specified by:
        pipeline in interface com.azure.core.client.traits.HttpTrait<TableClientBuilder>
        Parameters:
        pipeline - HttpPipeline to use for sending service requests and receiving responses.
        Returns:
        The updated TableClientBuilder.

      • configuration

        public TableClientBuilder configuration​(com.azure.core.util.Configuration configuration)
        Sets the configuration object used to retrieve environment configuration values during building of the client.

        The default configuration store is a clone of the global configuration store, use Configuration.NONE to bypass using configuration settings during construction.

        Specified by:
        configuration in interface com.azure.core.client.traits.ConfigurationTrait<TableClientBuilder>
        Parameters:
        configuration - Configuration store used to retrieve environment configuration.
        Returns:
        The updated TableClientBuilder.

      • httpClient

        public TableClientBuilder httpClient​(com.azure.core.http.HttpClient httpClient)
        Sets the HttpClient to use for sending and receiving requests to and from the service.

        Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline 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 HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

        Specified by:
        httpClient in interface com.azure.core.client.traits.HttpTrait<TableClientBuilder>
        Parameters:
        httpClient - The HttpClient to use for requests.
        Returns:
        The updated TableClientBuilder.

      • httpLogOptions

        public TableClientBuilder httpLogOptions​(com.azure.core.http.policy.HttpLogOptions logOptions)
        Sets the logging configuration to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

        Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline 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 HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

        Specified by:
        httpLogOptions in interface com.azure.core.client.traits.HttpTrait<TableClientBuilder>
        Parameters:
        logOptions - The logging configuration to use when sending and receiving requests to and from the service.
        Returns:
        The updated TableClientBuilder.

      • addPolicy

        public TableClientBuilder addPolicy​(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
        Adds a pipeline policy to apply on each request sent.

        Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline 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 HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

        Specified by:
        addPolicy in interface com.azure.core.client.traits.HttpTrait<TableClientBuilder>
        Parameters:
        pipelinePolicy - A pipeline policy.
        Returns:
        The updated TableClientBuilder.
        Throws:
        NullPointerException - If pipelinePolicy is null.

      • retryPolicy

        public TableClientBuilder retryPolicy​(com.azure.core.http.policy.RetryPolicy retryPolicy)
        Sets the request RetryPolicy for all the requests made through the client. The default RetryPolicy will be used in the pipeline, if not provided. Setting this is mutually exclusive with using retryOptions(RetryOptions).
        Parameters:
        retryPolicy - RetryPolicy.
        Returns:
        The updated TableClientBuilder.

      • retryOptions

        public TableClientBuilder retryOptions​(com.azure.core.http.policy.RetryOptions retryOptions)
        Sets the RetryOptions for all the requests made through the client.

        Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline 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 HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

        Setting this is mutually exclusive with using retryPolicy(RetryPolicy).

        Specified by:
        retryOptions in interface com.azure.core.client.traits.HttpTrait<TableClientBuilder>
        Parameters:
        retryOptions - The RetryOptions to use for all the requests made through the client.
        Returns:
        The updated TableClientBuilder object.

      • clientOptions

        public TableClientBuilder clientOptions​(com.azure.core.util.ClientOptions clientOptions)
        Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the HttpClientOptions class (a subclass of the ClientOptions base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.

        Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline 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 HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

        Specified by:
        clientOptions in interface com.azure.core.client.traits.HttpTrait<TableClientBuilder>
        Parameters:
        clientOptions - A configured instance of HttpClientOptions.
        Returns:
        The updated TableClientBuilder.
        See Also:
        HttpClientOptions

      • enableTenantDiscovery

        public TableClientBuilder enableTenantDiscovery()
        Enable tenant discovery when authenticating with the Table Service. This functionality is disabled by default and only available for Storage endpoints using service version 2020_12_06.

        Enable this if there is a chance for your application and the Storage account it communicates with to reside in different tenants. If this is enabled, clients created using this builder will make an unauthorized initial service request that will be met with a 401 response containing an authentication challenge, which will be subsequently used to retrieve an access token to authorize all further requests with.

        Returns:
        The updated TableClientBuilder.