Package com.azure.search.documents.indexes

Class SearchIndexerClientBuilder

  • public class SearchIndexerClientBuilder
extends Object
    This class provides a fluent builder API to help aid the configuration and instantiation of SearchIndexerClients and SearchIndexerAsyncClients. Call buildClient and buildAsyncClient respectively to construct an instance of the desired client.

    The following must be provided to construct a client instance.

    • The Azure Cognitive Search service URL.
    • An AzureKeyCredential that grants access to the Azure Cognitive Search service.

    Instantiating an asynchronous Search Indexer Client

     SearchIndexerAsyncClient searchIndexerAsyncClient = new SearchIndexerClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .buildAsyncClient();

    Instantiating a synchronous Search Indexer Client

     SearchIndexerClient searchIndexerClient = new SearchIndexerClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .buildClient();
    See Also:
    SearchIndexerClient, SearchIndexerAsyncClient

    • Method Detail

      • endpoint

        public SearchIndexerClientBuilder endpoint​(String endpoint)
        Sets the service endpoint for the Azure Cognitive Search instance.
        Parameters:
        endpoint - The URL of the Azure Cognitive Search instance.
        Returns:
        The updated SearchIndexerClientBuilder object.
        Throws:
        IllegalArgumentException - If endpoint is null or it cannot be parsed into a valid URL.

      • credential

        public SearchIndexerClientBuilder credential​(com.azure.core.credential.AzureKeyCredential credential)
        Sets the AzureKeyCredential used to authenticate HTTP requests.
        Parameters:
        credential - The AzureKeyCredential used to authenticate HTTP requests.
        Returns:
        The updated SearchIndexerClientBuilder object.

      • credential

        public SearchIndexerClientBuilder credential​(com.azure.core.credential.TokenCredential credential)
        Sets the TokenCredential used to authenticate HTTP requests.
        Parameters:
        credential - The TokenCredential used to authenticate HTTP requests.
        Returns:
        The updated SearchIndexerClientBuilder object.

      • httpLogOptions

        public SearchIndexerClientBuilder httpLogOptions​(com.azure.core.http.policy.HttpLogOptions logOptions)
        Sets the logging configuration for HTTP requests and responses.

        If logging configurations aren't provided HTTP requests and responses won't be logged.

        Parameters:
        logOptions - The logging configuration for HTTP requests and responses.
        Returns:
        The updated SearchIndexerClientBuilder object.

      • getDefaultLogOptions

        public static com.azure.core.http.policy.HttpLogOptions getDefaultLogOptions()
        Gets the default Azure Search headers and query parameters allow list.
        Returns:
        The default HttpLogOptions allow list.

      • clientOptions

        public SearchIndexerClientBuilder clientOptions​(com.azure.core.util.ClientOptions clientOptions)
        Sets the client options such as application ID and custom headers to set on a request.
        Parameters:
        clientOptions - The client options.
        Returns:
        The updated SearchIndexerClientBuilder object.

      • addPolicy

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

        This method may be called multiple times, each time it is called the policy will be added to the end of added policy list. All policies will be added after the retry policy.

        Parameters:
        policy - The pipeline policies to added to the policy list.
        Returns:
        The updated SearchIndexerClientBuilder object.
        Throws:
        NullPointerException - If policy is null.

      • httpClient

        public SearchIndexerClientBuilder httpClient​(com.azure.core.http.HttpClient client)
        Sets the HTTP client to use for sending requests and receiving responses.
        Parameters:
        client - The HTTP client that will handle sending requests and receiving responses.
        Returns:
        The updated SearchIndexerClientBuilder object.

      • pipeline

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

        If pipeline is set, all other settings are ignored, aside from endpoint when building a SearchIndexerClient or SearchIndexerAsyncClient.

        Parameters:
        httpPipeline - The HTTP pipeline to use for sending service requests and receiving responses.
        Returns:
        The updated SearchIndexerClientBuilder object.

      • configuration

        public SearchIndexerClientBuilder configuration​(com.azure.core.util.Configuration configuration)
        Sets the configuration store that is used during construction of the service client.

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

        Parameters:
        configuration - The configuration store that will be used.
        Returns:
        The updated SearchIndexerClientBuilder object.

      • retryPolicy

        public SearchIndexerClientBuilder retryPolicy​(com.azure.core.http.policy.RetryPolicy retryPolicy)
        Sets the HttpPipelinePolicy that will attempt to retry requests when needed.

        A default retry policy will be supplied if one isn't provided.

        Parameters:
        retryPolicy - The RetryPolicy that will attempt to retry requests when needed.
        Returns:
        The updated SearchIndexerClientBuilder object.

      • serviceVersion

        public SearchIndexerClientBuilder serviceVersion​(SearchServiceVersion serviceVersion)
        Sets the SearchServiceVersion that is used when making API requests.

        If a service version is not provided, SearchServiceVersion.getLatest() will be used as a default. When this default is used updating to a newer client library may result in a newer version of the service being used.

        Parameters:
        serviceVersion - The version of the service to be used when making requests.
        Returns:
        The updated SearchIndexerClientBuilder object.