public class SearchIndexerClientBuilder extends Object
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.
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();
SearchIndexerClient
,
SearchIndexerAsyncClient
Constructor and Description |
---|
SearchIndexerClientBuilder()
Creates a builder instance that is able to configure and construct
SearchIndexerClients and SearchIndexerAsyncClients . |
Modifier and Type | Method and Description |
---|---|
SearchIndexerClientBuilder |
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
Adds a pipeline policy to apply to 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(com.azure.core.util.ClientOptions clientOptions)
Sets the client options such as application ID and custom headers to set on a request.
|
SearchIndexerClientBuilder |
configuration(com.azure.core.util.Configuration configuration)
Sets the configuration store that is used during construction of the service client.
|
SearchIndexerClientBuilder |
credential(com.azure.core.credential.AzureKeyCredential credential)
Sets the
AzureKeyCredential used to authenticate HTTP requests. |
SearchIndexerClientBuilder |
credential(com.azure.core.credential.TokenCredential credential)
Sets the
TokenCredential used to authenticate HTTP requests. |
SearchIndexerClientBuilder |
endpoint(String endpoint)
Sets the service endpoint for the Azure Cognitive Search instance.
|
static com.azure.core.http.policy.HttpLogOptions |
getDefaultLogOptions()
Gets the default Azure Search headers and query parameters allow list.
|
SearchIndexerClientBuilder |
httpClient(com.azure.core.http.HttpClient client)
Sets the HTTP client to use for sending requests and receiving responses.
|
SearchIndexerClientBuilder |
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets the logging configuration for HTTP requests and responses.
|
SearchIndexerClientBuilder |
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets the HTTP pipeline to use for the service client.
|
SearchIndexerClientBuilder |
retryPolicy(com.azure.core.http.policy.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. |
public SearchIndexerClientBuilder()
SearchIndexerClients
and SearchIndexerAsyncClients
.public SearchIndexerClient buildClient()
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.
NullPointerException
- If endpoint
are null
.public SearchIndexerAsyncClient buildAsyncClient()
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.
NullPointerException
- If endpoint
are null
.public SearchIndexerClientBuilder endpoint(String endpoint)
endpoint
- The URL of the Azure Cognitive Search instance.IllegalArgumentException
- If endpoint
is null or it cannot be parsed into a valid URL.public SearchIndexerClientBuilder credential(com.azure.core.credential.AzureKeyCredential credential)
AzureKeyCredential
used to authenticate HTTP requests.credential
- The AzureKeyCredential
used to authenticate HTTP requests.public SearchIndexerClientBuilder credential(com.azure.core.credential.TokenCredential credential)
TokenCredential
used to authenticate HTTP requests.credential
- The TokenCredential
used to authenticate HTTP requests.public SearchIndexerClientBuilder httpLogOptions(com.azure.core.http.policy.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 static com.azure.core.http.policy.HttpLogOptions getDefaultLogOptions()
HttpLogOptions
allow list.public SearchIndexerClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
clientOptions
- The client options.public SearchIndexerClientBuilder addPolicy(com.azure.core.http.policy.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 SearchIndexerClientBuilder httpClient(com.azure.core.http.HttpClient client)
client
- The HTTP client that will handle sending requests and receiving responses.public SearchIndexerClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
If pipeline
is set, all other settings are ignored, aside from endpoint
when
building a SearchIndexerClient
or SearchIndexerAsyncClient
.
httpPipeline
- The HTTP pipeline to use for sending service requests and receiving responses.public SearchIndexerClientBuilder configuration(com.azure.core.util.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 SearchIndexerClientBuilder retryPolicy(com.azure.core.http.policy.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 SearchIndexerClientBuilder 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 © 2021 Microsoft Corporation. All rights reserved.