com.azure.search

Class SearchServiceClientBuilder

java.lang.Object

com.azure.search.SearchServiceClientBuilder

public final class SearchServiceClientBuilder
extends Object

This class provides a fluent builder API to help aid the configuration and instantiation of SearchServiceClients and SearchServiceAsyncClients. Call buildClient and buildAsyncClient respectively to construct an instance of the desired client.

The following information must be provided to successfully create a client.

• SearchServiceClientBuilder.endpoint(String)
• SearchServiceClientBuilder.credential(SearchApiKeyCredential) or SearchServiceClientBuilder.pipeline(HttpPipeline)

Constructor Summary

Constructors

Constructor and Description
SearchServiceClientBuilder() Creates a builder instance that is able to configure and construct SearchServiceClients and SearchServiceAsyncClients.

Method Summary

Modifier and Type	Method and Description
SearchServiceClientBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy) Adds a pipeline policy to apply to each request sent.
SearchServiceAsyncClient	buildAsyncClient() Creates a SearchServiceAsyncClient based on options set in the Builder.
SearchServiceClient	buildClient() Creates a SearchServiceClient based on options set in the Builder.
SearchServiceClientBuilder	configuration(com.azure.core.util.Configuration configuration) Sets the configuration store that is used during construction of the service client.
SearchServiceClientBuilder	credential(SearchApiKeyCredential searchApiKeyCredential) Sets the SearchApiKeyCredential used to authenticate HTTP requests.
SearchServiceClientBuilder	endpoint(String endpoint) Sets the service endpoint for the Azure Search instance.
SearchServiceClientBuilder	httpClient(com.azure.core.http.HttpClient client) Sets the HTTP client to use for sending requests and receiving responses.
SearchServiceClientBuilder	httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions) Sets the logging configuration for HTTP requests and responses.
SearchServiceClientBuilder	pipeline(com.azure.core.http.HttpPipeline httpPipeline) Sets the HTTP pipeline to use for the service client.
SearchServiceClientBuilder	retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy) Sets the HttpPipelinePolicy that will attempt to retry requests when needed.
SearchServiceClientBuilder	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 Detail

SearchServiceClientBuilder

public SearchServiceClientBuilder()

Creates a builder instance that is able to configure and construct SearchServiceClients and SearchServiceAsyncClients.

Method Detail

buildClient

public SearchServiceClient buildClient()

Creates a SearchServiceClient based on options set in the Builder. Every time buildClient() is called a new instance of SearchServiceClient 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 SearchServiceClient with the options set from the builder.

Throws:

NullPointerException - If endpoint are null.

buildAsyncClient

public SearchServiceAsyncClient buildAsyncClient()

Creates a SearchServiceAsyncClient based on options set in the Builder. Every time buildAsyncClient() is called a new instance of SearchServiceAsyncClient 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 SearchServiceAsyncClient with the options set from the builder.

Throws:

NullPointerException - If endpoint are null.

endpoint

public SearchServiceClientBuilder endpoint(String endpoint)

Sets the service endpoint for the Azure Search instance.

Parameters:

endpoint - The URL of the Azure Search instance.

Returns:

The updated SearchServiceClientBuilder object.

Throws:

IllegalArgumentException - If endpoint is null or it cannot be parsed into a valid URL.

credential

public SearchServiceClientBuilder credential(SearchApiKeyCredential searchApiKeyCredential)

Sets the SearchApiKeyCredential used to authenticate HTTP requests.

Parameters:

searchApiKeyCredential - The SearchApiKeyCredential used to authenticate HTTP requests.

Returns:

The updated SearchServiceClientBuilder object.

Throws:

NullPointerException - If searchApiKeyCredential is null.

IllegalArgumentException - If SearchApiKeyCredential.getApiKey() is null or empty.

httpLogOptions

public SearchServiceClientBuilder 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 SearchServiceClientBuilder object.

addPolicy

public SearchServiceClientBuilder 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 SearchServiceClientBuilder object.

Throws:

NullPointerException - If policy is null.

httpClient

public SearchServiceClientBuilder 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 SearchServiceClientBuilder object.

pipeline

public SearchServiceClientBuilder 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 SearchServiceClient or SearchServiceAsyncClient.

Parameters:

httpPipeline - The HTTP pipeline to use for sending service requests and receiving responses.

Returns:

The updated SearchServiceClientBuilder object.

configuration

public SearchServiceClientBuilder 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 SearchServiceClientBuilder object.

retryPolicy

public SearchServiceClientBuilder 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 SearchServiceClientBuilder object.

serviceVersion

public SearchServiceClientBuilder 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 SearchServiceClientBuilder object.