SearchIndexerClientBuilder 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.SearchIndexerClientBuilder

Implements

ConfigurationTrait<SearchIndexerClientBuilder> EndpointTrait<SearchIndexerClientBuilder> HttpTrait<SearchIndexerClientBuilder> KeyCredentialTrait<SearchIndexerClientBuilder> TokenCredentialTrait<SearchIndexerClientBuilder>

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

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

Constructor Summary

Constructor Description
SearchIndexerClientBuilder()

Create an instance of the SearchIndexerClientBuilder.

Method Summary

Modifier and Type Method and Description
SearchIndexerClientBuilder addPolicy(HttpPipelinePolicy customPolicy)

.
SearchIndexerClientBuilder audience(SearchAudience audience)

Sets the Audience to use for authentication with Microsoft Entra ID.
SearchIndexerAsyncClient buildAsyncClient()

Builds an instance of SearchIndexerAsyncClient class.
SearchIndexerClient buildClient()

Builds an instance of SearchIndexerClient class.
SearchIndexerClientBuilder clientOptions(ClientOptions clientOptions)

.
SearchIndexerClientBuilder configuration(Configuration configuration)

.
SearchIndexerClientBuilder credential(KeyCredential keyCredential)

.
SearchIndexerClientBuilder credential(TokenCredential tokenCredential)

.
SearchIndexerClientBuilder endpoint(String endpoint)

.
SearchIndexerClientBuilder httpClient(HttpClient httpClient)

.
SearchIndexerClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)

.
SearchIndexerClientBuilder pipeline(HttpPipeline pipeline)

.
SearchIndexerClientBuilder retryOptions(RetryOptions retryOptions)

.
SearchIndexerClientBuilder retryPolicy(RetryPolicy retryPolicy)

Sets The retry policy that will attempt to retry failed requests, if applicable.
SearchIndexerClientBuilder 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

SearchIndexerClientBuilder

public SearchIndexerClientBuilder()

Create an instance of the SearchIndexerClientBuilder.

Method Details

addPolicy

public SearchIndexerClientBuilder addPolicy(HttpPipelinePolicy customPolicy)

.

Parameters:

customPolicy

audience

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

buildAsyncClient

public SearchIndexerAsyncClient buildAsyncClient()

Builds an instance of SearchIndexerAsyncClient class.

Returns:

an instance of SearchIndexerAsyncClient.

buildClient

public SearchIndexerClient buildClient()

Builds an instance of SearchIndexerClient class.

Returns:

an instance of SearchIndexerClient.

clientOptions

public SearchIndexerClientBuilder clientOptions(ClientOptions clientOptions)

.

Parameters:

clientOptions

configuration

public SearchIndexerClientBuilder configuration(Configuration configuration)

.

Parameters:

configuration

credential

public SearchIndexerClientBuilder credential(KeyCredential keyCredential)

.

Parameters:

keyCredential

credential

public SearchIndexerClientBuilder credential(TokenCredential tokenCredential)

.

Parameters:

tokenCredential

endpoint

public SearchIndexerClientBuilder endpoint(String endpoint)

.

Parameters:

endpoint

httpClient

public SearchIndexerClientBuilder httpClient(HttpClient httpClient)

.

Parameters:

httpClient

httpLogOptions

public SearchIndexerClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)

.

Parameters:

httpLogOptions

pipeline

public SearchIndexerClientBuilder pipeline(HttpPipeline pipeline)

.

Parameters:

pipeline

retryOptions

public SearchIndexerClientBuilder retryOptions(RetryOptions retryOptions)

.

Parameters:

retryOptions

retryPolicy

public SearchIndexerClientBuilder retryPolicy(RetryPolicy retryPolicy)

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

Parameters:

retryPolicy - the retryPolicy value.

Returns:

the SearchIndexerClientBuilder.

serviceVersion

public SearchIndexerClientBuilder serviceVersion(SearchServiceVersion serviceVersion)

Sets Service version.

Parameters:

serviceVersion - the serviceVersion value.

Returns:

the SearchIndexerClientBuilder.

Applies to