SearchIndexClientBuilder Class

Package:

com.azure.search.documents.indexes

Maven Artifact:

com.azure:azure-search-documents:12.0.0

• java.lang.Object
• • com.azure.search.documents.indexes.SearchIndexClientBuilder

Implements

ConfigurationTrait<SearchIndexClientBuilder> EndpointTrait<SearchIndexClientBuilder> HttpTrait<SearchIndexClientBuilder> KeyCredentialTrait<SearchIndexClientBuilder> TokenCredentialTrait<SearchIndexClientBuilder>

public final class SearchIndexClientBuilder
implements HttpTrait<SearchIndexClientBuilder>, ConfigurationTrait<SearchIndexClientBuilder>, TokenCredentialTrait<SearchIndexClientBuilder>, KeyCredentialTrait<SearchIndexClientBuilder>, EndpointTrait<SearchIndexClientBuilder>

A builder for creating a new instance of the SearchIndexClient type.

Constructor Summary

Constructor	Description
SearchIndexClientBuilder()	Create an instance of the SearchIndexClientBuilder.

Method Summary

Modifier and Type	Method and Description
SearchIndexClientBuilder	addPolicy(HttpPipelinePolicy customPolicy) .
SearchIndexClientBuilder	audience(SearchAudience audience) Sets the Audience to use for authentication with Microsoft Entra ID.
SearchIndexAsyncClient	buildAsyncClient() Builds an instance of SearchIndexAsyncClient class.
SearchIndexClient	buildClient() Builds an instance of SearchIndexClient class.
SearchIndexClientBuilder	clientOptions(ClientOptions clientOptions) .
SearchIndexClientBuilder	configuration(Configuration configuration) .
SearchIndexClientBuilder	credential(KeyCredential keyCredential) .
SearchIndexClientBuilder	credential(TokenCredential tokenCredential) .
SearchIndexClientBuilder	endpoint(String endpoint) .
SearchIndexClientBuilder	httpClient(HttpClient httpClient) .
SearchIndexClientBuilder	httpLogOptions(HttpLogOptions httpLogOptions) .
SearchIndexClientBuilder	pipeline(HttpPipeline pipeline) .
SearchIndexClientBuilder	retryOptions(RetryOptions retryOptions) .
SearchIndexClientBuilder	retryPolicy(RetryPolicy retryPolicy) Sets The retry policy that will attempt to retry failed requests, if applicable.
SearchIndexClientBuilder	serviceVersion(SearchServiceVersion serviceVersion) Sets Service version.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchIndexClientBuilder

public SearchIndexClientBuilder()

Create an instance of the SearchIndexClientBuilder.

Method Details

addPolicy

public SearchIndexClientBuilder addPolicy(HttpPipelinePolicy customPolicy)

.

Parameters:

customPolicy

audience

public SearchIndexClientBuilder audience(SearchAudience audience)

Sets the Audience to use for authentication with Microsoft Entra ID.

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 SearchIndexClientBuilder object.

buildAsyncClient

public SearchIndexAsyncClient buildAsyncClient()

Builds an instance of SearchIndexAsyncClient class.

Returns:

an instance of SearchIndexAsyncClient.

buildClient

public SearchIndexClient buildClient()

Builds an instance of SearchIndexClient class.

Returns:

an instance of SearchIndexClient.

clientOptions

public SearchIndexClientBuilder clientOptions(ClientOptions clientOptions)

.

Parameters:

clientOptions

configuration

public SearchIndexClientBuilder configuration(Configuration configuration)

.

Parameters:

configuration

credential

public SearchIndexClientBuilder credential(KeyCredential keyCredential)

.

Parameters:

keyCredential

credential

public SearchIndexClientBuilder credential(TokenCredential tokenCredential)

.

Parameters:

tokenCredential

endpoint

public SearchIndexClientBuilder endpoint(String endpoint)

.

Parameters:

endpoint

httpClient

public SearchIndexClientBuilder httpClient(HttpClient httpClient)

.

Parameters:

httpClient

httpLogOptions

public SearchIndexClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)

.

Parameters:

httpLogOptions

pipeline

public SearchIndexClientBuilder pipeline(HttpPipeline pipeline)

.

Parameters:

pipeline

retryOptions

public SearchIndexClientBuilder retryOptions(RetryOptions retryOptions)

.

Parameters:

retryOptions

retryPolicy

public SearchIndexClientBuilder retryPolicy(RetryPolicy retryPolicy)

Sets The retry policy that will attempt to retry failed requests, if applicable.

Parameters:

retryPolicy - the retryPolicy value.

Returns:

the SearchIndexClientBuilder.

serviceVersion

public SearchIndexClientBuilder serviceVersion(SearchServiceVersion serviceVersion)

Sets Service version.

Parameters:

serviceVersion - the serviceVersion value.

Returns:

the SearchIndexClientBuilder.