Package com.azure.search.documents

Class SearchClientBuilder

java.lang.Object
com.azure.search.documents.SearchClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.AzureKeyCredentialTrait<SearchClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<SearchClientBuilder>, com.azure.core.client.traits.EndpointTrait<SearchClientBuilder>, com.azure.core.client.traits.HttpTrait<SearchClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<SearchClientBuilder>
public final class SearchClientBuilder extends Object implements com.azure.core.client.traits.AzureKeyCredentialTrait<SearchClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<SearchClientBuilder>, com.azure.core.client.traits.EndpointTrait<SearchClientBuilder>, com.azure.core.client.traits.HttpTrait<SearchClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<SearchClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation of SearchClients and SearchAsyncClients.

Overview

This client allows you to create instances of SearchClient and SearchAsyncClient to utilize synchronous and asynchronous APIs respectively to interact with Azure AI Search.

Getting Started

Authentication

Azure AI Search supports Microsoft Entra ID (role-based) authentication and API keys for authentication.

For more information about the scopes of authorization, see the Azure AI Search Security Overview documentation.

Building and Authenticating a SearchClient or SearchAsyncClient using API keys

To build an instance of SearchClient or SearchAsyncClient using API keys, call buildClient and buildAsyncClient respectively from the SearchClientBuilder.

The following must be provided to construct a client instance.

  • The Azure AI Search service URL.
  • An API Key that grants access to the Azure AI Search service.

Instantiating a synchronous Search Client

 SearchClient searchClient = new SearchClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .indexName("{indexName}")
     .buildClient();

Instantiating an asynchronous Search Client

 SearchAsyncClient searchAsyncClient = new SearchClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .indexName("{indexName}")
     .buildAsyncClient();

Building and Authenticating a SearchClient or SearchAsyncClient using Microsoft Entra ID

You can also create a SearchClient or SearchAsyncClient using Microsoft Entra ID authentication. Your user or service principal must be assigned the "Search Index Data Reader" role. Using the DefaultAzureCredential you can authenticate a service using Managed Identity or a service principal, authenticate as a developer working on an application, and more all without changing code. Please refer the documentation for instructions on how to connect to Azure AI Search using Azure role-based access control (Azure RBAC).

Before you can use the `DefaultAzureCredential`, or any credential type from Azure.Identity, you'll first need to install the Azure.Identity package.

To use DefaultAzureCredential with a client ID and secret, you'll need to set the `AZURE_TENANT_ID`, `AZURE_CLIENT_ID`, and `AZURE_CLIENT_SECRET` environment variables; alternatively, you can pass those values to the `ClientSecretCredential` also in azure-identity.

Make sure you use the right namespace for DefaultAzureCredential at the top of your source file: 

 import com.azure.identity.DefaultAzureCredential;
 import com.azure.identity.DefaultAzureCredentialBuilder;

Then you can create an instance of DefaultAzureCredential and pass it to a new instance of your client:

The following sample builds a SearchClient using DefaultAzureCredential.

Instantiating a synchronous Search Client

 DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();

 SearchClient searchClient = new SearchClientBuilder()
     .credential(credential)
     .endpoint("{endpoint}")
     .indexName("{indexName}")
     .buildClient();

Instantiating an asynchronous Search Client

 DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();

 SearchAsyncClient searchAsyncClient = new SearchClientBuilder()
     .credential(credential)
     .endpoint("{endpoint}")
     .indexName("{indexName}")
     .buildAsyncClient();
See Also:

  • Constructor Details

    • SearchClientBuilder

      public SearchClientBuilder()
      Creates a builder instance that is able to configure and construct SearchClients and SearchAsyncClients.

  • Method Details

    • buildClient

      public SearchClient buildClient()
      Creates a SearchClient based on options set in the builder. Every time buildClient() is called a new instance of SearchClient is created.

      If pipeline is set, then only the pipeline, endpoint, and indexName are used to create the client. All other builder settings are ignored.

      Returns:
      A SearchClient with the options set from the builder.
      Throws:
      NullPointerException - If indexName or endpoint are null.
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • buildAsyncClient

      public SearchAsyncClient buildAsyncClient()
      Creates a SearchAsyncClient based on options set in the builder. Every time buildAsyncClient() is called a new instance of SearchAsyncClient is created.

      If pipeline is set, then only the pipeline, endpoint, and indexName are used to create the client. All other builder settings are ignored.

      Returns:
      A SearchClient with the options set from the builder.
      Throws:
      NullPointerException - If indexName or endpoint are null.
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • bufferedSender

      public <T> SearchClientBuilder.SearchIndexingBufferedSenderBuilder<T> bufferedSender(com.azure.core.util.serializer.TypeReference<T> documentType)
      Create a new instance of SearchClientBuilder.SearchIndexingBufferedSenderBuilder used to configure SearchIndexingBufferedSenders and SearchIndexingBufferedAsyncSenders.
      Type Parameters:
      T - The type of the document that the buffered sender will use.
      Parameters:
      documentType - The TypeReference representing the document type associated with the sender.
      Returns:
      A new instance of SearchClientBuilder.SearchIndexingBufferedSenderBuilder.

    • endpoint

      public SearchClientBuilder endpoint(String endpoint)
      Sets the service endpoint for the Azure AI Search instance.
      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<SearchClientBuilder>
      Parameters:
      endpoint - The URL of the Azure AI Search instance.
      Returns:
      The updated SearchClientBuilder object.0ed into a valid URL.

    • credential

      public SearchClientBuilder credential(com.azure.core.credential.AzureKeyCredential credential)
      Sets the AzureKeyCredential used to authenticate HTTP requests.
      Specified by:
      credential in interface com.azure.core.client.traits.AzureKeyCredentialTrait<SearchClientBuilder>
      Parameters:
      credential - The AzureKeyCredential used to authenticate HTTP requests.
      Returns:
      The updated SearchClientBuilder object.

    • credential

      public SearchClientBuilder credential(com.azure.core.credential.TokenCredential credential)
      Sets the TokenCredential 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 TokenCredential type.
      Specified by:
      credential in interface com.azure.core.client.traits.TokenCredentialTrait<SearchClientBuilder>
      Parameters:
      credential - TokenCredential used to authorize requests sent to the service.
      Returns:
      The updated SearchClientBuilder object.

    • audience

      public SearchClientBuilder audience(SearchAudience audience)
      Sets the Audience to use for authentication with Microsoft Entra ID.

      The audience is not considered when using a shared key.

      If audience is null the public cloud audience will be assumed.

      Parameters:
      audience - The Audience to use for authentication with Microsoft Entra ID.
      Returns:
      The updated SearchClientBuilder object.

    • indexName

      public SearchClientBuilder indexName(String indexName)
      Sets the name of the index.
      Parameters:
      indexName - Name of the index.
      Returns:
      The updated SearchClientBuilder object.
      Throws:
      IllegalArgumentException - If indexName is null or empty.

    • httpLogOptions

      public SearchClientBuilder 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<SearchClientBuilder>
      Parameters:
      logOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      The updated SearchClientBuilder 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 SearchClientBuilder 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<SearchClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      The updated SearchClientBuilder object.
      See Also:
      • HttpClientOptions

    • addPolicy

      public SearchClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
      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<SearchClientBuilder>
      Parameters:
      policy - A pipeline policy.
      Returns:
      The updated SearchClientBuilder object.
      Throws:
      NullPointerException - If policy is null.

    • serializer

      public SearchClientBuilder serializer(com.azure.core.util.serializer.JsonSerializer jsonSerializer)
      Custom JSON serializer that is used to handle model types that are not contained in the Azure Search Documents library.
      Parameters:
      jsonSerializer - The serializer to serialize user defined models.
      Returns:
      The updated SearchClientBuilder object.

    • httpClient

      public SearchClientBuilder httpClient(com.azure.core.http.HttpClient client)
      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<SearchClientBuilder>
      Parameters:
      client - The HttpClient to use for requests.
      Returns:
      The updated SearchClientBuilder object.

    • pipeline

      public SearchClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
      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.

      If pipeline is set, all other settings are ignored, aside from endpoint and index when building a SearchClient or SearchAsyncClient.

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

    • configuration

      public SearchClientBuilder 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.

      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<SearchClientBuilder>
      Parameters:
      configuration - The configuration store that will be used.
      Returns:
      The updated SearchClientBuilder object.

    • retryPolicy

      public SearchClientBuilder 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.

      Setting this is mutually exclusive with using retryOptions(RetryOptions).

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

    • retryOptions

      public SearchClientBuilder 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<SearchClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      The updated SearchClientBuilder object.

    • serviceVersion

      public SearchClientBuilder 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 the default is used, updating to a newer client library may implicitly use a newer version of the service.

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