public final class SearchIndexClientBuilder extends Object
SearchIndexClients
and SearchIndexAsyncClients
. Call buildClient
and buildAsyncClient
respectively to construct an instance of the desired
client.
The following information must be provided to successfully create a client.
Constructor and Description |
---|
SearchIndexClientBuilder()
Creates a builder instance that is able to configure and construct
SearchIndexClients
and SearchIndexAsyncClients . |
Modifier and Type | Method and Description |
---|---|
SearchIndexClientBuilder |
addPolicy(HttpPipelinePolicy policy)
Adds a pipeline policy to apply to each request sent.
|
SearchIndexAsyncClient |
buildAsyncClient()
Creates a
SearchIndexAsyncClient based on options set in the Builder. |
SearchIndexClient |
buildClient()
Creates a
SearchIndexClient based on options set in the Builder. |
SearchIndexClientBuilder |
configuration(Configuration configuration)
Sets the configuration store that is used during construction of the service client.
|
SearchIndexClientBuilder |
credential(AzureKeyCredential keyCredential)
Sets the
AzureKeyCredential used to authenticate HTTP requests. |
SearchIndexClientBuilder |
endpoint(String endpoint)
Sets the service endpoint for the Azure Search instance.
|
SearchIndexClientBuilder |
httpClient(HttpClient client)
Sets the HTTP client to use for sending requests and receiving responses.
|
SearchIndexClientBuilder |
httpLogOptions(HttpLogOptions logOptions)
Sets the logging configuration for HTTP requests and responses.
|
SearchIndexClientBuilder |
indexName(String indexName)
Sets the name of the index.
|
SearchIndexClientBuilder |
pipeline(HttpPipeline httpPipeline)
Sets the HTTP pipeline to use for the service client.
|
SearchIndexClientBuilder |
retryPolicy(RetryPolicy retryPolicy)
Sets the
HttpPipelinePolicy that will attempt to retry requests when needed. |
SearchIndexClientBuilder |
serviceVersion(SearchServiceVersion serviceVersion)
Sets the
SearchServiceVersion that is used when making API requests. |
public SearchIndexClientBuilder()
SearchIndexClients
and SearchIndexAsyncClients
.public SearchIndexClient buildClient()
SearchIndexClient
based on options set in the Builder. Every time buildClient()
is
called a new instance of SearchIndexClient
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.
NullPointerException
- If indexName
or endpoint
are null
.public SearchIndexAsyncClient buildAsyncClient()
SearchIndexAsyncClient
based on options set in the Builder. Every time
buildAsyncClient()
is called a new instance of SearchIndexAsyncClient
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.
NullPointerException
- If indexName
or endpoint
are null
.public SearchIndexClientBuilder endpoint(String endpoint)
endpoint
- The URL of the Azure Search instance.IllegalArgumentException
- If endpoint
is null or it cannot be parsed into a valid URL.public SearchIndexClientBuilder credential(AzureKeyCredential keyCredential)
AzureKeyCredential
used to authenticate HTTP requests.keyCredential
- The AzureKeyCredential
used to authenticate HTTP requests.NullPointerException
- If keyCredential
is null
.IllegalArgumentException
- If AzureKeyCredential.getKey()
is null
or empty.public SearchIndexClientBuilder indexName(String indexName)
indexName
- Name of the index.IllegalArgumentException
- If indexName
is null
or empty.public SearchIndexClientBuilder httpLogOptions(HttpLogOptions logOptions)
If logging configurations aren't provided HTTP requests and responses won't be logged.
logOptions
- The logging configuration for HTTP requests and responses.public SearchIndexClientBuilder addPolicy(HttpPipelinePolicy policy)
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.
policy
- The pipeline policies to added to the policy list.NullPointerException
- If policy
is null
.public SearchIndexClientBuilder httpClient(HttpClient client)
client
- The HTTP client that will handle sending requests and receiving responses.public SearchIndexClientBuilder pipeline(HttpPipeline httpPipeline)
If pipeline
is set, all other settings are ignored, aside from endpoint
and
index
when building a SearchIndexClient
or SearchIndexAsyncClient
.
httpPipeline
- The HTTP pipeline to use for sending service requests and receiving responses.public SearchIndexClientBuilder configuration(Configuration configuration)
The default configuration store is a clone of the global
configuration store
, use Configuration.NONE
to bypass using configuration settings during construction.
configuration
- The configuration store that will be used.public SearchIndexClientBuilder retryPolicy(RetryPolicy retryPolicy)
HttpPipelinePolicy
that will attempt to retry requests when needed.
A default retry policy will be supplied if one isn't provided.
retryPolicy
- The RetryPolicy
that will attempt to retry requests when needed.public SearchIndexClientBuilder serviceVersion(SearchServiceVersion serviceVersion)
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.
serviceVersion
- The version of the service to be used when making requests.Copyright © 2020 Microsoft Corporation. All rights reserved.