Package com.azure.search.documents.indexes

Class SearchIndexerClientBuilder

java.lang.Object

com.azure.search.documents.indexes.SearchIndexerClientBuilder

All Implemented Interfaces:

AzureKeyCredentialTrait<SearchIndexerClientBuilder>, ConfigurationTrait<SearchIndexerClientBuilder>, EndpointTrait<SearchIndexerClientBuilder>, HttpTrait<SearchIndexerClientBuilder>, TokenCredentialTrait<SearchIndexerClientBuilder>

public class SearchIndexerClientBuilder
extends Object
implements AzureKeyCredentialTrait<SearchIndexerClientBuilder>, ConfigurationTrait<SearchIndexerClientBuilder>, EndpointTrait<SearchIndexerClientBuilder>, HttpTrait<SearchIndexerClientBuilder>, TokenCredentialTrait<SearchIndexerClientBuilder>

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

Constructor Summary

Constructors

Constructor	Description
SearchIndexerClientBuilder()	Creates a builder instance that is able to configure and construct SearchIndexerClients and SearchIndexerAsyncClients.

Method Summary

Modifier and Type	Method	Description
SearchIndexerClientBuilder	addPolicy(HttpPipelinePolicy policy)	Adds a pipeline policy to apply on each request sent.
SearchIndexerAsyncClient	buildAsyncClient()	Creates a SearchIndexerAsyncClient based on options set in the Builder.
SearchIndexerClient	buildClient()	Creates a SearchIndexerClient based on options set in the Builder.
SearchIndexerClientBuilder	clientOptions(ClientOptions clientOptions)	Allows for setting common properties such as application ID, headers, proxy configuration, etc.
SearchIndexerClientBuilder	configuration(Configuration configuration)	Sets the configuration store that is used during construction of the service client.
SearchIndexerClientBuilder	credential(AzureKeyCredential credential)	Sets the AzureKeyCredential used to authenticate HTTP requests.
SearchIndexerClientBuilder	credential(TokenCredential credential)	Sets the TokenCredential used to authorize requests sent to the service.
SearchIndexerClientBuilder	endpoint(String endpoint)	Sets the service endpoint for the Azure Cognitive Search instance.
static HttpLogOptions	getDefaultLogOptions()	Gets the default Azure Search headers and query parameters allow list.
SearchIndexerClientBuilder	httpClient(HttpClient client)	Sets the HttpClient to use for sending and receiving requests to and from the service.
SearchIndexerClientBuilder	httpLogOptions(HttpLogOptions logOptions)	Sets the logging configuration to use when sending and receiving requests to and from the service.
SearchIndexerClientBuilder	pipeline(HttpPipeline httpPipeline)	Sets the HttpPipeline to use for the service client.
SearchIndexerClientBuilder	retryOptions(RetryOptions retryOptions)	Sets the RetryOptions for all the requests made through the client.
SearchIndexerClientBuilder	retryPolicy(RetryPolicy retryPolicy)	Sets the HttpPipelinePolicy that will attempt to retry requests when needed.
SearchIndexerClientBuilder	serviceVersion(SearchServiceVersion serviceVersion)	Sets the SearchServiceVersion that is used when making API requests.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SearchIndexerClientBuilder

public SearchIndexerClientBuilder()

Creates a builder instance that is able to configure and construct SearchIndexerClients and SearchIndexerAsyncClients.

Method Details

buildClient

public SearchIndexerClient buildClient()

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

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

Returns:

A SearchIndexerClient with the options set from the builder.

Throws:

NullPointerException - If endpoint are null.

IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

buildAsyncClient

public SearchIndexerAsyncClient buildAsyncClient()

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

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

Returns:

A SearchIndexerAsyncClient with the options set from the builder.

Throws:

NullPointerException - If endpoint are null.

IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

endpoint

public SearchIndexerClientBuilder endpoint(String endpoint)

Sets the service endpoint for the Azure Cognitive Search instance.

Specified by:

endpoint in interface EndpointTrait<SearchIndexerClientBuilder>

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(AzureKeyCredential credential)

Sets the AzureKeyCredential used to authenticate HTTP requests.

Specified by:

credential in interface AzureKeyCredentialTrait<SearchIndexerClientBuilder>

Parameters:

credential - The AzureKeyCredential used to authenticate HTTP requests.

Returns:

The updated SearchIndexerClientBuilder object.

credential

public SearchIndexerClientBuilder 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 TokenCredentialTrait<SearchIndexerClientBuilder>

Parameters:

credential - TokenCredential used to authorize requests sent to the service.

Returns:

The updated SearchIndexerClientBuilder object.

httpLogOptions

public SearchIndexerClientBuilder httpLogOptions(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 HttpTrait<SearchIndexerClientBuilder>

Parameters:

logOptions - The logging configuration to use when sending and receiving requests to and from the service.

Returns:

The updated SearchIndexerClientBuilder object.

getDefaultLogOptions

public static HttpLogOptions getDefaultLogOptions()

Gets the default Azure Search headers and query parameters allow list.

Returns:

The default HttpLogOptions allow list.

clientOptions

public SearchIndexerClientBuilder clientOptions(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 HttpTrait<SearchIndexerClientBuilder>

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

The updated SearchIndexerClientBuilder object.

See Also:

• HttpClientOptions

addPolicy

public SearchIndexerClientBuilder addPolicy(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 HttpTrait<SearchIndexerClientBuilder>

Parameters:

policy - A pipeline policy.

Returns:

The updated SearchIndexerClientBuilder object.

Throws:

NullPointerException - If policy is null.

httpClient

public SearchIndexerClientBuilder httpClient(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 HttpTrait<SearchIndexerClientBuilder>

Parameters:

client - The HttpClient to use for requests.

Returns:

The updated SearchIndexerClientBuilder object.

pipeline

public SearchIndexerClientBuilder pipeline(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 when building a SearchIndexerClient or SearchIndexerAsyncClient.

Specified by:

pipeline in interface HttpTrait<SearchIndexerClientBuilder>

Parameters:

httpPipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

The updated SearchIndexerClientBuilder object.

configuration

public SearchIndexerClientBuilder configuration(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 ConfigurationTrait<SearchIndexerClientBuilder>

Parameters:

configuration - The configuration store that will be used.

Returns:

The updated SearchIndexerClientBuilder object.

retryPolicy

public SearchIndexerClientBuilder retryPolicy(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 SearchIndexerClientBuilder object.

retryOptions

public SearchIndexerClientBuilder retryOptions(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 HttpTrait<SearchIndexerClientBuilder>

Parameters:

retryOptions - The RetryOptions to use for all the requests made through the client.

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.